Newer
Older
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
moscatelli
committed
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
moscatelli
committed
required: true
moscatelli
committed
type: string
rameshnaraya
committed
description: >
rameshnaraya
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
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:
type: "object"
properties:
PnfdInfo:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
rameshnaraya
committed
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
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: Delete an individual PNF descriptor resource.
rameshnaraya
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.
rameshnaraya
committed
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
description: >
204 No Content
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
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.
rameshnaraya
committed
description: >
The PATCH method modifies the user defined data of an individual PNF descriptor resource.
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
- 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.
moscatelli
committed
- 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
- 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.
200 OK
The operation was completed successfully.
The response body shall contain attribute
modifications for an 'Individual PNF Descriptor' resource.
schema:
type: "object"
properties:
PnfdInfoModifications:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
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.
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"
rameshnaraya
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:
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
###############################################################################
# PNFD Content #
###############################################################################
'/pnf_descriptors/{pnfdInfoId}/pnfd_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
parameters:
- name: "pnfdInfoId"
description: >
Identifier of the individual PNF descriptor.
in: "path"
required: true
type: "string"
summary: Fetch the content of a PNFD.
rameshnaraya
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.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
rameshnaraya
committed
type: string
enum:
- text/plain
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
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
rameshnaraya
committed
description: >
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:
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:
$ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-ONBOARDED"
rameshnaraya
committed
412:
$ref: "responses/SOL005_resp.yaml#/responses/412"
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: Upload the content of a PNFD.
rameshnaraya
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.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
rameshnaraya
committed
type: string
enum:
- text/plain
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
rameshnaraya
committed
description: >
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
###############################################################################
# Subscriptions #
###############################################################################
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
summary: Query multiple subscriptions.
rameshnaraya
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.
This resource represents subscriptions.
The client can use this resource to subscribe to notifications related to NSD
management and to query its subscriptions.
rameshnaraya
committed
- name: "filter"
in: "query"
required: false
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.
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
description: >
200 OK
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
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
rameshnaraya
committed
schema:
type: "array"
items:
properties:
NsdmSubscription:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
rameshnaraya
committed
description: >
rameshnaraya
committed
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
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: Subscribe to NSD and PNFD change notifications.
rameshnaraya
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
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
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: 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
moscatelli
committed
- 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.
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.
type: "object"
properties:
NsdmSubscription:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"
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.
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
###############################################################################
# Individual Subscription #
###############################################################################
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9
parameters:
- name: "subscriptionId"
description: Identifier of this subscription.
in: "path"
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.
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
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:
- 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.
moscatelli
committed
- 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.
type: "object"
properties:
NsdmSubscription:
$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
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
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: 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.
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.
parameters:
- 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.
moscatelli
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
The subscription resource was deleted successfully.
The response body shall be empty.
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
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:
$ref: "responses/SOL005_resp.yaml#/responses/412"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$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.
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:
$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: >
The notification was delivered successfully.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
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"
'/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.
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:
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: >
204 No Content
The notification was delivered successfully.
headers:
WWW-Authenticate:
description: >
Challenge if the corresponding HTTP request has not provided
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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
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"
'/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.
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:
properties:
NsdChangeNotification:
$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: 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.