Newer
Older
openapi: 3.0.2
title: SOL005 - NS Performance Management Notification interface
description: |
SOL005 - NS Performance Management Notification interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to. In case of
discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
contact:
name: NFV-SOL WG
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
description: ETSI GS NFV-SOL 005 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
servers:
- url: http://127.0.0.1/callback/v2
- url: https://127.0.0.1/callback/v2
paths:
##################################################################################
# Notification endpoint PerformanceInformationAvailableNotification #
##################################################################################
/URI_is_provided_by_the_client_when_creating_the_subscription_PerformanceInformationAvailableNotificatio:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
post:
summary: Notify about PM related events
description: |
Samir Medjiah
committed
The POST method delivers a notification regarding a performance management event
from the API producer to an API consumer. The API consumer shall have previously
created an "Individual PM job resource" or "Individual threshold resource".
This method shall follow the provisions specified in the
Samir Medjiah
committed
Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, request and response
data strctures, and response codes.
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/PerformanceInformationAvailableNotification'
$ref: '#/components/responses/PerformanceInformationAvailableNotification.Post.204'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint
description: |
The GET method allows the API producer to test the notification
endpoint that is provided by the API consumer, e.g. during
creation of the PM job or threshold resource.
This method shall follow the provisions specified in the
Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
responses:
204:
$ref: '#/components/responses/PerformanceInformationAvailableNotification.Get.204'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
##################################################################################
# Notification endpoint ThresholdCrossedNotification #
##################################################################################
/URI_is_provided_by_the_client_when_creating_the_subscription_ThresholdCrossedNotification:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
post:
summary: Notify about PM related events
description: |
Samir Medjiah
committed
The POST method delivers a notification regarding a performance management event
from the API producer to an API consumer. The API consumer shall have previously
created an "Individual PM job resource" or "Individual threshold resource".
This method shall follow the provisions specified in the
Samir Medjiah
committed
Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, request and response
data strctures, and response codes.
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/ThresholdCrossedNotification'
$ref: '#/components/responses/ThresholdCrossedNotification.Post.204'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
get:
summary: Test the notification endpoint
description: |
The GET method allows the API producer to test the notification
endpoint that is provided by the API consumer, e.g. during
creation of the PM job or threshold resource.
This method shall follow the provisions specified in the
Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
responses:
204:
$ref: '#/components/responses/ThresholdCrossedNotification.Get.204'
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
components:
requestBodies:
PerformanceInformationAvailableNotification:
description: |
Notification about performance information availability.
content:
application/json:
schema:
$ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/PerformanceInformationAvailableNotification"
required: true
ThresholdCrossedNotification:
description: |
Notification about threshold crossing.
content:
application/json:
schema:
$ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/ThresholdCrossedNotification"
required: true
responses:
PerformanceInformationAvailableNotification.Post.204:
description: |
204 NO CONTENT
Shall be returned when 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.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
PerformanceInformationAvailableNotification.Get.204:
description: |
204 NO CONTENT
Shall be returned to indicate that the notification endpoint has been
tested successfully.
The response body shall be empty.
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.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
ThresholdCrossedNotification.Post.204:
description: |
204 NO CONTENT
Shall be returned when 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.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
ThresholdCrossedNotification.Get.204:
description: |
204 NO CONTENT
Shall be returned to indicate that the notification endpoint has been
tested successfully.
The response body shall be empty.
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.
style: simple
explode: false
schema:
type: string
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string