Newer
Older
rameshnaraya
committed
version: 1.0.0
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/bugzilla/buglist.cgi?component=Nfv-Openapis
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli
committed
contact:
rameshnaraya
committed
externalDocs:
description: ETSI GS NFV-SOL 005 V2.4.1
rameshnaraya
committed
url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
rameshnaraya
committed
schemes:
moscatelli
committed
- https
moscatelli
committed
###############################################################################
# NS Descriptors #
###############################################################################
rameshnaraya
committed
'/ns_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
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:
summary: Create a new NS descriptor resource.
description: >
The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor.
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
An NS descriptor resource was created successfully, as a new NS descriptor resource.
The response body shall contain a representation of the new 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 new NS descriptor resource.
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"
summary: Query information about multiple NS descriptor resources.
moscatelli
committed
description: >
The GET method queries information about multiple NS descriptor resources.
This method shall follow the provisions specified in the
rameshnaraya
committed
Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters,
moscatelli
committed
request and response data structures, and response codes.
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Attribute-based filtering expression according to clause 4.3.2.
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 4.3.3 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 4.3.3 for
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 4.3.3 for
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 4.3.3 for details.
The VNFM 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.
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 4.7.2.1 for this resource.
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
Information about zero or more NS descriptors.
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 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.
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"
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
summary: Read information about an individual NS descriptor resource.
moscatelli
committed
description: >
The GET method reads information about an individual NS descriptor.
rameshnaraya
committed
This method shall follow the provisions specified in GS NFV-SOL 005 Tables
5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,
moscatelli
committed
request and response data structures, and response codes.
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
Information about the individual NS descriptor.
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"
summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
moscatelli
committed
description: >
The PATCH method modifies the operational state and/or user defined
rameshnaraya
committed
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 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 changes a result.
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.
- 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
The operation was 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: >
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"
moscatelli
committed
summary: Delete an individual NS descriptor resource.
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: >
moscatelli
committed
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: >
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"
moscatelli
committed
###############################################################################
# NSD Content #
###############################################################################
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.
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
rameshnaraya
committed
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.NOTE: The structure
of the NSD zip file is outside the scope of the present document.
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 file. 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 NSD file with a 200 OK response (rather than returning a 4xx
error status code)."
moscatelli
committed
description: >
moscatelli
committed
On success, the content of the NSD is returned.
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, i.e. to
"text/plain" for a YAML file or to "application/zip" for a
ZIP file.
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: >
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"
$ref: "../responses/SOL005_resp.yaml#/responses/406"
description: >
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: >
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"
moscatelli
committed
moscatelli
committed
description: >
rameshnaraya
committed
"The PUT method is used to upload the content of a NSD. The NSD
to be uploaded can be implemented as a single file or as a collection of
multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005.
If the NSD is implemented in the form of multiple files, a ZIP file embedding these
files shall be uploaded.
If the NSD is implemented as a single file, either that file or a ZIP file
embedding that file shall be uploaded. The "Content-Type"
rameshnaraya
committed
HTTP header in the PUT request shall be set accordingly based on the format
selection of the NSD.
If the NSD to be uploaded is a text file, the "Content-Type"
header is set to "text/plain".
If the NSD to be uploaded is a zip file,
the "Content-Type" header is 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
rameshnaraya
committed
of GS-NFV-SOL 005 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.
The payload body contains a copy of the file representing the NSD
or a ZIP file that contains the file or multiple files representing the NSD.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
moscatelli
committed
description: >
moscatelli
committed
The NSD content was 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.
moscatelli
committed
The client 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 was successfully uploaded and validated (synchronous mode).
The response body shall be empty.
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"
description: >
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.
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"
moscatelli
committed
###############################################################################
# PNF Descriptors #
###############################################################################
rameshnaraya
committed
'/pnf_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
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:
summary: Create a new PNF descriptor resource.
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
A PNF descriptor resource was created successfully, as a new PNF descriptor resource.
The response body shall contain a representation of
the new 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 new
PNF descriptor resource.
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"
summary: Query information about multiple PNF descriptor resources.
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 4.3.2.
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
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
- name: all_fields
in: query
required: false
type: string
description: >
Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter.
- name: fields
in: query
required: false
type: string
description: >
Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter.
- name: exclude_fields
in: query
required: false
type: string
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter.
- name: exclude_default
in: query
required: false
type: string
description: >
Indicates to exclude the following complex attributes from the response. See
clause 4.3.3 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.
- 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 4.7.2.1 for this resource.
moscatelli
committed
description: >
rameshnaraya
committed
200 OK
moscatelli
committed
rameshnaraya
committed
Information about zero or more PNF descriptors.
The response body shall contain a representation of
zero or more PNF descriptors, as defined in
clause 5.5.2.2
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"
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
summary: Read an individual PNFD resource.
moscatelli
committed
description: >
The GET method reads information about an individual PNF descriptor.
rameshnaraya
committed
This method shall follow the provisions specified in the Tables 5.4.6.3.2-1
and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and
response data structures, and response codes.
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.
- 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
Information about the individual PNFD descriptor.
rameshnaraya
committed
The response body shall contain a representation of
the individual PNF descriptor.
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"
patch:
summary: Modify the user defined data of an individual PNF descriptor resource.
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.
moscatelli
committed
The operation was 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"
moscatelli
committed
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
delete:
summary: Delete an individual PNF descriptor resource.
description: >
The DELETE method deletes an individual PNF descriptor resource.
An individual PNF descriptor resource can only be deleted when there 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 the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find
all versions of the PNFD.
Then, the client uses the DELETE method described in this clause to delete each PNFD version individually.
responses:
204:
description: >
204 NO CONTENT
The operation has completed successfully.
The response body shall be empty.
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"
moscatelli
committed
###############################################################################
# PNFD Content #
###############################################################################
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.
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
summary: Fetch the content of a PNFD.
moscatelli
committed
description: >
The GET method fetches the content of the PNFD.
This method shall follow the provisions specified in the
Table 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
moscatelli
committed
description: >
moscatelli
committed
rameshnaraya
committed
On success, the content of the PNFD is returned. The payload
body shall contain a copy of the file representing the PNFD.
The Content-Type" HTTP header shall be set to "text/plain".
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
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: >
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"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
summary: Upload the content of a PNFD.
moscatelli
committed
description: >
The PUT method is used to upload the content of a PNFD.
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
moscatelli
committed
description: >
moscatelli
committed
rameshnaraya
committed
The PNFD content was successfully uploaded and validated.
The response body shall be empty.
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"
description: >
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.
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"
moscatelli
committed
###############################################################################
# Subscriptions #
###############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
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
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:
summary: Subscribe to NSD and PNFD change notifications.
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
of GS-NFV SOL 005. Creation of two subscription resources with the same
callbackURI 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 callbackUri 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
callbackUri).
This resource represents subscriptions.
The client can use this resource to subscribe to notifications related to NSD
management and to query its subscriptions.
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
The subscription was created successfully.
The response body shall contain a representation of the created subscription resource.
The HTTP response shall include a "Location:"
HTTP header that points to the created subscription resource.
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: >
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"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
summary: Query multiple subscriptions.
moscatelli
committed
description: >
The GET method queries the list of active subscriptions of the
rameshnaraya
committed
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.
moscatelli
committed
This resource represents subscriptions.
The client can use this resource to subscribe to notifications related to NSD
management and to query its subscriptions.
moscatelli
committed
- name: filter
in: query
rameshnaraya
committed
required: false
moscatelli
committed
type: string
description: >
Attribute filtering expression according to clause 4.3.2.
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 4.7.2.1 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
rameshnaraya
committed
The list of subscriptions was queried successfully.
The response body shall contain the representations of
all active subscriptions of the functional block that
invokes the method.
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"
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.
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
summary: Read an individual subscription resource.
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.
200 OK
The operation has completed 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"
summary: Terminate Subscription
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 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
The subscription resource was deleted successfully.
The response body shall be empty.
$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"
moscatelli
committed
##################################################################################
# Notification endpoint #
# Dummy URI is used for testing. #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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
summary: Notify about NSD and PNFD changes
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
- name: NsdOnBoardingNotification
description: >
A notification about the successful on-boarding of an NSD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
in: header
required: true
moscatelli
committed
type: string
moscatelli
committed
description: >
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
204 NO CONTENT
The notification was delivered 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"
get:
summary: Test the notification endpoint
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
Reference: IETF RFC 7231.
moscatelli
committed
in: header
required: true
type: string
responses:
204:
description: >
moscatelli
committed
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
The notification endpoint was tested 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
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"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingFailureNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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:
summary: Notify about NSD and PNFD changes
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
- name: NsdOnBoardingFailureNotification
description: >
A notification about the failure of on-boarding an NSD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingFailureNotification"
- 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
responses:
204:
description: >
204 NO CONTENT
The notification was delivered 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"
get:
summary: Test the notification endpoint
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
204:
description: >
204 NO CONTENT
The notification endpoint was tested 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
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"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdChangeNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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:
summary: Notify about NSD and PNFD changes
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
- name: NsdChangeNotification
description: >
A notification about the state change of an on-boarded NSD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdChangeNotification"
- 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
responses:
204:
description: >
204 NO CONTENT
The notification was delivered 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"
get:
summary: Test the notification endpoint
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
204:
description: >
204 NO CONTENT
The notification endpoint was tested 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
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"
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdDeletionNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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:
summary: Notify about NSD and PNFD changes
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
- name: NsdDeletionNotification
description: >
A notification about the deletion of an on-boarded NSD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdDeletionNotification"
- 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
responses:
204:
description: >
204 NO CONTENT
The notification was delivered successfully.
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
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"
moscatelli
committed
get:
summary: Test the notification endpoint
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
204:
description: >
moscatelli
committed
The notification endpoint was tested 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.
maximum: 1
moscatelli
committed
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"
'/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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:
summary: Notify about NSD and PNFD changes
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
A notification about the successful on-boarding of a PNFD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
moscatelli
committed
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
moscatelli
committed
The notification was delivered successfully.
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.
maximum: 1
moscatelli
committed
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"
get:
summary: Test the notification endpoint
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
moscatelli
committed
in: header
required: true
type: string
responses:
204:
description: >
moscatelli
committed
The notification endpoint was tested successfully.
The response body shall be empty.
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
$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"
'/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingFailureNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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:
summary: Notify about NSD and PNFD changes
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
- name: PnfdOnBoardingFailureNotification
A notification about the failure of on-boarding a PNFD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingFailureNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
moscatelli
committed
in: header
required: true
type: string
responses:
204:
description: >
moscatelli
committed
The notification was delivered successfully.
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.
maximum: 1
moscatelli
committed
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"
get:
summary: Test the notification endpoint
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
moscatelli
committed
in: header
required: true
type: string
responses:
204:
description: >
moscatelli
committed
The notification endpoint was tested successfully.
The response body shall be empty.
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
$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"
'/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdDeletionNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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:
summary: Notify about NSD and PNFD changes
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Table 5.4.10.3.1-2.
parameters:
- name: PnfdDeletionNotification
description: >
A notification about the deletion of an on-boarded PNFD.
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdDeletionNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
moscatelli
committed
in: header
required: true
type: string
responses:
204:
description: >
204 No Content
moscatelli
committed
The notification was delivered successfully.
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.
maximum: 1
moscatelli
committed
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"
moscatelli
committed
get:
summary: Test the notification endpoint
description: >
This resource represents a notification endpoint. The server can use
this resource to send notifications to a subscribed
client, which has provided the URI of this resource during the subscription process.
moscatelli
committed
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
This method shall follow the provisions specified in the Table 5.4.10.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.
Reference: IETF RFC 7231.
in: header
required: true
type: string
responses:
204:
description: >
moscatelli
committed
The notification endpoint was tested 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.
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"