Newer
Older
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
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"