Newer
Older
openapi: 3.0.2
title: SOL005 - NS Lifecycle Management Notification interface
description: |
SOL005 - NS Lifecycle 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
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://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL005ed331_Os-Ma-nfvo_APIs_-_spec/NFV-SOL005ed331v304.zip
servers:
- url: http://127.0.0.1/callback/v1
- url: https://127.0.0.1/callback/v1
/URI_is_provided_by_the_client_when_creating_the_subscription-NsLcmOperationOccurrenceNotification:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
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 subscription. This method shall follow the provisions specified in the Tables 6.4.18.3.2-1 and
6.4.18.3.2-2 for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
"204":
$ref: '#/components/responses/NsLcmOperationOccurrenceNotification.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
post:
summary: Notify about NS lifecycle change
description: |
The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have
previously created an "Individual subscription" resource with a matching filter. This method shall follow the
provisions specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2 for URI query parameters, request and response
data structures, and response codes.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsLcmOperationOccurrenceNotificationRequest'
"204":
$ref: '#/components/responses/NsLcmOperationOccurrenceNotification.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierCreationNotification:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
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 subscription. This method shall follow the provisions specified in the Tables 6.4.18.3.2-1 and
6.4.18.3.2-2 for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
"204":
$ref: '#/components/responses/NsIdentifierCreationNotification.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
post:
summary: Notify about NS lifecycle change
description: |
The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription" resource
with a matching filter. This method shall follow the provisions specified in the
Tables 6.4.18.3.1-1 and 6.4.18.3.1-2 for URI query parameters, request and response
data structures, and response codes.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsIdentifierCreationNotificationRequest'
"204":
$ref: '#/components/responses/NsIdentifierCreationNotification.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierDeletionNotification:
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
get:
summary: Test the notification endpoint.
description: |
Query NS Instances.
The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
e.g. during subscription. This method shall follow the provisions specified in the Tables 6.4.18.3.2-1 and
6.4.18.3.2-2 for URI query parameters, request and response data structures, and response codes.
parameters:
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
"204":
$ref: '#/components/responses/NsIdentifierDeletionNotification.Get'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
post:
summary: Notify about NS lifecycle change
description: |
The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription" resource
with a matching filter. This method shall follow the provisions specified in the
Tables 6.4.18.3.1-1 and 6.4.18.3.1-2 for URI query parameters, request and response
data structures, and response codes.
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
requestBody:
$ref: '#/components/requestBodies/NsIdentifierDeletionNotificationRequest'
"204":
$ref: '#/components/responses/NsIdentifierDeletionNotification.Post'
"400":
$ref: ../responses/SOL005_resp.yaml#/components/responses/400
"401":
$ref: ../responses/SOL005_resp.yaml#/components/responses/401
"403":
$ref: ../responses/SOL005_resp.yaml#/components/responses/403
"405":
$ref: ../responses/SOL005_resp.yaml#/components/responses/405
"406":
$ref: ../responses/SOL005_resp.yaml#/components/responses/406
"500":
$ref: ../responses/SOL005_resp.yaml#/components/responses/500
"503":
$ref: ../responses/SOL005_resp.yaml#/components/responses/503
components:
requestBodies:
NsLcmOperationOccurrenceNotificationRequest:
description: |
A notification about lifecycle changes triggered by a NS LCM. operation occurrence.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagementNotification_def.yaml#/definitions/NsLcmOperationOccurrenceNotification
required: true
NsIdentifierCreationNotificationRequest:
description: |
A notification about the creation of a NS identifier and the related NS instance resource.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagementNotification_def.yaml#/definitions/NsIdentifierCreationNotification
required: true
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
NsIdentifierDeletionNotificationRequest:
description: |
A notification about the deletion of a NS identifier and the related NS instance resource.
content:
application/json:
schema:
$ref: ./definitions/SOL005NSLifecycleManagementNotification_def.yaml#/definitions/NsIdentifierDeletionNotification
required: true
responses:
NsLcmOperationOccurrenceNotification.Get:
description: |
204 No Content
Shall be returned when the notification endpoint has been tested successfully.
The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}
NsLcmOperationOccurrenceNotification.Post:
description: |
204 No Content
Shall be returned when the notification has been delivered successfully.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}
NsIdentifierCreationNotification.Get:
description: |
204 No Content
Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
NsIdentifierCreationNotification.Post:
description: |
204 No Content
Shall be returned when the notification has been delivered successfully.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}
NsIdentifierDeletionNotification.Get:
description: |
204 No Content
Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}
NsIdentifierDeletionNotification.Post:
description: |
204 No Content
Shall be returned when the notification has been delivered successfully.
headers:
Version:
description: |
Version of the API used in the response.
style: simple
explode: false
schema:
type: string
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
content: {}