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
$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.