VirtualisedResourcesQuotaAvailableNotification.yaml 17.7 KB
Newer Older
Samir Medjiah's avatar
Samir Medjiah committed
1
openapi: 3.0.2
2
3

info:
4
  title: SOL003 - Virtualised Resources Quota Available Notification interface
Samir Medjiah's avatar
Samir Medjiah committed
5
  description: |
6
7
    SOL003 - Virtualised Resources Quota Available Notification interface 

8
    IMPORTANT: Please note that this file might be not aligned to the current
9
10
11
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
13

Samir Medjiah's avatar
Samir Medjiah committed
14
15
  contact:
    name: NFV-SOL WG
16
  license:
Samir Medjiah's avatar
Samir Medjiah committed
17
    name: ETSI Forge copyright notice
18
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Samir Medjiah's avatar
Samir Medjiah committed
19
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
20
21

externalDocs:
22
23
  description: ETSI GS NFV-SOL 003 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf
24

Samir Medjiah's avatar
Samir Medjiah committed
25
26
27
servers:
  - url: http://127.0.0.1/vrqan/v1
  - url: https://127.0.0.1/vrqan/v1
28
29

paths:
30
31
32
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
Samir Medjiah's avatar
Samir Medjiah committed
33
  /api_versions:
34
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
35

36
37
38
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
Samir Medjiah's avatar
Samir Medjiah committed
39
40
41
42
  /subscriptions:
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
43
    post:
Samir Medjiah's avatar
Samir Medjiah committed
44
      description: |
45
        The POST method creates a new subscription. See clause 11.4.2.3.1.
46
      parameters:
Samir Medjiah's avatar
Samir Medjiah committed
47
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
Samir Medjiah's avatar
Samir Medjiah committed
48
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
Samir Medjiah's avatar
Samir Medjiah committed
49
50
      requestBody:
        $ref: '#/components/requestBodies/VrQuotaAvailSubscriptionRequest'
51
52
      responses:
        201:
Samir Medjiah's avatar
Samir Medjiah committed
53
          $ref: '#/components/responses/Subscriptions.Post.201'
54
        303:
55
          $ref: '#/components/responses/Subscriptions.Post.303'
56
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
57
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
58
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
59
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
60
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
61
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
62
        404:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
63
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
64
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
65
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
66
        422:
67
          $ref: '#/components/responses/Subscriptions.Post.422'
68
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
69
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
70
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
71
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
72
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
73
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
74
        504:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
75
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
76

77
    get:
Samir Medjiah's avatar
Samir Medjiah committed
78
      description: |
79
        The GET method queries the list of active subscriptions of the functional block that invokes the method.
80
        It can be used e.g. for resynchronization after error situations. See clause 11.4.2.3.2.
Gergely Csatari's avatar
Gergely Csatari committed
81
      parameters:
Samir Medjiah's avatar
Samir Medjiah committed
82
83
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
84
      responses:
85
        200:
Samir Medjiah's avatar
Samir Medjiah committed
86
          $ref: '#/components/responses/Subscriptions.Get.200'
87
        204:
Samir Medjiah's avatar
Samir Medjiah committed
88
          $ref: '#/components/responses/Subscriptions.Get.204'
89
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
90
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
91
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
92
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
93
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
94
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
95
        404:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
96
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
97
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
98
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
99
        422:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
100
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
101
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
102
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
103
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
104
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
105
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
106
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
107
        504:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
108
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
109

110
111
112
###############################################################################
# Individual subscription                                                     #
###############################################################################
Samir Medjiah's avatar
Samir Medjiah committed
113
  /subscriptions/{subscriptionId}:
114
    parameters:
Samir Medjiah's avatar
Samir Medjiah committed
115
116
117
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
118
    get:
Samir Medjiah's avatar
Samir Medjiah committed
119
      description: |
120
        The GET method reads an individual subscription. See clause 11.4.3.3.2.
121
122
      responses:
        200:
Samir Medjiah's avatar
Samir Medjiah committed
123
          $ref: '#/components/responses/IndividualSubscription.Get.200'
124
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
125
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
126
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
127
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
128
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
129
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
130
        404:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
131
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
132
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
133
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
134
        422:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
