Newer
Older
rameshnaraya
committed
version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
moscatelli
committed
title: "SOL005 - NSD Management Interface"
description: >
SOL005 - NSD Management Interface
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/rep/nfv/SOL005/issues
moscatelli
committed
name: "ETSI Forge copyright notice"
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
contact:
moscatelli
committed
name: "NFV-SOL WG"
rameshnaraya
committed
externalDocs:
description: ETSI GS NFV-SOL 005 V2.8.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.08.01_60/gs_NFV-SOL005v020801p.pdf
rameshnaraya
committed
schemes:
moscatelli
committed
- http
moscatelli
committed
- https
moscatelli
committed
###############################################################################
# API Versions #
###############################################################################
moscatelli
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
moscatelli
committed
moscatelli
committed
###############################################################################
# NS Descriptors #
###############################################################################
rameshnaraya
committed
'/ns_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
description: >
The POST method is used to create a new NS descriptor resource.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: CreateNsdInfoRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
description: >
Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.
responses:
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.
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
headers:
Content-Type:
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
The GET method queries information about multiple NS descriptor resources.
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The NFVO shall support receiving this filtering parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the NsdInfo and in data types referenced from it shall
be supported by the NFVO in the filter expression.
moscatelli
committed
- name: all_fields
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV SOL 013 for details.
moscatelli
committed
- name: fields
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV SOL 013 for
moscatelli
committed
details. The NFVO should support this parameter.
- name: exclude_fields
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV SOL 013 for
moscatelli
committed
details. The NFVO should support this parameter.
- name: exclude_default
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV SOL 013 for details.
The NFVO shall support this parameter.
The following attributes shall be excluded from the NsdInfo structure in the response body if this
parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default"
are provided:
- userDefinedData
- onboardingFailureDetails
moscatelli
committed
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource.
moscatelli
committed
required: false
type: string
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
moscatelli
committed
in: header
moscatelli
committed
required: true
moscatelli
committed
type: string
rameshnaraya
committed
description: >
moscatelli
committed
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.
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
moscatelli
committed
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: array
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Individual NS Descriptor #
###############################################################################
rameshnaraya
committed
'/ns_descriptors/{nsdInfoId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
parameters:
moscatelli
committed
- name: nsdInfoId
description: >
Identifier of the individual NS descriptor resource.
moscatelli
committed
in: path
moscatelli
committed
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
description: >
The GET method reads information about an individual NS descriptor.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
moscatelli
committed
Reference: IETF RFC 7231.
rameshnaraya
committed
in: header
required: true
type: string
moscatelli
committed
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.
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message body.
moscatelli
committed
type: string
rameshnaraya
committed
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.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
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.
- name: NsdInfoModifications
moscatelli
committed
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
moscatelli
committed
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.
moscatelli
committed
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
rameshnaraya
committed
description: >
moscatelli
committed
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).
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
# description: >
# 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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/409"
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/412"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
moscatelli
committed
description: >
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.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
moscatelli
committed
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
moscatelli
committed
required: true
moscatelli
committed
type: string
moscatelli
committed
description: >
204 NO CONTENT
moscatelli
committed
Shall be returned when the operation has completed successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
moscatelli
committed
type: string
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.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
409:
# description: >
# 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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
moscatelli
committed
###############################################################################
rameshnaraya
committed
'/ns_descriptors/{nsdInfoId}/nsd_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
parameters:
moscatelli
committed
- name: nsdInfoId
in: path
moscatelli
committed
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
description: >
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.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: Range
in: header
required: false
type: string
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from the NSD archive.
This can be used to continue an aborted transmission.
If the Range header is present in the request and the NFVO does
not support responding to range requests with a 206 response,
it shall return a 200 OK response instead as defined below.
moscatelli
committed
description: >
moscatelli
committed
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".
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
# description: >
# 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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/206"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
# description: >
# 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#/responses/406"
# description: >
# 409 CONFLICT
#
# Shall be returned upon the following error: The
# operation cannot be executed currently, due to a
# conflict with the state of the resource.
# Typically, this is due to the fact
# "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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/409"
# description: >
# 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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
moscatelli
committed
description: >
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.
moscatelli
committed
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".
moscatelli
committed
in: header
required: true
type: string
enum:
- application/zip
moscatelli
committed
description: >
moscatelli
committed
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 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.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
moscatelli
committed
description: >
moscatelli
committed
The NSD content successfully uploaded and
validated (synchronous mode).
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
# description: >
# 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#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
###############################################################################
# NSD #
###############################################################################
'/ns_descriptors/{nsdInfoId}/nsd':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a
parameters:
- name: nsdInfoId
in: path
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
description: >
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 comply with the CSAR format as 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, and other artifacts referenced from the YAML files are excluded. 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 TOSCA definitions YAML file (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 TOSCA definitions YAML file;
NOTE 1: For a NSD based on TOSCA, it includes all the imported type definition files as indicated in the top
level service template and in any of the lower level service template if it has any as described in ETSI GS NFV-SOL 001.
NOTE 2: For a NSD based on YANG, it includes the file as indicated by the "yang_definitions" keyname in the metadata
section of the main yaml file as described in ETSI GS NFV-SOL 007.
- 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).
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
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:
- name: include_signatures
in: query
required: false
type: string
description: >
If this parameter is provided, the NFVO shall include in the ZIP
file the security information as specified above.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
- name: Accept
in: header
required: true
type: string
enum:
- text/plain
- application/zip
description: >
The request shall contain the appropriate entries in the "Accept"
HTTP header as defined above.
responses:
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 response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
###############################################################################
# NSD Archive Manifest #
###############################################################################
'/ns_descriptors/{nsdInfoId}/manifest':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b
parameters:
- name: nsdInfoId
description: >
Identifier of the individual NS descriptor.
This identifier can be retrieved from the resource referenced by
the "Location" HTTP header in the response to a POST request creating
a new NS descriptor resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
in: path
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
description: >
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:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: include_signatures
in: query
required: false
type: string
If this parameter is provided, the NFVO shall return the manifest and
related security information (signature and certificate) either in a
single text file if the signature and certificate are included in the
manifest file, or in a zip file containing the manifest and the certificate
file, if this is provided as a separate file in the NSD archive.
If this parameter is not given, the NFVO shall provide only a copy of the
manifest file, as onboarded. If the security information is included in the
onboarded manifest, it shall also be included in the returned copy.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
responses:
200:
description: >
200 OK
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
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 response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
409:
# description: >
# 409 CONFLICT
#
# Shall be returned upon the following error: The
# operation cannot be executed currently, due to a
# conflict with the state of the resource.
# Typically, this is due to the fact
# "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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# PNF Descriptors #
###############################################################################
rameshnaraya
committed
'/pnf_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
description: >
The POST method is used to create a new PNF descriptor resource
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: CreatePnfdInfoRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
description: >
Parameters of creating a PNF descriptor resource.
responses:
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.
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
headers:
Content-Type:
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
rameshnaraya
committed
"The GET method queries information about multiple PNF descriptor
resources."
moscatelli
committed
- name: filter
in: query
required: false
type: string
description: >
Attribute-based filtering expression according to clause 5.2
of ETSI GS NFV-SOL 013.
The NFVO shall support receiving this filtering parameter as part
of the URI query string. The OSS/BSS may supply this parameter.
All attribute names that appear in the PnfdInfo and in data types
referenced from it shall be supported by the NFVO in the filter expression.
moscatelli
committed
- name: all_fields
in: query
required: false
type: string
description: >
Include all complex attributes in the response. See clause 5.3
of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
moscatelli
committed
- name: fields
in: query
required: false
type: string
description: >
Complex attributes to be included into the response. See clause 5.3 of
ETSI GS NFV-SOL 013 for details.
The NFVO should support this parameter.
moscatelli
committed
- name: exclude_fields
in: query
required: false
type: string
description: >
Complex attributes to be excluded from the response. See clause 5.3
of ETSI GS NFV-SOL 013 for details.
The NFVO should support this parameter.
moscatelli
committed
- name: exclude_default
in: query
required: false
type: string
description: >
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support
this parameter.
The following attributes shall be excluded from the PnfdInfo structure in
the response body if this parameter is provided, or none of the parameters
"all_fields"," "fields", "exclude_fields", "exclude_default" are provided:
- userDefinedData
- onboardingFailureDetails
moscatelli
committed
- name: nextpage_opaque_marker
in: query
type: string
required: false
description: >
Marker to obtain the next page of a paged response. Shall be supported by
the NFVO if the NFVO supports alternative 2 (paging) according to clause
5.4.2.1 of ETSI GS NFV SOL 013 for this resource.
moscatelli
committed
description: >
rameshnaraya
committed
200 OK
moscatelli
committed
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.
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
moscatelli
committed
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
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.
moscatelli
committed
type: array
rameshnaraya
committed
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Individual PNF Descriptor #
###############################################################################
rameshnaraya
committed
'/pnf_descriptors/{pnfdInfoId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
parameters:
moscatelli
committed
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor resource.
moscatelli
committed
in: path
moscatelli
committed
type: string
moscatelli
committed
description: >
The GET method reads information about an individual PNF descriptor.
parameters:
moscatelli
committed
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
- name: Accept
in: header
required: true
type: string
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
- name: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request. Details are specified
in clause 4.5.3 of GS NFV-SOL 005.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
description: >
moscatelli
committed
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.
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
rameshnaraya
committed
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
The PATCH method modifies the user defined data of an individual PNF descriptor resource.
parameters:
- name: Accept
in: header
required: true
type: string
moscatelli
committed
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
- name: Content-Type
in: header
required: true
type: string
description: >
The MIME type of the body of the request. This header field
shall be present if the request has a non-empty message body.
- name: PnfdInfoModifications
moscatelli
committed
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
moscatelli
committed
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.
moscatelli
committed
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).
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
moscatelli
committed
type: string
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
delete:
description: >
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.
responses:
204:
description: >
204 NO CONTENT
Shall be returned when the operation
has completed successfully.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
moscatelli
committed
###############################################################################
rameshnaraya
committed
'/pnf_descriptors/{pnfdInfoId}/pnfd_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
parameters:
moscatelli
committed
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor.
This identifier can be retrieved from the resource referenced
by the "Location" HTTP header in the response to a POST request
creating a new PNF descriptor resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
moscatelli
committed
in: path
moscatelli
committed
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
description: >
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.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- name: Range
description: >
The request may contain a "Range" HTTP header to obtain
single range of bytes from the PNFD archive. This can be
used to continue an aborted transmission.
If the NFVO does not support range requests, the NFVO
shall ignore the "Range" header, process the GET request,
and return the whole PNFD archive with a 200 OK response
(rather than returning a 4xx error status code).
in: header
required: false
type: string
moscatelli
committed
description: >
moscatelli
committed
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 response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
moscatelli
committed
type: string
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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
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 response.
type: string
maximum: 1
minimum: 1
Content-Range:
description: >
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
409:
# description: >
# 409 CONFLICT
#
# Shall be returned upon the following error: The
# operation cannot be executed currently, due to a
# conflict with the state of the resource.
# Typically, this is due to the fact pnfdOnboardingState
# has a value different from ONBOARDED.
# The response body shall contain a ProblemDetails
# structure, in which the "detail" attribute shall convey
# more information about the error.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
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.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- name: Content-type
description: >
The request shall set the "Content-Type" HTTP header to "application/zip".
in: header
type: string
enum:
- application/zip
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
202:
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:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
description: >
moscatelli
committed
Shall be returned when the PNFD archive content has been
uploaded and validated successfully.
rameshnaraya
committed
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
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
# description: >
# 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#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# PNFD #
###############################################################################
'/pnf_descriptors/{pnfdInfoId}/pnfd':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7a
parameters:
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor.
This identifier can be retrieved from the resource referenced
by the "Location" HTTP header in the response to a POST request
creating a new PNF descriptor resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
in: path
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
description: >
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:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- name: Range
description: >
The request may contain a "Range" HTTP header to obtain
single range of bytes from the PNFD archive. This can be
used to continue an aborted transmission.
If the NFVO does not support range requests, the NFVO
shall ignore the "Range" header, process the GET request,
and return the whole PNFD archive with a 200 OK response
(rather than returning a 4xx error status code).
in: header
required: false
type: string
- name: include_signatures
description: >
If this parameter is provided, the NFVO shall include in the
ZIP file the security information as specified above.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
in: query
required: false
type: string
responses:
200:
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
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:
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
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
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
###############################################################################
# PNFD Archive Manifest #
###############################################################################
'/pnf_descriptors/{pnfdInfoId}/manifest':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7b
parameters:
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor.
This identifier can be retrieved from the resource referenced
by the "Location" HTTP header in the response to a POST request
creating a new PNF descriptor resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
in: path
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
description: >
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:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: include_signatures
description: >
If this parameter is provided, the NFVO shall return the manifest
and related security information (signature and certificate) either
in a single text file if the signature and certificate are included
in the manifest file, or in a zip file containing the manifest and
the certificate file, if this is provided as a separate file in the
PNFD archive.
If this parameter is not given, the NFVO shall provide only a copy
of the manifest file, as onboarded. If the security information is
included in the onboarded manifest, it shall also be included in
the returned copy.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
in: query
required: false
type: string
responses:
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:
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
enum:
- text/plain
- application/zip
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Subscriptions #
###############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
description: >
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).
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
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: NsdmSubscriptionRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 5.5.2.7.
responses:
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.
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
headers:
Content-Type:
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
303:
# description: >
# 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.
moscatelli
committed
$ref: "../responses/SOL005_resp.yaml#/responses/303"
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
422:
$ref: "../responses/SOL005_resp.yaml#/responses/422"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
description: >
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.
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
AAttribute filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
The NFVO shall support receiving this parameter as part of the URI query string.
the OSS/BSS may supply this parameter.
All attribute names that appear in the NsdmSubscription and in data types referenced
from it shall be supported by the NFVO in the filter expression.
moscatelli
committed
- name: nextpage_opaque_marker
in: query
required: false
type: string
description: >
Marker to obtain the next page of a paged response. Shall be supported by
the NFVO if the NFVO supports alternative 2 (paging) according to clause
5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
moscatelli
committed
in: header
required: true
type: string
moscatelli
committed
description: >
moscatelli
committed
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.
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
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.
moscatelli
committed
type: array
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
moscatelli
committed
###############################################################################
# Individual Subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9
parameters:
moscatelli
committed
- name: subscriptionId
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.
moscatelli
committed
in: path
moscatelli
committed
type: string
- name: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request. Details are specified
in clause 4.5.3 of GS NFV-SOL 005.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
description: >
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:
moscatelli
committed
- name: Accept
in: header
required: true
type: string
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
Shall be returned when information about an individual subscription has been read successfully.
The response body shall contain a representation of the subscription resource.
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
headers:
Content-Type:
moscatelli
committed
type: string
description: >
The MIME type of the body of the response. This header
field shall be present if the response has a non-empty message body.
WWW-Authenticate:
moscatelli
committed
type: string
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.
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/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.
moscatelli
committed
- name: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request.
Details are specified in clause 4.5.3 of GS NFV-SOL 005.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
Shall be returned when the "Individual subscription" resource
has been deleted successfully.
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/responses/400"
$ref: "../responses/SOL005_resp.yaml#/responses/401"
$ref: "../responses/SOL005_resp.yaml#/responses/403"
$ref: "../responses/SOL005_resp.yaml#/responses/404"
$ref: "../responses/SOL005_resp.yaml#/responses/405"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
$ref: "../responses/SOL005_resp.yaml#/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"