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 and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
rameshnaraya
committed
externalDocs:
description: ETSI GS NFV-SOL 005 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.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
post:
summary: Create a new NS descriptor resource.
The POST method is used to create a new NS descriptor resource.
- $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"
summary: Query information about multiple NS descriptor resources.
moscatelli
committed
The GET method queries information about multiple NS descriptor resources.
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
summary: Read information about an individual NS descriptor resource.
moscatelli
committed
The GET method reads information about an individual NS descriptor.
- $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"
summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
This method can be used to:
1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new
network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as a
result.
2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of
new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change
as a result.
rameshnaraya
committed
3) Modify the 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"
Samir Medjiah
committed
# 409 CONFLICT
# Error: The operation cannot be executed currently,
# due to a conflict with the state of the 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
$ref: "../responses/SOL005_resp.yaml#/components/responses/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
summary: Delete an individual NS descriptor resource.
The DELETE method deletes an individual NS descriptor resource.
An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState =
NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method
shall fail.
responses:
204:
$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:
Samir Medjiah
committed
# 409 CONFLICT
# 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.
# operationalState = ENABLED) or there are running
# NS instances using the concerned individual NS
# descriptor resource (i.e. usageState = IN_USE).
# The response body shall contain a ProblemDetails
# structure, in which the "detail" attribute shall convey
# more information about the error.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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.
The NSD archive is implemented as a single zip file.
The content of the NSD archive is provided as onboarded,
i.e. depending on the security option used, the CSAR wrapped
in a ZIP archive together with an external signature is returned,
as defined in clause 5.1 of ETSI GS NFV-SOL 007.
NOTE: Information about the applicable security option can be
obtained by evaluating the "archiveSecurityOption"
attribute in the "nsdInfo" structure.
This method shall follow the provisions specified in the T
ables 5.4.4.3.2-1 and 5.4.4.3.2-2 for URI query parameters,
request and response data structures, and response codes.
- $ref: '#/components/parameters/AcceptTextOrZip'
- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
$ref: '#/components/responses/NsdArchiveContent.Get.200'
Samir Medjiah
committed
# 206 PARTIAL CONTENT
# On success, if the NFVO supports range requests,
# a single consecutive byte range from the content of
# the NSD file is returned.
# The response body shall contain the requested part
# of the NSD file.
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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"
Samir Medjiah
committed
# 406 NOT ACCEPTABLE
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
Samir Medjiah
committed
# 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
# "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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
Samir Medjiah
committed
# 416 RANGE NOT SATISFIABLE
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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.
The NSD to be uploaded is implemented as a single ZIP file as defined in clause 5.4.4.3.2.
The "Content-Type" HTTP header in the PUT request shall be set to "application/zip".
This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and
5.4.4.3.3-2 for URI query parameters, request and response data structures, and response codes.
- $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"
# 409 CONFLICT
#
# 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 has a value other than
# CREATED.
# The response body shall contain a ProblemDetails
# structure, in which the "detail" attribute shall convey
# more information about the error.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
The GET method reads the content of the NSD within an NSD archive.
The NSD can be implemented as a single file or as a collection of
multiple files. If the NSD is implemented in the form of multiple files,
a ZIP file embedding these files shall be returned. If the NSD is implemented
as a single file, either that file or a ZIP file embedding that file shall be returned.
The selection of the format is controlled by the "Accept" HTTP header passed in the GET request:
• If the "Accept" header contains only "text/plain" and the NSD is implemented as a single file,
the file shall be returned; otherwise, an error message shall be returned.
• If the "Accept" header contains only "application/zip", the single file or
the multiple files that make up the NSD shall be returned embedded in a ZIP file.
• If the "Accept" header contains both "text/plain" and "application/zip", it is up
to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD,
a ZIP file shall be returned.
The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 007
where only the YAML files representing the NSD, and information necessary to navigate
the ZIP file and to identify the file that is the entry point for parsing the NSD and
(if requested) further security information are included. This means that the content
of the ZIP archive shall contain the following files from the NSD archive:
• TOSCA.meta (if available in the NSD archive);
• the main service template (either as referenced from TOSCA.meta or available as a
file with the extension ".yml" or ".yaml" from the root of the archive);
• every component of the NSD referenced (recursively) from the main service template;
• the related security information, if the "include_signatures" URI parameter is provided, as follows:
- the manifest file;
- the singleton certificate file in the root of the NSD archive (if available in the NSD archive);
- the signing certificates of the individual files included in the ZIP archive
(if available in the NSD archive);
- the signatures of the individual files (if available in the NSD archive).
This method shall follow the provisions specified in the Tables 5.4.4a.3.2-1 and 5.4.4a.3.2-2 for
URI query parameters, request and response data structures, and response codes.
parameters:
- $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: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/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
get:
summary: Fetch the content of the manifest in an NSD archive.
The GET method reads the content of the manifest file within an NSD archive.
This method shall follow the provisions specified in the Tables 5.4.4b.3.2-1
and 5.4.4b.3.2-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $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"
Samir Medjiah
committed
# 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
# "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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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}:
Samir Medjiah
committed
#ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.4c
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:
Samir Medjiah
committed
The GET method fetches the content of an individual artifact within
a NSD archive.
This method shall follow the provisions specified in the Tables 5.4.4c.3.2-1
and 5.4.4c.3.2-2 for URI query parameters, request and response data structures,
and response codes.
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:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
409:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
416:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
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
post:
summary: Create a new PNF descriptor resource.
The POST method is used to create a new PNF descriptor resource
parameters:
- $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"
summary: Query information about multiple PNF descriptor resources.
rameshnaraya
committed
"The GET method queries information about multiple PNF descriptor
resources."
- $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'
summary: Read an individual PNFD resource.
The GET method reads information about an individual PNF descriptor.
parameters:
- $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"
patch:
summary: Modify the user defined data of an individual PNF descriptor resource.
The PATCH method modifies the user defined data of an individual PNF descriptor resource.
parameters:
- $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: "../responses/SOL005_resp.yaml#/components/responses/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
delete:
summary: Delete an individual PNF descriptor resource.
The DELETE method deletes an individual PNF descriptor resource.
An individual PNF descriptor resource can only be deleted when t
here is no NS instance using it or there is NSD referencing it.
To delete all PNFD versions identified by a particular value of
the "pnfdInvariantId" attribute, the procedure is to first use t
he GET method with filter "pnfdInvariantId" towards the PNF
descriptors resource to find all versions of the PNFD. Then,
he API consumer uses the DELETE method described in this clause
to delete each PNFD version individually.
This method shall follow the provisions specified in the Tables
5.4.6.3.5-1 and 5.4.6.3.5-2 for URI query parameters, request
and response data structures, and response codes.
$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.
The content of the PNFD archive is provided as onboarded,
i.e. depending on the security option used, the CSAR or
the CSAR wrapped in a ZIP archive together with an external
signature is returned, as defined in clause 5.1 of ETSI GS NFV-SOL 004.
NOTE: Information about the applicable security option can be obtained
by evaluating the "archiveSecurityOption" attribute in the "pnfdInfo" structure.
This method shall follow the provisions specified in the Tables 5.4.7.3.2-1
and 5.4.7.3.2-2 for URI query parameters, request and response data structures,
and response codes.
- $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:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
$ref: "../responses/SOL005_resp.yaml#/components/responses/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"
summary: Upload the content of a PNFD.
The PUT method is used to upload the content of a PNFD archive.
This resource represents the content of the individual PNF descriptor, i.e. PNFD content.
The client can use this resource to upload and download the content of the PNFD.
- $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"
Samir Medjiah
committed
# 409 CONFLICT
# 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 has a value other than
# CREATED.
# The response body shall contain a ProblemDetails
# structure, in which the "detail" attribute shall convey
# more information about the error.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
The GET method reads the content of the PNFD within a PNFD archive.
The PNFD can be implemented as a single file or as a collection of
multiple files. If the PNFD is implemented in the form of multiple
files, a ZIP file embedding these files shall be returned. If the
PNFD is implemented as a single file, either that file or a ZIP file
embedding that file shall be returned.
The selection of the format is controlled by the "Accept" HTTP header
passed in the GET request:
• If the "Accept" header contains only "text/plain" and the PNFD is
implemented as a single file, the file shall be returned; otherwise,
an error message shall be returned.
• If the "Accept" header contains only "application/zip", the single
file or the multiple files that make up the PNFD shall be returned
embedded in a ZIP file.
• If the "Accept" header contains both "text/plain" and "application/zip",
it is up to the NFVO to choose the format to return for a single-file PNFD;
for a multi-file PNFD, a ZIP file shall be returned.
The default format of the ZIP file shall be the one specified in ETSI GS
NFV-SOL 004 where only the YAML files representing the PNFD, and information
necessary to navigate the ZIP file and to identify the file that is the entry
point for parsing the PNFD and (if requested) further security information
are included. This means that the content of the ZIP archive shall contain
the following files from the PNFD archive:
• TOSCA.meta (if available in the PNFD archive);
• the main service template (either as referenced from TOSCA.meta or
available as a file with the extension ".yml" or ".yaml" from the
root of the archive);
• every component of the PNFD referenced (recursively) from the main
service template;
• the related security information, if the "include_signatures" URI
parameter is provided, as follows:
- the manifest file;
- the singleton certificate file in the root of the PNFD archive
(if available in the PNFD archive);
- the signing certificates of the individual files included in the
ZIP archive (if available in the PNFD archive);
- the signatures of the individual files (if available in the PNFD archive).
This method shall follow the provisions specified in the Tables 5.4.7a.3.2-1 and
5.4.7a.3.2-2 for URI query parameters, request and response data structures, and response codes.
parameters:
- $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: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/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.
This method shall follow the provisions specified in the Tables 5.4.7b.3.2-1
and 5.4.7b.3.2-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- $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: "../responses/SOL005_resp.yaml#/components/responses/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}:
Samir Medjiah
committed
#ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.7c
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:
Samir Medjiah
committed
The GET method fetches the content of an individual artifact within a PNFD archive.
This method shall follow the provisions specified in the Tables 5.4.7c.3.2-1 and
5.4.7c.3.2-2 for URI query parameters, request and response data structures, and
response codes.
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:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
409:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
416:
Samir Medjiah
committed
# 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
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
post:
summary: Subscribe to NSD and PNFD change notifications.
The POST method creates a new subscription.
This method shall support the URI query parameters, request and
response data structures, and response codes, as specified in
the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2.
Creation of two subscription resources with the same callback URI
and the same filter can result in performance degradation and will
provide duplicates of notifications to the OSS, and might make
sense only in very rare use cases. Consequently, the NFVO may
either allow creating a subscription resource if another subscription
resource with the same filter and callback URI already exists (in which
case it shall return the "201 Created" response code), or may decide to
not create a duplicate subscription resource (in which case it shall
return a "303 See Other" response code referencing the existing
subscription resource with the same filter and callbackUricallback URI).
- $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'
Samir Medjiah
committed
# 303 SEE OTHER
# Shall be returned when a subscription with the
# same callbackURI 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 subscription resource.
# The response body shall be empty.
$ref: "../responses/SOL005_resp.yaml#/components/responses/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: "../responses/SOL005_resp.yaml#/components/responses/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"
summary: Query multiple subscriptions.
TThe GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g.
for resynchronization after error situations.
This method shall support the URI query parameters, request and
response data structures, and response codes, as specified in
the Tables 5.4.8.3.2-1 and 5.4.8.3.2-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
summary: Read an individual subscription resource.
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
notifications related to NSD management.
moscatelli
committed
The GET method retrieves information about a subscription by reading
an individual subscription resource.
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
notifications related to NSD management.
parameters:
- $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"
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
notifications related to NSD management.
moscatelli
committed
The DELETE method terminates an individual subscription.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.9.3.3-2.
$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:
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
$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"
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
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
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
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
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
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'
resource (see clause 5.5.2.6).
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"
IndividualNSDescriptor.Delete.204:
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
NsdArchiveContent.Get.200:
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".
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
NsdArchiveContent.Put.202:
description: |
202 ACCEPTED
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.
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
NsdArchiveContent.Put.204:
description: |
204 NO CONTENT
The NSD content successfully uploaded and
validated (synchronous mode).
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
NSD.Get.200:
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.
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.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
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
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.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:
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
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.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:
description: |
204 NO CONTENT
Shall be returned when the PNFD archive content has been
uploaded and validated 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
PNFD.Get.200:
description: |
200 OK
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.
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
PnfdArchiveManifest.Get.200:
description: |
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
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
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
content:
application/json:
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
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