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.3.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.05.01_60/gs_nfv-sol005v030501p.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:
- $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:
$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
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
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
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
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
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
- $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
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
$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
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $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'
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
"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
692
693
694
695
696
697
698
699
700
701
702
703
704
705
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
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
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:
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
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
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
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
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
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: {}
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
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"
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
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:
$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
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
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 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: