Newer
Older
rameshnaraya
committed
title: SOL005 - NSD 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.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
rameshnaraya
committed
externalDocs:
description: ETSI GS NFV-SOL 005 V3.5.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/nsd/v2
- url: https://127.0.0.1/nsd/v2
moscatelli
committed
###############################################################################
# API Versions #
###############################################################################
moscatelli
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
moscatelli
committed
moscatelli
committed
###############################################################################
# NS Descriptors #
###############################################################################
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
The POST method is used to create a new NS descriptor resource. See clause 5.4.2.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreateNsdInfoRequest'
$ref: '#/components/responses/NSDescriptors.Post.201'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
The GET method queries information about multiple NS descriptor resources. See clause 5.4.2.3.2.
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/responses/NSDescriptors.Get.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual NS Descriptor #
###############################################################################
/ns_descriptors/{nsdInfoId}:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
parameters:
- $ref: '#/components/parameters/NsdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method reads information about an individual NS descriptor. See clause 5.4.3.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualNSDescriptor.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
requestBody:
$ref: '#/components/requestBodies/NsdInfoModifications'
moscatelli
committed
responses:
$ref: '#/components/responses/IndividualNSDescriptor.Patch.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/IndividualNSDescriptor.Patch.409'
$ref: '#/components/responses/IndividualNSDescriptor.Patch.412'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
The DELETE method deletes an individual NS descriptor resource. See clause 5.4.3.3.5.
$ref: '#/components/responses/IndividualNSDescriptor.Delete.204'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
409:
$ref: '#/components/responses/IndividualNSDescriptor.Delete.409'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
Samir Medjiah
committed
# NSD Archive Content #
moscatelli
committed
###############################################################################
/ns_descriptors/{nsdInfoId}/nsd_content:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
parameters:
- $ref: '#/components/parameters/NsdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method fetches the content of the NSD archive. See clause 5.4.4.3.2.
- $ref: '#/components/parameters/AcceptTextOrZip'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
$ref: '#/components/responses/NsdArchiveContent.Get.200'
$ref: '#/components/responses/NsdArchiveContent.Get.206'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: '#/components/responses/NsdArchiveContent.Get.409'
$ref: '#/components/responses/NsdArchiveContent.Get.416'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
The PUT method is used to upload the content of an NSD archive. See clause 5.4.4.3.3.
- $ref: '#/components/parameters/ContentTypeZip'
$ref: '#/components/responses/NsdArchiveContent.Put.202'
$ref: '#/components/responses/NsdArchiveContent.Put.204'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/NsdArchiveContent.Put.409'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
###############################################################################
# NSD #
###############################################################################
/ns_descriptors/{nsdInfoId}/nsd:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a
parameters:
- $ref: '#/components/parameters/NsdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method reads the content of the NSD within an NSD archive. See clause 5.4.4a.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
- $ref: '#/components/parameters/AcceptTextOrZip'
$ref: '#/components/responses/NSD.Get.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: '#/components/responses/NSD.Get.406'
$ref: '#/components/responses/NSD.Get.409'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
###############################################################################
# NSD Archive Manifest #
###############################################################################
/ns_descriptors/{nsdInfoId}/manifest:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b
parameters:
- $ref: '#/components/parameters/NsdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method reads the content of the manifest file within an NSD archive. See clasue 5.4.4b.3.2.
- $ref: '#/components/parameters/AcceptTextOrZip'
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
$ref: '#/components/responses/NsdArchiveManifest.Get.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: '#/components/responses/NsdArchiveManifest.Get.409'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
Samir Medjiah
committed
###############################################################################
# Individual NSD Archive Artifact #
###############################################################################
/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}:
#ETSI GS NFV-SOL 005 V3.5.1 location: 5.4.4c
Samir Medjiah
committed
parameters:
- $ref: '#/components/parameters/NsdInfoId'
- $ref: '#/components/parameters/ArtifactPathInNSD'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
Samir Medjiah
committed
get:
The GET method fetches the content of an individual artifact within an NSD archive. See clause 5.4.4c.3.2.
Samir Medjiah
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
Samir Medjiah
committed
responses:
200:
$ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.200'
Samir Medjiah
committed
206:
$ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.206'
Samir Medjiah
committed
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"
406:
$ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.406'
Samir Medjiah
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
409:
$ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.409'
Samir Medjiah
committed
416:
$ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.416'
Samir Medjiah
committed
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"
moscatelli
committed
###############################################################################
# PNF Descriptors #
###############################################################################
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The POST method is used to create a new PNF descriptor resource. See clause 5.4.5.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/CreatePnfdInfoRequest'
$ref: '#/components/responses/PNFDescriptors.Post.201'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
The GET method queries information about multiple PNF descriptor resources. See clause 5.4.5.3.2.
- $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/responses/PNFDescriptors.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual PNF Descriptor #
###############################################################################
/pnf_descriptors/{pnfdInfoId}:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
parameters:
- $ref: '#/components/parameters/PnfdInfoId'
The GET method reads information about an individual PNF descriptor. See clause 5.4.6.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
$ref: '#/components/responses/IndividualPnfDescriptor.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
The PATCH method modifies the user defined data of an individual PNF descriptor resource. See clause 5.4.6.3.4.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/PnfdInfoModifications'
$ref: '#/components/responses/IndividualPnfDescriptor.Patch.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/IndividualPnfDescriptor.Patch.412'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
The DELETE method deletes an individual PNF descriptor resource. See clause 5.4.6.3.5.
$ref: '#/components/responses/IndividualPnfDescriptor.Delete.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
moscatelli
committed
###############################################################################
/pnf_descriptors/{pnfdInfoId}/pnfd_content:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
parameters:
- $ref: '#/components/parameters/PnfdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method fetches the content of the PNFD archive. See clause 5.4.7.3.2.
- $ref: '#/components/parameters/AcceptText'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
$ref: '#/components/responses/PnfdArchiveContent.Get.200'
$ref: '#/components/responses/PnfdArchiveContent.Get.206'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
409:
$ref: '#/components/responses/PnfdArchiveContent.Get.409'
$ref: '#/components/responses/PnfdArchiveContent.Get.416'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
The PUT method is used to upload the content of a PNFD archive. See clause 5.4.7.3.3.
- $ref: '#/components/parameters/AcceptText'
- $ref: '#/components/parameters/ContentTypeZip'
$ref: '#/components/responses/PnfdArchiveContent.Put.200'
$ref: '#/components/responses/PnfdArchiveContent.Put.204'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/PnfdArchiveContent.Put.409'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
###############################################################################
# PNFD #
###############################################################################
/pnf_descriptors/{pnfdInfoId}/pnfd:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7a
parameters:
- $ref: '#/components/parameters/PnfdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method reads the content of the PNFD within a PNFD archive. See clause 5.4.7a.3.2.
- $ref: '#/components/parameters/AcceptText'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
$ref: '#/components/responses/PNFD.Get.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: '#/components/responses/PNFD.Get.406'
$ref: '#/components/responses/PNFD.Get.409'
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
###############################################################################
Samir Medjiah
committed
# PNFD Archive Manifest #
###############################################################################
/pnf_descriptors/{pnfdInfoId}/manifest:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7b
parameters:
- $ref: '#/components/parameters/PnfdInfoId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method reads the content of the manifest file within a PNFD archive. See clause 5.4.7b.3.2.
- $ref: '#/components/parameters/AcceptTextOrZip'
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
$ref: '#/components/responses/PnfdArchiveManifest.Get.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/PnfdArchiveManifest.Get.409'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
Samir Medjiah
committed
###############################################################################
# Individual PNFD Archive Artifact #
###############################################################################
/pnf_descriptors/{pnfdInfoId}/artifacts/{artifactPath}:
#ETSI GS NFV-SOL 005 V3.5.1 location: 5.4.7c
Samir Medjiah
committed
parameters:
- $ref: '#/components/parameters/PnfdInfoId'
- $ref: '#/components/parameters/ArtifactPathInPNFD'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
Samir Medjiah
committed
get:
The GET method fetches the content of an individual artifact within a PNFD archive. See clause 5.4.7c.3.2.
Samir Medjiah
committed
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
Samir Medjiah
committed
responses:
200:
$ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.200'
Samir Medjiah
committed
206:
$ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.206'
Samir Medjiah
committed
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"
406:
$ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.406'
Samir Medjiah
committed
409:
$ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.409'
Samir Medjiah
committed
416:
$ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.416'
Samir Medjiah
committed
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"
moscatelli
committed
###############################################################################
# Subscriptions #
###############################################################################
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The POST method creates a new subscription. See clause 5.4.8.3.1.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsdmSubscriptionRequest'
$ref: '#/components/responses/Subscriptions.Post.201'
$ref: '#/components/responses/Subscriptions.Post.303'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: '#/components/responses/Subscriptions.Post.422'
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
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 5.4.8.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/Subscriptions.Get.200'
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual Subscription #
###############################################################################
/subscriptions/{subscriptionId}:
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
The GET method retrieves information about a subscription by reading an individual subscription resource.
See clause 5.4.9.3.2.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualSubscription.Get.200'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
The DELETE method terminates an individual subscription. See clause 5.4.9.3.5.
$ref: '#/components/responses/IndividualSubscription.Delete.204'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
components:
parameters:
AcceptTextOrZip:
name: Accept
description: >
The request shall contain the appropriate entries in the "Accept" HTTP header.
in: header
required: true
schema:
type: string
enum:
- text/plain
- application/zip
AcceptText:
name: Accept
description: >
The request shall contain the appropriate entries in the "Accept" HTTP header.
in: header
required: true
schema:
type: string
enum:
- text/plain
ContentTypeZip:
name: Content-Type
description: |
The payload body contains a ZIP file that represents the NSD archive, as specified above.
The request shall set the "Content-Type" HTTP header to "application/zip".
in: header
required: true
schema:
type: string
enum:
- application/zip
NsdInfoId:
name: nsdInfoId
in: path
description: |
Identifier of the individual NS descriptor resource.
required: true
style: simple
explode: false
schema:
type: string
PnfdInfoId:
name: pnfdInfoId
in: path
description: |
Identifier of the individual PNF descriptor resource.
required: true
style: simple
explode: false
schema:
type: string
ArtifactPathInNSD:
name: artifactPath
in: path
description: |
For an artifact contained as a file in the NSD archive, this variable shall
contain a sequence of one or path segments representing the path of the
artifact within the NSD archive, relative to the root of the package.
EXAMPLE: foo/bar/m%40ster.sh
For an external artifact represented as a URI in the NSD archive manifest,
this variable shall contain the URI as provided in the NS archive.
This identifier can be retrieved from the "artifactPath" attribute of the
applicable "artifacts" entry in the body of the response to a GET request
querying the "Individual NSD" resource.
Since multiple path segments are allowed to be contained in this variable,
the "/" character that separates these segments is not percent-encoded.
Each individual segment is percent-encoded if necessary as defined in
clause 4.1 of ETSI GS NFV-SOL 013.
required: true
style: simple
explode: false
schema:
type: string
ArtifactPathInPNFD:
name: artifactPath
in: path
description: |
For an artifact contained as a file in the PNFD archive, this variable shall contain
a sequence of one or path segments representing the path of the artifact within the
PNFD archive, relative to the root of the package.
EXAMPLE: foo/bar/m%40ster.sh
For an external artifact represented as a URI in the PNFD archive manifest, this variable
shall contain the URI as provided in the NS archive.
This identifier can be retrieved from the "artifactPath" attribute of the applicable
"artifacts" entry in the body of the response to a GET request querying the "Individual PNFD"
resource.
Since multiple path segments are allowed to be contained in this variable, the "/" character
that separates these segments is not percent-encoded. Each individual segment is percent-encoded
if necessary as defined in clause 4.1 of ETSI GS NFV-SOL 013.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
description: |
Identifier of this subscription.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in
the response to a POST request creating a new subscription resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
requestBodies:
CreateNsdInfoRequest:
description: |
Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
required: true
NsdInfoModifications:
description: |
Parameters for the modification of an individual NS descriptor resource, as defined in clause 5.5.2.1.
The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
required: true
CreatePnfdInfoRequest:
description: |
Parameters of creating a PNF descriptor resource.
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
required: true
PnfdInfoModifications:
description: |
Parameters for the modification of an individual
PNF descriptor resource, as defined in clause 5.5.2.4.
The Content-Type header shall be set to "application/merge-patch+json"
according to IETF RFC 7396.
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
required: true
NsdmSubscriptionRequest:
description: |
Details of the subscription to be created, as defined in clause 5.5.2.7.
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
required: true
responses:
NSDescriptors.Post.201:
description: |
201 CREATED
Shall be returned when a new "Individual NS descriptor" resource
and the associated NS descriptor identifier has been created successfully.
The response body shall contain a representation of the created NS descriptor
resource, as defined in clause 5.5.2.2.
The HTTP response shall include a "Location" HTTP header that contains the
resource URI of the created NS descriptor resource.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
NSDescriptors.Get.200:
description: |
200 OK
Shall be returned when information about zero or
more NS descriptors has been queried successfully.
The response body shall contain in an array the
representations of zero or more NS descriptors, as
defined in clause 5.5.2.2.
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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
IndividualNSDescriptor.Get.200:
description: |
200 OK
Shall be returned when information about the individual
NS descriptor has been read successfully.
The response body shall contain a representation of
the individual NS descriptor, as defined in
clause 5.5.2.2.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
IndividualNSDescriptor.Patch.200:
description: |
200 OK
Shall be returned when the operation has been accepted and completed successfully.
The response body shall contain attribute modifications for an 'Individual NS descriptor'
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
409 CONFLICT
Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with
the state of the "Individual NS descriptor" resource.
Typically, this is due to an operational state mismatch, i.e. enable an already enabled or disable an already
disabled individual NS descriptor resource, or the "nsdOnboardingState" is not ONBOARDED.
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more
information about the error.
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
Shall be returned upon the following error: A precondition given in an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey
more information about the error.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Shall be returned when the operation has completed successfully.
The response body shall be empty.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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 the NS descriptor resource is in the enabled operational state
(i.e. nsdOperationalState = ENABLED) or there are running NS instances using the concerned individual
NS descriptor resource (i.e. nsdUsageState = IN_USE).
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
convey more information about the error.
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in 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 NSD has been read successfully.
The payload body shall contain a copy of the ZIP file that contains the NSD file structure.
The "Content-Type" HTTP header shall be set to "application/zip".
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
If NFVO supports range requests, this response
shall be returned when a single consecutive byte range from the content of the NSD file has been read
successfully according to the request.
The response body shall contain the requested part of the NSD archive.
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10].
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in 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
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 "nsdOnboardingState" 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.
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
The byte range passed in the "Range" header did not match any available byte range in the NSD file
(e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in 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
Shall be returned when the NSD archive has been accepted for uploading,
but the processing has not been completed. It is expected to take some
time for processing (asynchronous mode).
The response body shall be empty.
The API consumer can track the uploading progress by receiving the
"NsdOnBoardingNotification" and "NsdOnBoardingFailureNotification"
from the NFVO or by reading the status of the individual NS descriptor
resource using the GET method.
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
The NSD content successfully uploaded and
validated (synchronous mode).
The response body shall be empty.
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
NsdArchiveContent.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 "nsdOnboardingState" attribute has a value other than "CREATED" or "ERROR".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
The MIME type of the body of the request. Reference: IETF RFC 7231
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 NSD has been read successfully.
The payload body shall contain a copy of the file representing the NSD or
a ZIP file that contains the file or multiple files representing the NSD,
as specified above.
The "Content-Type" HTTP header shall be set according to the format of
the returned file. It shall be set to "text/plain" for a YAML file.
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
If the "Accept" header does not contain at least one name of a content type for which the NFVO can provide a
representation of the NSD, 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:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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 "nsdOnboardingState" 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:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
1822
1823
1824
1825
1826
1827
1828
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
1865
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
2107
2108
2109
2110
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
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
NsdArchiveManifest.Get.200:
description: |
200 OK
Shall be returned when the content of the manifest file has been read successfully.
If the "include_signatures" URI query parameter was absent in the request, or if the
manifest file has all security-related information embedded (i.e. there is no separate
certificate file), the payload body shall contain a copy of the manifest file of the
NSD archive, and the "Content-Type" HTTP header shall be set to "text/plain".
If the "include_signatures" URI query parameter was present in the related request and
the manifest file does not have all the security-related information embedded (i.e. there
is a separate certificate file), the "Content-Type" HTTP header shall be set to "application/zip"
and the payload body shall contain a ZIP archive which includes:
- a copy of the manifest file of the NSD archive;
- a copy of the related individual certificate file.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
NsdArchiveManifest.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 "nsdOnboardingState " 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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualNsdArchiveArtifact.Get.200:
description: |
200 OK
Shall be returned when the content of the artifact file has been read successfully.
If the "include_signatures" request URI parameter was not provided in the related request,
the payload body shall contain a copy of the artifact file from the NSD archive, as defined
by ETSI GS NFV-SOL 007, 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).
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 "Content-Type" HTTP header shall be set to "application/zip"
and the payload body shall contain a ZIP archive which includes:
- a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 007
- the related security information (individual signature file and optional related individual
certificate file).
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
IndividualNsdArchiveArtifact.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 NSD archive,
as defined by ETSI GS NFV-SOL 007.
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 7233.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
IndividualNsdArchiveArtifact.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 "nsdOnboardingState" 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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualNsdArchiveArtifact.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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
IndividualNsdArchiveArtifact.Get.416:
description: |
416 Range Not Satisfiable
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:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PNFDescriptors.Post.201:
description: |
201 CREATED
Shall be returned when a new "Individual PNF descriptor"
resource and the associated PNF descriptor identifier
has been created successfully.
The response body shall contain a representation of the
created PNF descriptor resource, as defined in clause 5.5.2.5.
The HTTP response shall include a "Location" HTTP header that
contains the resource URI of the created PNF descriptor resource.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
PNFDescriptors.Get.200:
description: |
200 OK
Shall be returned when information about zero or more PNF descriptors has
been queried successfully.
The response body shall contain in an array the representations of zero or
more PNF descriptors, as defined in clause 5.5.2.5.
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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
description: |
Information about zero or more PNF descriptors.
The response body shall contain a representation in an array the representations
of zero or more PNF descriptors, as defined in clause 5.5.2.2.
If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
type: array
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
IndividualPnfDescriptor.Get.200:
description: |
200 OK
Shall be returned when information about the individual PNFD
descriptor has been read successfully.
The response body shall contain a representation of the
individual PNF descriptor, as defined in clause 5.5.2.5.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
IndividualPnfDescriptor.Patch.200:
description: |
200 OK
Shall be returned when the operation has been accepted
and completed successfully.
The response body shall contain attribute modifications
for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4).
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
IndividualPnfDescriptor.Patch.412:
description: |
412 Precondition failed
Shall be returned upon the following error: A precondition given in an HTTP request header is not fulfilled.
Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
The response body should contain a ProblemDetails structure, in which the "detail" attribute should
convey more information about the error.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
IndividualPnfDescriptor.Delete.200:
description: |
204 NO CONTENT
Shall be returned when the operation
has completed successfully.
The response body shall be empty.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PnfdArchiveContent.Get.200:
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
description: |
200 OK
Shall be returned when the content of the PNFD archive has
been read successfully.
The payload body shall contain a copy of the PNFD archive
The "Content-Type" HTTP header shall be set to "application/zip".
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
PnfdArchiveContent.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 PNFD archive
has been read successfully according to the request.
The response body shall contain the requested part of the PNFD archive.
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PnfdArchiveContent.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 pnfdOnboardingState 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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
PnfdArchiveContent.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 PNFD archive (e.g. "access after end of file").
The response body may contain a ProblemDetails structure.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PnfdArchiveContent.Put.200:
description: |
202 ACCEPTED
Shall be returned when the PNFD archive has been accepted for uploading,
but the processing has not been completed. It is expected to take some
time for processing (asynchronous mode).
The response body shall be empty.
The API consumer can track the uploading progress by receiving the
"PnfdOnBoardingNotification" and "PnfdOnBoardingFailureNotification"
from the NFVO or by reading the status of the individual PNF descriptor
resource using the GET method.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PnfdArchiveContent.Put.204:
Shall be returned when the PNFD archive content has been
uploaded and validated successfully.
The response body shall be empty.
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PnfdArchiveContent.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 "pnfdOnboardingState" attribute has a value other than "CREATED" or "ERROR".
The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
more information about the error
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
Shall be returned when the content of the PNFD has been read successfully.
The payload body shall contain a copy of the file representing the PNFD
or a ZIP file that contains the file or multiple files representing the
PNFD, as specified above.
The "Content-Type" HTTP header shall be set according to the format of
the returned file. It shall be set to "text/plain" for a YAML file.
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
If the "Accept" header does not contain at least one name of a content type for which the NFVO can
provide a representation of the PNFD, 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:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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 "pnfdOnboardingState " 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.
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
PnfdArchiveManifest.Get.200:
description: |
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
Shall be returned when the content of the manifest file has been
read successfully.
If the "include_signatures" URI query parameter was absent in the
request, or if the manifest file has all security-related information
embedded (i.e. there is no separate certificate file), the payload
body shall contain a copy of the manifest file of the PNFD archive,
and the "Content-Type" HTTP header shall be set to "text/plain".
If the "include_signatures" URI query parameter was present in the
related request and the manifest file does not have all the
security-related information embedded (i.e. there is a separate certificate file),
the "Content-Type" HTTP header shall be set to "application/zip" and
the payload body shall contain a ZIP archive which includes:
- a copy of the manifest file of the PNFD archive;
- a copy of the related individual certificate file.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
enum:
- text/plain
- application/zip
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
PnfdArchiveManifest.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 "pnfdOnboardingState " 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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
style: simple
explode: false
schema:
type: string
enum:
- text/plain
- application/zip
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
IndividualPnfdArchiveArtifact.Get.200:
description: |
200 OK
Shall be returned when the content of the artifact file has been read successfully.
If the "include_signatures" request URI parameter was not provided in the related request,
the payload body shall contain a copy of the artifact file from the PNFD archive, as defined
by ETSI GS NFV-SOL 004, 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).
If the content type cannot be determined, the header shall be set to the value
"application/octetstream". If the "include_signatures" request URI parameter was provided
in the related request, the "Content-Type" HTTP header shall be set to "application/zip"
and the payload body shall contain a ZIP archive which includes:
- a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 004
- the related security information (individual signature file and optional related individual
certificate file).
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
IndividualPnfdArchiveArtifact.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 PNFD archive,
as defined by ETSI GS NFV-SOL 004.
The "Content-Type" HTTP header shall be set according to the content type of the artifact file.
If the content type cannot be determined, the header shall be set to the value
"application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
IndividualPnfdArchiveArtifact.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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
IndividualPnfdArchiveArtifact.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 "pnfdOnboardingState" 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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
IndividualPnfdArchiveArtifact.Get.416:
description: |
416 Range Not Satisfiable
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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
Subscriptions.Post.201:
description: |
201 CREATED
Shall be returned when the subscription has been created successfully.
A representation of the created "Individual subscription" resource shall
be returned in the response body, as defined in clause 5.5.2.8.
The HTTP response shall include a "Location:" HTTP header that points
to the created "Individual subscription" resource.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
The resource URI of the created NS instance
schema:
type: string
style: simple
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
Subscriptions.Post.303:
description: |
303 See Other
Shall be returned when a subscription with the same callback URI and the same filter already exits 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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Location:
description: |
The resource URI of the created NS instance
schema:
type: string
style: simple
Subscriptions.Post.422:
description: |
422 Unprocessable Entity
Shall be returned upon the following error: The content type of the payload body is supported and the payload
body of a request contains syntactically correct data but the data cannot be processed.
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 5.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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
Subscriptions.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 NSD management subscriptions as defined in clause 5.5.2.8.
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:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
description: |
The list of subscriptions was 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 NSD management
subscriptions as defined in clause 5.5.2.8.
If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
type: array
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
IndividualSubscription.Get.200:
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 subscription resource.
headers:
Content-Type:
description: |
The MIME type of the body of the request. Reference: IETF RFC 7231
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
IndividualSubscription.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual subscription" resource
has been deleted successfully.
The response body shall be empty.
headers:
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
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string