Newer
Older
swagger: "2.0"
info:
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
license:
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact:
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/vnfpkgm/v1"
schemes:
- https
consumes:
- "application/json"
produces:
rameshnaraya
committed
###############################################################################
# VNF Packages #
###############################################################################
'/vnf_packages':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
get:
rameshnaraya
committed
description: >
The GET method queries the information of the VNF packages matching the filter.
This method shall follow the provisions specified in the
Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: "filter"
in: "query"
required: false
type: "string"
description: >
Attribute-based filtering parameters according to clause 4.3.2.
rameshnaraya
committed
The NFVO shall support receiving filtering parameters as part of the URI query string. The
OSS/BSS may supply filtering parameters.
All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
be supported in attribute-based filtering parameters.
rameshnaraya
committed
- name: "all_fields"
in: "query"
required: false
type: "string"
description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
shall support this parameter.
rameshnaraya
committed
- name: "fields"
in: "query"
required: false
type: "string"
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
rameshnaraya
committed
- name: "exclude_fields"
in: "query"
required: false
type: "string"
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
rameshnaraya
committed
- name: "exclude_default"
in: "query"
required: false
type: "string"
description: >
Indicates to exclude the following complex attributes from the response. See clause 4.3.3
for details.
The NFVO shall support this parameter.
rameshnaraya
committed
The following attributes shall be excluded from the VnfPkgInfo structure in the response
body if this parameter is provided, or none of the parameters "all_fields," "fields",
"exclude_fields", "exclude_default" are provided:
- softwareImages
- additionalArtifacts
- userDefinedData
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
rameshnaraya
committed
responses:
200:
Information of the selected VNF packages.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
rameshnaraya
committed
schema:
rameshnaraya
committed
items:
properties:
VnfPkgInfo:
$ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
post:
summary: Create a new individual VNF package resource.
rameshnaraya
committed
description: >
The POST method creates a new individual VNF package resource.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "CreateVnfPkgInfoRequest"
properties:
CreateVnfPkgInfoRequest:
$ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
description: >
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
rameshnaraya
committed
responses:
201:
description: >
rameshnaraya
committed
An individual VNF package resource has been created successfully.
rameshnaraya
committed
The response body shall contain a representation of
the new individual VNF package resource, as defined
in clause 9.5.2.4.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the individual
rameshnaraya
committed
schema:
Loading
Loading full blame...