Newer
Older
rameshnaraya
committed
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# 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
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
- 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:
moscatelli
committed
type: object
properties:
PnfdInfo:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
rameshnaraya
committed
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
summary: Delete an individual PNF descriptor resource.
moscatelli
committed
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.
moscatelli
committed
description: >
rameshnaraya
committed
204 No Content
moscatelli
committed
rameshnaraya
committed
The operation has completed successfully.
The response body shall be empty.
206:
$ref: "responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
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.
moscatelli
committed
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
parameters:
- 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: 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: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request. Details are specified in clause 4.5.3.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: body
in: body
required: true
schema:
type: object
required:
- PnfdInfoModifications
properties:
PnfdInfoModifications:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
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.
moscatelli
committed
type: object
properties:
PnfdInfoModifications:
moscatelli
committed
$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
206:
$ref: "responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$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
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
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- 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: >
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
206:
$ref: "responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-ONBOARDED"
rameshnaraya
committed
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- 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: >
moscatelli
committed
rameshnaraya
committed
The PNFD content was successfully uploaded and validated.
The response body shall be empty.
206:
$ref: "responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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"
$ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-CREATED"
rameshnaraya
committed
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
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
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 parameters according to clause 4.3.2.
The NFVO shall support receiving attribute filter parameters as part of the URI query
string. The OSS/BSS may supply an attribute filter.
All attribute names that appear in the NsdmSubscription and in data types referenced
from it shall be supported in attribute filter parameters.
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.
Reference: IETF RFC 7231
in: header
required: true
type: string
- 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
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:
moscatelli
committed
type: array
items:
properties:
NsdmSubscription:
moscatelli
committed
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
moscatelli
committed
description: >
rameshnaraya
committed
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
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.
206:
$ref: "responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
rameshnaraya
committed
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
summary: Subscribe to NSD and PNFD change notifications.
moscatelli
committed
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and response data structures,
rameshnaraya
committed
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
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
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: body
in: body
required: true
schema:
type: object
required:
- NsdmSubscriptionRequest
properties:
NsdmSubscriptionRequest:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 5.5.2.7.
moscatelli
committed
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.
moscatelli
committed
type: object
properties:
NsdmSubscription:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
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.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
206:
$ref: "responses/SOL005_resp.yaml#/responses/206"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# 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
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
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
- 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
200 OK
The operation has completed successfully.
The response body shall contain a representation of
the subscription resource.
moscatelli
committed
type: object
moscatelli
committed
$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
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$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.
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
412:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
##################################################################################
# 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
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:
properties:
NsdOnBoardingNotification:
moscatelli
committed
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
moscatelli
committed
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
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.
moscatelli
committed
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-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$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
post:
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.
- name: NsdOnBoardingFailureNotification
description: >
A notification about the failure of on-boarding an NSD.
in: body
required: true
schema:
properties:
moscatelli
committed
NsdOnBoardingFailureNotification:
$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: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
moscatelli
committed
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
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
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
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/NSDescriptorManagement_resp.yaml#/responses/409"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsdChangeNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10
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.