135
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
136
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
137
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
138
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
139
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
140
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
141
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
142
        504:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
143
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
144

145
    delete:
Samir Medjiah's avatar
Samir Medjiah committed
146
      description: |
147
        The DELETE method terminates an individual subscription. See clause 11.4.3.3.5.
148
149
      responses:
        204:
Samir Medjiah's avatar
Samir Medjiah committed
150
          $ref: '#/components/responses/IndividualSubscription.Delete.204'
151
        400:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
152
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
153
        401:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
154
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
155
        403:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
156
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
157
        404:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
158
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
159
        405:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
160
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
161
        422:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
162
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
163
        406:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
164
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
165
        500:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
166
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
167
        503:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
168
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
169
        504:
Samir Medjiah's avatar
Samir Medjiah committed
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
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"


components:
  parameters:
    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
        Identifier of this subscription.
        This identifier can be retrieved from the resource referenced by the
        "Location" HTTP header in the response to a POST request creating a
        new "Individual subscription" resource. It can also be retrieved from the "id"
        attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

  requestBodies:
    VrQuotaAvailSubscriptionRequest:
      description: |
        Details of the subscription to be created.
      content:
        application/json:
          schema:
197
            $ref: "./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest"
Samir Medjiah's avatar
Samir Medjiah committed
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
      required: true


  responses:
    Subscriptions.Post.201:
      description: |
        201 CREATED

        Shall be returned when the subscription has been created successfully.
        The response body shall contain a representation of the created "Individual subscription" resource.
        The HTTP response shall include a "Location" HTTP header that points to the created resource.
      headers:
        Version:
          description: |
            The used API version.
          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-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            The resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
243
            $ref: ./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription
Samir Medjiah's avatar
Samir Medjiah committed
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
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
    Subscriptions.Post.303:
      description: |
        303 See Other

        Shall be returned when a subscription with
        the same callback URI and the same filter
        already exists 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 "Individual
        subscription" resource.
        The response body shall be empty.
      headers:
        Version:
          description: |
            The used API version.
          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-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            The resource URI of the created VNF instance
          style: simple
          explode: false
          schema:
            type: string
            format: url

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Entity

        Shall be returned upon the following error:
        The content type of the payload body is
        supported and the payload body of a
        request contains syntactically correct data
        but the data cannot be processed.
        The general cause for this error and its
        handling is specified in clause 6.4 of ETSI
        GS NFV-SOL 013 [8], including rules for
        the presence of the response body.
        Specifically in case of this resource, the
        response code 422 shall also be returned
        if the NFVO has tested the Notification
        endpoint as described in clause 11.4.4.3.2
        and the test has failed.
        In this case, the "detail" attribute in the
        "ProblemDetails" structure shall convey
        more information about the error
      headers:
        Version:
          description: |
            The used API version.
          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-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
337
            $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
338

Samir Medjiah's avatar
Samir Medjiah committed
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
    Subscriptions.Get.200:
      description: |
        200 OK

        Shall be returned when the list of subscriptions has been queried successfully.
        The response body shall contain in an array the representations of all active
        subscriptions of the functional block that invokes the method, i.e. zero or more
        representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3.
        If the "filter" URI parameter was supplied in the request, the data in the response body shall
        have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
        If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
        for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
        in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: |
            The used API version.
          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-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
387
              $ref: ./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription
Samir Medjiah's avatar
Samir Medjiah committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
    
    Subscriptions.Get.204:
      description: |
        No Content

        The notification endpoint was tested successfully.
        The response body shall be empty.
      headers:
        Version:
          description: |
            The used API version.
          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

    IndividualSubscription.Get.200:
      description: | 
        200 OK

        Shall be returned when information about an individual subscription has been read successfully.
        The response body shall contain a representation of the "Individual subscription" resource.
      headers:
        Version:
          description: |
            The used API version.
          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-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
444
            $ref: ./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription
Samir Medjiah's avatar
Samir Medjiah committed
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473

    IndividualSubscription.Delete.204:
      description: | 
        No Content

        Shall be returned when the "Individual subscription" resource has been deleted successfully.
      headers:
        Version:
          description: |
            The used API version.
          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-Type:
          description: |
            The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string