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. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
description: ETSI GS NFV-SOL 005 V3.6.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.06.01_60/gs_nfv-sol005v030601p.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. See clause 9.4.2.3.2.
rameshnaraya
committed
parameters:
- in: query
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the VnfPkgInfo and in data types referenced from
it shall be supported by the NFVO in the filter expression.
schema:
type: string
- $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
- in: query
name: exclude_default
description: >
Indicates to exclude the following complex attributes from the response. See clause 5.3 of
ETSI GS NFV-SOL 013 for details.
The NFVO shall support this parameter. 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
- checksum
- onboardingFailureDetails
schema:
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
$ref: '#/components/responses/VnfPackages.Get.200'
"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
post:
description: |
The POST method creates a new individual VNF package resource. See clause 9.4.2.3.1.
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.201'
"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
description: |
The GET method reads the information of an individual VNF package. See clause 9.4.3.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualVnfPackage.Get.200'
"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
description: |
The DELETE method deletes an individual VNF Package resource. See clause 9.4.3.3.5.
$ref: '#/components/responses/IndividualVnfPackage.Delete.204'
"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: '#/components/responses/IndividualVnfPackage.Delete.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
patch:
description: |
The PATCH method updates the information of a VNF package. See clause 9.4.3.3.4.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageModificationRequest'
responses:
"200":
$ref: '#/components/responses/IndividualVnfPackage.Patch.200'
"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: '#/components/responses/IndividualVnfPackage.Patch.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
description: |
The GET method reads the content of the VNFD within a VNF package. See clause 9.4.4.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- in: query
name: include_signatures
description: >
If this parameter is provided, the NFVO shall include in the ZIP archive the security
information as specified above.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
schema:
type: string
rameshnaraya
committed
responses:
$ref: '#/components/responses/IndividualVnfPackageVnfd.Get.200'
"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: '#/components/responses/IndividualVnfPackageVnfd.Get.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:
description: |
The GET method reads the access configuration information that is used by the NFVO to get the content of external
VNF package artifacts. See clause 9.4.4a.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
$ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Get.200'
"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
description: |
The PUT method provides the access configuration information for the NFVO to download the content of external
VNF package artifacts. See clause 9.4.4a.3.4.
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: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.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. See clause 9.4.4b.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- in: query
name: include_signatures
description: >
If this parameter is provided, the NFVO shall return the manifest and related security information
(such as certificate) in a ZIP archive.
If this parameter is not given, the NFVO shall provide only a copy of the manifest file.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
schema:
type: string
rameshnaraya
committed
responses:
$ref: '#/components/responses/IndividualVnfPackageManifest.Get.200'
"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: '#/components/responses/IndividualVnfPackageManifest.Get.406'
$ref: '#/components/responses/IndividualVnfPackageManifest.Get.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
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
rameshnaraya
committed
responses:
$ref: '#/components/responses/IndividualVnfPackageContent.Get.200'
$ref: '#/components/responses/IndividualVnfPackageContent.Get.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: '#/components/responses/IndividualVnfPackageContent.Get.409'
$ref: '#/components/responses/IndividualVnfPackageContent.Get.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:
description: |
The PUT method uploads the content of a VNF package.
See clause 9.4.5.3.3.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageContentRequest'
rameshnaraya
committed
responses:
$ref: '#/components/responses/IndividualVnfPackageContent.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: '#/components/responses/IndividualVnfPackageContent.Put.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
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.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- in: query
name: include_signatures
description: >
If this parameter is provided, the NFVO shall include in the ZIP archive the individual signatures and,
if provided, related certificates for the included artifacts, in the format in which they are provided
in the VNF package.
If this parameter is not given, the NFVO shall only provide copies of the artifact files.
This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
schema:
type: string
- $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
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_external_artifacts
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.200'
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.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: '#/components/responses/IndividualVnfPackageArtifacts.Get.409'
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.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:
description: |
The POST method provides the information for the NFVO to get the content of a VNF package.
See clause 9.4.6.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/VnfPackageUploadFromUriRequest'
rameshnaraya
committed
responses:
$ref: '#/components/responses/IndividualVnfPackageUploadFromUri.Post.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: '#/components/responses/IndividualVnfPackageUploadFromUri.Post.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
description: |
The GET method fetches the content of an artifact within a VNF package.
See clause 9.4.7.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- in: query
name: include_signatures
description: >
If this parameter is provided, the NFVO shall return the artifact and related security
information (such as signature and optional certificate) in a ZIP archive.
If this parameter is not given, the NFVO shall provide only a copy of the artifact file.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
schema:
type: string
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.200'
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.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: '#/components/responses/IndividualVnfPackageArtifact.Get.406'
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.409'
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.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
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. See clause 9.4.7.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- in: query
name: filter
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the PkgmSubscription and in data types referenced
from it shall be supported by the NFVO in the filter expression.
schema:
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/VnfPkgSubscriptions.Get.200'
"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
post:
description: |
The POST method creates a new subscription. See clause 9.4.8.3.1.
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.201'
$ref: '#/components/responses/VnfPkgSubscriptions.Post.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: '#/components/responses/VnfPkgSubscriptions.Post.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:
description: |
The GET method reads an individual subscription. See clause 9.4.9.3.2.
rameshnaraya
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
rameshnaraya
committed
responses:
$ref: '#/components/responses/VnfPkgSubscription.Get.200'
"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. See clause 9.4.9.3.5.
rameshnaraya
committed
responses:
$ref: '#/components/responses/VnfPkgSubscription.Delete.204'
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
"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 more 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
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 "Individual subscription" resource. It can also be retrieved
from the "id" attribute in the message content of that response.
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
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 message content 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 message content 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 message content contains the address information based on which the NFVO can obtain the content of the VNF package.
The message content 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/UploadVnfPackageFromUriRequest
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:
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
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
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
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
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
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
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: {}
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
IndividualVnfPackage.Delete.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with
the state of the resource.
Typically, this is due to the fact that the operational state of the VNF package resource is "ENABLED", or the
usage state is "IN_USE" (i.e. "Individual VNF instance" resource created from the concerned VNF package exists).
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more
information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
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
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
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
ETag:
description: |
Etag used in the header response.
style: simple
explode: false
schema:
type: string
Last-Modified:
description: |
Last-modified used in the header response.
style: simple
explode: false
schema:
type: string
If-Unmodified-Since:
description: |
Response header available in case the related "Last-Modified" or "ETag" headers
have been received in previous responses related to the target resource.
The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields
as conditions (see sections 3.1 and 3.4 of IETF RFC 9110).
style: simple
explode: false
schema:
type: string
If-Match:
description: |
Response header available in case the related "Last-Modified" or "ETag" headers
have been received in previous responses related to the target resource.
The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields
as conditions (see sections 3.1 and 3.4 of IETF RFC 9110).
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
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
IndividualVnfPackage.Patch.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently,
due to a conflict with the state of the resource.
Typically, this is due to any of the following scenarios:
- Disable a VNF package resource of which the operational state is not "ENABLED"
- Enable a VNF package resource of which the operational state is not "DISABLED"
The response body shall contain a ProblemDetails structure, in which the "detail"
attribute shall convey more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
description: |
200 OK
Shall be returned when the content of the VNFD has been read successfully. The message content shall contain a
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
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: {}
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
IndividualVnfPackageVnfd.Get.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
with the state of the resource.
Typically, this is due to the fact that "onboardingState" of the VNF package has a value different from
"ONBOARDED".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
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
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:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
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
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
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
ETag:
description: |
Etag used in the header response.
style: simple
explode: false
schema:
type: string
Last-Modified:
description: |
Last-modified used in the header response.
style: simple
explode: false
schema:
type: string
If-Unmodified-Since:
description: |
Response header available in case the related "Last-Modified" or "ETag" headers
have been received in previous responses related to the target resource.
The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields
as conditions (see sections 3.1 and 3.4 of IETF RFC 9110).
style: simple
explode: false
schema:
type: string
If-Match:
description: |
Response header available in case the related "Last-Modified" or "ETag" headers
have been received in previous responses related to the target resource.
The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields
as conditions (see sections 3.1 and 3.4 of IETF RFC 9110).
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
IndividualVnfPackageExtArtifacts.Put.202:
description: |
202 ACCEPTED
"onboardingState" = "ERROR" and the VNF package has been uploaded successfully previously, to indicate that
the access configuration information has been stored successfully by the NFVO and the NFVO now starts downloading external artifacts.
The response body shall be empty.
Prior to returning the 202 response, the NFVO shall set the "onboardingState" attribute to "UPLOADING".
Subsequently to returning the 202 response, the NFVO shall retry the download of those external artifacts
that have failed downloading, or that were downloaded successfully previously and for which modified access configuration information has been provided in the request.
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
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: {}
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
IndividualVnfPackageExtArtifacts.Put.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the "onboardingState" attribute contains a value different
from "CREATED" or "ERROR".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
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 message content 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 message content shall contain a ZIP
archive which includes:
- a copy of the manifest file of the VNF package
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
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: {}
description: |
406 Not Acceptable
If the related request contained an "Accept" header not compatible with the Content type "application/zip" but
the "include_signatures" flag was provided, the NFVO shall respond with this response code.
The "ProblemDetails" structure may be included with the "detail" attribute providing more information about the error.
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
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
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with
the state of the resource.
Typically, this is due to the fact that "onboardingState" of the VNF package has a value different
from "ONBOARDED".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
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.
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
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: {}
description: |
206 Partial Content
If the NFVO supports range requests, this response shall be returned when a single consecutive byte range
from the content of the VNF package file has been read successfully according to the request.
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 9110.
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
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-Range:
description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
style: simple
explode: false
schema:
type: string
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
with the state of the resource.
Typically, this is due to the fact that "onboardingState" of the VNF package has a value different from
"ONBOARDED".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error.
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
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/SOL005_def.yaml#/definitions/ProblemDetails"
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte range passed in the "Range" header did not match
any available byte range in the VNF package file (e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
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
IndividualVnfPackageContent.Put.202:
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
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with
the state of the resource.
Typically, this is due to the fact that the onboarding state of the VNF package resource is not "CREATED"
or "ERROR".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error.
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
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/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualVnfPackageArtifacts.Get.200:
description: |
200 OK
Shall be returned when the whole content of the archive containing the artifact files has been read successfully.
The message content shall be a ZIP archive containing the requested set of artifacts selected according to the provisions
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
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: {}
IndividualVnfPackageArtifacts.Get.206:
description: |
206 Partial Content
If the NFVO supports range requests, this response shall be returned when a single consecutive byte
range from the content of the archive that would have been returned in a "200 OK" response has been
read successfully according to the request.
The response body shall contain the requested part of the archive.
The "Content-Type" HTTP header shall be set to "application/zip".
The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
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-Range:
description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifacts.Get.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that "onboardingState" of the VNF package has a value different from "ONBOARDED".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualVnfPackageArtifacts.Get.416:
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte range passed in the "Range" header did not match
any available byte range in the archive file (e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
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
IndividualVnfPackageUploadFromUri.Post.202:
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: {}
IndividualVnfPackageUploadFromUri.Post.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a
conflict with the state of the resource.
Typically, this is due to the fact that the on-boarding state of the VNF package resource is not
"CREATED" or "ERROR".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualVnfPackageArtifact.Get.200:
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 message content 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 message content shall contain a ZIP archive which includes:
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
- 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: {}
IndividualVnfPackageArtifact.Get.206:
description: |
206 Partial Content
If the NFVO supports range requests and the "include_signatures" request URI parameter was not present in the
related request, this response shall be returned when a single consecutive byte range from the content of
the artifact file has been read successfully according to the request. The response body shall contain the
requested part of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5].
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".
The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
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-Range:
description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifact.Get.406:
description: |
406 Not Acceptable
If the related request contained an "Accept" header not compatible with the Content type "application/zip"
but the "include_signatures" flag was provided, the NFVO shall respond with this response code.
The "ProblemDetails" structure may be included with the "detail" attribute providing more information about the error.
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
IndividualVnfPackageArtifact.Get.409:
description: |
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
with the state of the resource. Typically, this is due to the fact that "onboardingState" of the VNF
package has a value different from "ONBOARDED". The response body shall contain a ProblemDetails structure,
in which the "detail" attribute shall convey more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualVnfPackageArtifact.Get.416:
description: |
416 Range Not Satisfiable
Shall be returned upon the following error: The byte range passed in the "Range" header did not match any
available byte range in the artifact file (e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
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
VnfPkgSubscriptions.Get.200:
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.201:
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 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
VnfPkgSubscriptions.Post.303:
description: |
303 See Other
Shall be returned when a subscription with the same callback URI and the same filter already
exists and the policy of the NFVO is to not create redundant subscriptions.
The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
existing "Individual subscription" resource.
The response body shall be empty.
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
VnfPkgSubscriptions.Post.422:
description: |
Shall be returned upon the following error: The content type of the message content is supported and the message
content of a request contains syntactically correct data but the data cannot be processed.
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
including rules for the presence of the response body.
Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
the Notification endpoint as described in clause 9.4.10.3.2 and the test has failed.
In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error.
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/SOL005_def.yaml#/definitions/ProblemDetails"
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
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
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
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: {}