Newer
Older
swagger: "2.0"
info:
version: "1.1.0"
title: SOL005 - VNF Package Management Interface
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
schemes:
- https
consumes:
###############################################################################
# VNF Packages #
###############################################################################
rameshnaraya
committed
'/vnf_packages':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
get:
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:
rameshnaraya
committed
required: false
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string. The
OSS/BSS may supply filtering parameters.
rameshnaraya
committed
All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
be supported in attribute-based filtering parameters.
- name: all_fields
in: query
rameshnaraya
committed
required: false
description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
shall support this parameter.
rameshnaraya
committed
required: false
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: exclude_fields
in: query
rameshnaraya
committed
required: false
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: exclude_default
in: query
rameshnaraya
committed
required: false
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
type: string
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
WWW-Authenticate:
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:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
post:
summary: Create a new individual VNF package resource.
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
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
description: >
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
rameshnaraya
committed
responses:
201:
description: >
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:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya
committed
headers:
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
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
###############################################################################
# Individual VNF Package #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
rameshnaraya
committed
get:
summary: Read information about an individual VNF package.
description: >
The GET method reads the information of a VNF package.
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
rameshnaraya
committed
responses:
200:
Information of the VNF package.
rameshnaraya
committed
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
WWW-Authenticate:
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.
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
delete:
description: >
The DELETE method deletes an individual VNF Package resource.
rameshnaraya
committed
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
rameshnaraya
committed
responses:
204:
description: >
The VNF package was deleted successfully.
The response body shall be empty.
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
patch:
summary: Update information about an individual VNF package.
description: >
rameshnaraya
committed
"The PATCH method updates the information of a VNF package."
rameshnaraya
committed
"This method shall follow the provisions specified in the
Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters,
request and response data structures, and response codes."
parameters:
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
description: >
Parameters for VNF package information modifications.
- 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
responses:
rameshnaraya
committed
200:
rameshnaraya
committed
The response body shall contain attribute
modifications for an "Individual VNF
package" resource
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
schema:
properties:
VnfPkgInfoModifications:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# VNFD in an individual VNF package #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/vnfd':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4
parameters:
- name: vnfPkgId
description: >
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
rameshnaraya
committed
in: path
type: string
required: true
rameshnaraya
committed
get:
description: >
The GET method reads the content of the VNFD within a VNF package.
The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
rameshnaraya
committed
form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file,
either that file or a ZIP file embedding that file shall be returned.
The selection of the format is controlled by the "Accept" HTTP header passed in the GET request.
• If the "Accept" header contains only "text/plain" and the VNFD is implemented as a single file, the file shall
be returned; otherwise, an error message shall be returned.
• If the "Accept" header contains only "application/zip", the single file or the multiple files that make up the
VNFD shall be returned embedded in a ZIP file.
• If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the
format to return for a single-file VNFD; for a multi-file VNFD, a ZIP file shall be returned.
The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 004 [5] where only the YAML files
representing the VNFD, and information necessary to navigate the ZIP file and to identify the file that is the entry point
for parsing the VNFD (such as TOSCA-meta or manifest files or naming conventions) are included.
This method shall follow the provisions specified in the Tables 9.4.4.3.2-1 and 9.4.4.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
rameshnaraya
committed
responses:
200:
description: >
rameshnaraya
committed
On success, the content of the VNFD is returned.
The payload body shall contain a copy of the file
representing the VNFD or a ZIP file that contains the
file or multiple files representing the VNFD, as
specified above.
The "Content-Type" HTTP header shall be set
according to the format of the returned file, i.e. to
"text/plain" for a YAML file or to "application/zip" for a ZIP file.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# VNF Package Content #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/package_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
parameters:
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
rameshnaraya
committed
get:
description: >
The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
This method shall follow the provisions specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Range
in: header
required: false
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from the VNF package file. This can be used to
continue an aborted transmission.
If the NFVO does not support range requests, it should return the
whole file with a 200 OK response instead.
rameshnaraya
committed
responses:
200:
description: >
rameshnaraya
committed
On success, a copy of the VNF package file is returned.
The response body shall include a copy of the VNF package file.
The "Content-Type" HTTP header shall be set
according to the type of the file, i.e. to "application/zip"
for a VNF Package as defined in ETSI
GS NFV-SOL 004 [5].
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
206:
$ref: "../responses/SOL005_resp.yaml#/responses/206"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
put:
summary: Upload a VNF package by providing the content of the VNF package.
description: >
The PUT method uploads the content of a VNF package.
This method shall follow the provisions specified in the
Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
consumes:
- multipart/form-data
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- application/zip
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- in: formData
name: file
required: false
type: file
description: >
The payload body contains a ZIP file that represents the VNF package.
The "Content-Type" HTTP header shall be set according to the
type of the file, i.e. to "application/zip" for a VNF Package as
defined in ETSI GS NFV-SOL 004 [5].
rameshnaraya
committed
responses:
202:
description: >
The VNF package was accepted for uploading, but the
processing has not been completed. It is expected to
take some time for processing.
The response body shall be empty.
409:
description: >
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
###############################################################################
# Upload VNF package from URI task #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6
post:
summary: Upload a VNF package by providing the address information of the VNF package.
description: >
The POST method provides the information for the NFVO to get the content of a VNF package.
This method shall follow the provisions specified in the
Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters,
request and response data structures, and response codes.
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
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
description: >
The payload body contains the address information based on
which the NFVO can obtain the content of the VNF package.
rameshnaraya
committed
responses:
202:
rameshnaraya
committed
successfully, but the on-boarding has not been
completed. It is expected to take some time for processing.
rameshnaraya
committed
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual VNF package artifact #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7
parameters:
- name: vnfPkgId
description: >
Identifier of the on-boarded VNF package.
The identifier is allocated by the NFVO.
This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
VnfPackageChangeNotification.
in: path
type: string
required: true
- name: artifactPath
description: >
Path of the artifact within the VNF package.
This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts" entry in
the body of the response to a GET request querying the "Individual VNF package" or the "VNF packages"
resource.
in: path
type: string
required: true
get:
summary: Fetch individual VNF package artifact.
description: >
The GET method fetches the content of an artifact within a VNF package.
This method shall follow the provisions specified in the
Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
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: Range
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from the VNF package file. This can be used to
continue an aborted transmission.
If the NFVO does not support range requests, it should return the
whole file with a 200 OK response instead.
in: header
type: string
responses:
200:
description: >
200 OK
On success, the content of the artifact is returned.
The payload body shall contain a copy of the artifact file from
the VNF package, as defined by ETSI GS NFV-SOL 004.
The "Content-Type" HTTP header shall be set according to the
content type of the artifact file. If the content type cannot be
determined, the header shall be set to the value
"application/octet-stream".
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
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
206:
description: >
Partial Content.
On success, if the NFVO supports range requests, a single
consecutive byte range from the content of the VNF package file is
returned.
The response body shall contain the requested part of the VNF
package file.
The "Content-Range" HTTP header shall be provided according to
IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for
the "200 OK" response.
headers:
Content-Range:
type: string
maximum: 1
minimum: 1
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
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
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"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Subscriptions #
###############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8
rameshnaraya
committed
post:
summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
description: >
rameshnaraya
committed
The POST method creates a new subscription.
This method shall follow the provisions specified in the Tables 9.4.8.3.1-1 and 9.4.8.3.1-2 for URI query parameters,
request and response data structures, and response codes.
Creation of two subscription resources with the same callbackURI and the same filter can result in performance
degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
the existing subscription resource with the same filter and callbackUri).
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
required: true
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
description: >
Representation of the created subscription resource.
The HTTP response shall include a "Location" HTTP header that
points to the created subscription resource.
rameshnaraya
committed
responses:
201:
rameshnaraya
committed
Representation of the created subscription resource.
The HTTP response shall include a "Location"
HTTP header that points to the created subscription resource.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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:
type: array
items:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
rameshnaraya
committed
303:
$ref: "../responses/SOL005_resp.yaml#/responses/303"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
summary: Query multiple subscriptions.
description: >
The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used
e.g. for resynchronization after error situations.
This method shall follow the provisions specified in the
Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: filter
in: query
rameshnaraya
committed
required: false
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query
string. The OSS/BSS may supply filtering parameters.
rameshnaraya
committed
All attribute names that appear in the PkgmSubscription and in data types
referenced from it shall be supported in attribute-based filtering parameters
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
type: string
responses:
200:
Active subscriptions of the functional block that invokes the method.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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:
type: array
items:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9
rameshnaraya
committed
parameters:
- name: subscriptionId
description: >
Identifier of this subscription.
This identifier can be retrieved from the resource referenced by
the "Location" HTTP header in the response to a POST request
creating a new subscription resource. It can also be retrieved from
the "id" attribute in the payload body of that response.
in: path
type: string
required: true
get:
summary: Read an individual subscription resource.
rameshnaraya
committed
description: >
Query Subscription Information
The GET method reads an individual subscription.
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
responses:
200:
rameshnaraya
committed
Representation of the subscription resource.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
delete:
description: >
rameshnaraya
committed
The DELETE method terminates an individual subscription.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
responses:
204:
description: >
rameshnaraya
committed
The subscription resource was deleted successfully.
headers:
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"