NSLifecycleManagementNotification.yaml 15.2 KB
Newer Older
1
openapi: 3.0.2
2
3

info:
4
5
  title: SOL005 - NS Lifecycle Management Notification interface
  description: |
6
7
8
    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.
9
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
10
  license:
11
    name: ETSI Forge copyright notice
12
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
13
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
14
15

externalDocs:
16
  description: ETSI GS NFV-SOL 005 V3.3.1
17
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
18

19
20
21
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
22
23

paths:
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
  /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
          
54
55
    post:
      summary: Notify about NS lifecycle change
56
57
58
59
60
      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.
61
      parameters:
62
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
63
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
64
65
      requestBody:
        $ref: '#/components/requestBodies/NsLcmOperationOccurrenceNotificationRequest'
66
      responses:
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
        "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
83

84
85
86
87
  /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
88
89
    get:
      summary: Test the notification endpoint.
90
91
92
93
      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.
94
      parameters:
95
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
96
      responses:
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
        "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
113

114
115
    post:
      summary: Notify about NS lifecycle change
116
117
118
119
120
121
      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.
122
      parameters:
123
124
125
126
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsIdentifierCreationNotificationRequest'
127
      responses:
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
        "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
144

145
146
147
148
  /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
149
150
    get:
      summary: Test the notification endpoint.
151
      description: |
152
        Query NS Instances.
153
154
155
        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.
156
      parameters:
157
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
158
      responses:
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
        "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
175
176
177

    post:
      summary: Notify about NS lifecycle change
178
179
180
181
182
183
      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.
184
      parameters:
185
186
187
188
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsIdentifierDeletionNotificationRequest'
189
      responses:
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
        "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:
215
            $ref: ./definitions/SOL005NSLifecycleManagementNotification_def.yaml#/definitions/NsLcmOperationOccurrenceNotification
216
      required: true
217

218
219
220
221
222
223
224
225
    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
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
    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: {}
281

282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
    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: {}
303

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: {}