Newer
Older
openapi: 3.0.2
title: SOL005 - VNF Package Management Interface
description: |
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
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
description: ETSI GS NFV-SOL 005 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
servers:
- url: http://127.0.0.1/vnfpkgm/v2
- url: https://127.0.0.1/vnfpkgm/v2
/api_versions:
$ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
Samir Medjiah
committed
/vnf_packages:
Samir Medjiah
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya
committed
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:
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
"200":
$ref: '#/components/responses/VnfPackages.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
post:
summary: Create a new individual VNF package resource.
description: |
The POST method creates a new individual VNF package resource.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
requestBody:
$ref: '#/components/requestBodies/VnfPackageCreationRequest'
responses:
"201":
$ref: '#/components/responses/VnfPackages.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
rameshnaraya
committed
/vnf_packages/{vnfPkgId}:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
get:
summary: Read information about an individual VNF package.
description: |
The GET method reads the information of a VNF package.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
"200":
$ref: '#/components/responses/IndividualVnfPackage.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
delete:
summary: Delete an individual VNF package.
description: |
The DELETE method deletes an individual VNF Package resource.
responses:
"204":
$ref: '#/components/responses/IndividualVnfPackage.Delete'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
patch:
summary: Update information about an individual VNF package.
description: |
The PATCH method updates the information of a VNF package.
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:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageModificationRequest'
responses:
"200":
$ref: '#/components/responses/IndividualVnfPackage.Patch'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_packages/{vnfPkgId}/vnfd:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
get:
summary: Read VNFD of an on-boarded VNF package.
description: |
The GET method reads the content of the VNFD within a VNF package.
The default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 where only the 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 and (if requested) further security information are included. This means that
the structure of the ZIP archive shall correspond to the directory structure used in the VNF package and that
the archive shall contain the following files from the package: • TOSCA.meta (if available in the package).
The main TOSCA definitions YAML file (either as referenced from TOSCA.meta or available as a file with the extension
".yml" or ".yaml" from the root of the archive). Every component of the VNFD referenced (recursively) from the main
TOSCA definitions YAML file. • The related security information, if the "include_signatures" URI parameter is provided,
as follows:
- the manifest file;
- the singleton certificate file in the root of the VNF package (if available in the package);
- the signing certificates of the individual files included in the ZIP archive (if available in the package);
- the signatures of the individual files (if available in the package).
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
rameshnaraya
committed
responses:
"200":
$ref: '#/components/responses/IndividualVnfPackageVnfd.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_packages/{vnfPkgId}/ext_artifacts_access:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya
committed
get:
summary: Get the content of external VNF package artifacts.
description: |
The GET method reads the access configuration information that is used by the NFVO to get the content of external
VNF package artifacts. This method shall follow the provisions specified in the Tables 9.4.4a.3.2-1 and 9.4.4a.3.2-2
for URI query parameters, request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
"200":
$ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
put:
summary: Download the content of external VNF package artifacts.
description: |
The PUT method provides the access configuration information for the NFVO to download the content of external
VNF package artifacts. As precondition for invoking this method, the individual VNF package resource shall have
been created, and the value of "onboardingState" attribute shall equal to "CREATED" or "ERROR". The resource
representation in the payload body of the PUT request shall replace the current state of the resource. This method
shall follow the provisions specified in the Tables 9.4.4a.3.3-1 and 9.4.4a.3.3-2 for URI query parameters, request
and response data structures, and response codes.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageExtArtifactsRequest'
"200":
$ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.200'
"202":
$ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.202'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_packages/{vnfPkgId}/manifest:
rameshnaraya
committed
parameters:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya
committed
get:
description: |
The GET method reads the content of the manifest within a VNF package.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
rameshnaraya
committed
responses:
"200":
$ref: '#/components/responses/IndividualVnfPackageManifest.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
rameshnaraya
committed
/vnf_packages/{vnfPkgId}/package_content:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya
committed
get:
description: |
The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the
NFVO. The content of the package is provided as onboarded, i.e. depending on the security option used, the CSAR
or the CSAR wrapped in a ZIP archive together with an external signature is returned, as defined in clause 5.1
of ETSI GS NFV-SOL 004 [5]. NOTE: Information about the applicable security option can be obtained by evaluating
the "packageSecurityOption" attribute in the "VnfPkgInfo" structure. 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:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
rameshnaraya
committed
responses:
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
"200":
$ref: '#/components/responses/IndividualVnfPackageContent.Get'
"206":
$ref: ../responses/SOL005_resp.yaml#/components/responses/206
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
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. Upon start of the upload of the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo"
structure to "UPLOADING". Upon successful upload of the package, if the package references external artifacts, the
NFVO shall obtain the external artifacts. Subsequently, upon success, the NFVO shall set that attribute to "PROCESSING"
and shall process the package, which shall include checking package consistency. Upon successful processing, the NFVO
shall set the "onboardingState" attribute to "ONBOARDED". If an error occurs during uploading the package, downloading
the external artifacts or processing the package, the NFVO shall set the "onboardingState" attribute to "ERROR" and
shall populate the "onboardingFailureDetails" attribute in "VnfPkgInfo".
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageContentRequest'
rameshnaraya
committed
responses:
"202":
$ref: '#/components/responses/IndividualVnfPackageContent.Put'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
rameshnaraya
committed
/vnf_packages/{vnfPkgId}/artifacts:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
get:
summary: Fetch set of VNF package artifacts.
description: |
The GET method shall return an archive that contains a set of artifacts according to the provisions for
inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package.
The criteria for exclusion/inclusion of an artifact in the archive are defined as follows:
* Artifacts that are software images shall be excluded from the archive.
* Artifacts that are external to the VNF package shall be excluded from the archive.
* All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive,
unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts
shall be excluded.
* All additional artifacts included in the VNF package that are non-MANO artifacts shall be included in the archive,
unless:
- the URI query parameter "exclude_all_non_mano_artifacts" has been provided, in which case such artifacts shall
be excluded;
- the URI query parameter "select_non_mano_artifact_sets" has been provided and is supported by the NFVO,
in which case only those non-MANO artifacts shall be included whose non-MANO artifact set identifier matches
one of the values of the query parameter. Package metadata such as manifest file or VNFD shall not be included
in the archive. This method shall follow the provisions specified in the Tables 9.4.5a.3.2-1 and 9.4.5a.3.2-2
for URI query parameters, request and response data structures, and response codes.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_all_mano_artifacts
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_all_non_mano_artifacts
- $ref: ../components/SOL005_params.yaml#/components/parameters/select_non_mano_artifact_sets
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
"200":
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get'
"206":
$ref: ../responses/SOL005_resp.yaml#/components/responses/206
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_packages/{vnfPkgId}/package_content/upload_from_uri:
parameters:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya
committed
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. Upon start of obtaining the package, the NFVO shall set the
"onboardingState" attribute in the "VnfPkgInfo" structure to "UPLOADING". Upon successfully obtaining the
package, if the package references external artifacts, the NFVO shall obtain the external artifacts. Subsequently,
upon success, the NFVO shall set that attribute to "PROCESSING" and shall process the package, which shall include
checking package consistency. Upon successful processing, the NFVO shall set the "onboardingState" attribute to
"ONBOARDED". If an error occurs during obtaining the package, downloading the external artifacts or processing
the package, the NFVO shall set the "onboardingState" attribute to "ERROR" and shall populate the "onboardingFailureDetails"
attribute in "VnfPkgInfo".
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageUploadFromUriRequest'
rameshnaraya
committed
responses:
"202":
$ref: '#/components/responses/IndividualVnfPackageUploadFromUri.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
- $ref: '#/components/parameters/VnfPkgId'
- $ref: '#/components/parameters/ArtifactPath'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
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.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signature
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
"200":
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get'
"206":
$ref: ../responses/SOL005_resp.yaml#/components/responses/206
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"409":
$ref: ../responses/SOL005_resp.yaml#/components/responses/409
"416":
$ref: ../responses/SOL005_resp.yaml#/components/responses/416
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/subscriptions:
Samir Medjiah
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
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.8.3.2-1 and 9.4.8.3.2-2 for URI query parameters, request and response data
structures, and response codes.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
"200":
$ref: '#/components/responses/VnfPkgSubscriptions.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
post:
summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
description: |
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.
As the result of successfully executing this method, a new "Individual subscription" resource shall exist as
defined in clause 9.4.9. This method shall not trigger any notification. 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).
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPkgSubscriptionRequest'
responses:
"201":
$ref: '#/components/responses/VnfPkgSubscriptions.Post'
"303":
$ref: ../responses/SOL005_resp.yaml#/components/responses/303
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"422":
$ref: ../responses/SOL005_resp.yaml#/components/responses/422
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
/subscriptions/{subscriptionId}:
rameshnaraya
committed
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
rameshnaraya
committed
get:
summary: Read an individual subscription resource.
description: |
Query Subscription Information The GET method reads an individual subscription.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
"200":
$ref: '#/components/responses/VnfPkgSubscription.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
rameshnaraya
committed
delete:
description: |
The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the
Tables 9.4.9.3.5-1 and 9.4.9.3.5-2 for URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual subscription" resource shall not exist any longer.
This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer
for a certain time period after the deletion.
rameshnaraya
committed
responses:
723
724
725
726
727
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
"204":
$ref: '#/components/responses/VnfPkgSubscription.Delete'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"404":
$ref: ../responses/SOL005_resp.yaml#/components/responses/404
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
"504":
$ref: ../responses/SOL005_resp.yaml#/components/responses/504
components:
parameters:
VnfPkgId:
name: vnfPkgId
in: path
description: |
Identifier of the VNF package. The identifier is allocated by the NFVO.
required: true
style: simple
explode: false
schema:
type: string
ArtifactPath:
name: artifactPath
in: path
description: |
For an artifact contained as a file in the VNF package, this variable shall contain a sequence of one or path
segments representing the path of the artifact within the VNF package, relative to the root of the package.
See note 3. EXAMPLE: foo/bar/m%40ster.sh For an external artifact represented as a URI in the VNF package manifest,
this variable shall contain a sequence of one or more path segments as synthesized by the NFVO (see clause 9.5.3.3),
representing this artifact. See note 2 and note 3
required: true
style: simple
explode: false
schema:
type: string
rameshnaraya
committed
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
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
826
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
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
SubscriptionId:
name: subscriptionId
in: path
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.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
VnfPackageCreationRequest:
description: |
IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest
required: true
VnfPackageModificationRequest:
description: |
Parameters for VNF package information modifications.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
required: true
VnfPackageExtArtifactsRequest:
description: |
The payload body contains the access configuration information based on which the NFVO can obtain the
external VNF package artifact files.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
required: true
VnfPackageContentRequest:
content:
application/binary:
schema:
properties:
file:
type: string
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.
format: binary
required: true
VnfPackageUploadFromUriRequest:
description: |
The payload body contains the address information based on which the NFVO can obtain the content of the VNF package.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest
required: true
VnfPkgSubscriptionRequest:
description: |
Details of the subscription to be created.
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest
required: true
responses:
VnfPackages.Get:
description: |
200 OK
Shall be returned when information about zero or more VNF packages has been queried successfully.
The response body shall contain in an array the VNF package info representations that match the attribute
filter, i.e. zero or more VNF package info representations as defined in clause 9.5.2.5.
If the "filter" URI parameter or one of the "all_fields", "fields", "exclude_fields" or "exclude_default"
URI parameters was supplied in the request and is supported, the data in the response body shall have been
transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV SOL 013, respectively.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this
resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3
of ETSI GS NFV SOL 013.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo
VnfPackages.Post:
description: |
201 Created
Shall be returned when an "Individual VNF package" resource has been created successfully. The response body
shall contain a representation of the new individual VNF package resource, as defined in clause 9.5.2.5.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the individual
VNF package resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo
IndividualVnfPackage.Get:
description: |
200 OK
Shall be returned when information of the VNF package has been read successfully. The response body shall
contain the VNF package info representation defined in clause 9.5.2.5.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
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.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo
IndividualVnfPackage.Delete:
description: |
204 No Content
The VNF package has been deleted successfully. The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackage.Patch:
description: |
200 OK
Shall be returned when the operation has been completed successfully. The response body shall contain
attribute modifications for an "Individual VNF package" resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
IndividualVnfPackageVnfd.Get:
description: |
200 OK
Shall be returned when the content of the VNFD has been read successfully. 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:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackageExtArtifacts.Get:
description: |
200 OK
Shall be returned when the access configuration information has been read successfully.
If no information has been provided previously, an empty array shall be returned.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
IndividualVnfPackageExtArtifacts.Put.200:
description: |
200 OK
Shall be returned when the attribute "onboardingState" = "CREATED" or when the attribute "onboardingState" = "ERROR"
and the VNF package has not been uploaded successfully previously, to indicate that the access configuration information
has been stored successfully by the NFVO. The response body shall contain a representation of the state of the resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
IndividualVnfPackageExtArtifacts.Put.202:
description: |
202 ACCEPTED
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created NS instance
style: simple
explode: false
schema:
type: string
format: url
content: {}
IndividualVnfPackageManifest.Get:
description: |
200 OK
Shall be returned when the content of the manifest has been read successfully. If the "include_signatures" URI
query parameter was absent in the request, or if the manifest file has all security-related information embedded
(i.e. there is no separate certificate file), the payload body shall contain a copy of the manifest file of the
VNF package, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI
query parameter was present in the related request and the manifest file does not have all the security-related
information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to
"application/zip and the payload body shall contain a ZIP archive which includes: - a copy of the manifest file
of the VNF package - a copy of the related individual certificate file.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackageContent.Get:
description: |
200 OK
Shall be returned when the whole content of the VNF package file has been read successfully. 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.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackageContent.Put:
description: |
202 ACCEPTED
Shall be returned when the VNF package has been 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. See note.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackageArtifacts.Get:
description: |
200 OK
Shall be returned when the whole content of the archive containing the artifact files has been read successfully.
The payload body shall be a ZIP archive containing the requested set of artifacts selected according to the provisions
specified above in this clause, and, if the flag "include_signatures" was provided in the related request, the
applicable signature files and, if available, the separate certificate files from the VNF package.
The "Content-Type" HTTP header shall be set to "application/zip".
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackageUploadFromUri.Post:
description: |
202 Accepted
The information about the VNF package has been received successfully, but the on-boarding has not been completed.
It is expected to take some time for processing. The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content: {}
IndividualVnfPackageArtifact.Get:
description: |
200 OK Shall be returned when the whole content of the artifact file has been read successfully. If the
"include_signatures" request URI parameter was not provided in the related request, the payload body shall
contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5], and the
"Content-Type" HTTP header shall be set according to the content type of the artifact file. If the artifact
is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193 [17]). If the content
type cannot be determined, the header shall be set to the value "application/octet-stream".
If the "include_signatures" request URI parameter was provided in the related request, the "ContentType"
HTTP header shall be set to "application/zip" and the payload body shall contain a ZIP archive which includes:
- a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5];
- the related security information (individual signature file and optional related individual certificate file).
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content: {}
VnfPkgSubscriptions.Get:
description: |
200 OK
Shall be returned when the list of subscriptions has been queried successfully. The response body shall contain
in an array the representations of all active subscriptions of the functional block that invokes the method,
i.e. zero or more representations of VNF package management subscriptions, as defined in clause 9.5.2.7.
If the "filter" URI parameter was supplied in the request, the data in the response body shall have been
transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the NFVO supports
alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for this resource, inclusion of the
Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV SOL 013.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription
VnfPkgSubscriptions.Post:
description: |
201 Created
Shall be returned when the subscription has been created successfully. The response body shall contain a
representation of the created "Individual subscription" resource. The HTTP response shall include a "Location"
HTTP header that points to the created subscription resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription
VnfPkgSubscription.Get:
description: |
200 OK
Shall be returned when information about an individual subscription has been read successfully.
The response body shall contain a representation of the "Individual subscription" resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription
VnfPkgSubscription.Delete:
description: |
No Content
Shall be returned when information about an individual subscription has been read successfully. The response
body shall contain a representation of the "Individual subscription" resource.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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.
style: simple
explode: false
schema:
type: string
content: {}