NFVICapacityInformation.yaml 21.3 KB
Newer Older
1
2
3
4
5
6
openapi: 3.0.2

info:
  title: SOL005 - NFVI Capacity Information Interface
  description: |
    SOL005 - NFVI Capacity Information Interface
7
8
9
10
11

    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.

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

14
15
16
17
18
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
19
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
20
21

externalDocs:
22
  description: ETSI GS NFV-SOL 005 V3.5.1
23
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

servers:
  - url: http://127.0.0.1/nfvici/v1
  - url: https://127.0.0.1/nfvici/v1

paths:
  /api_versions:
    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions

  /nfvi_capacity_infos:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
      description: |
39
        The API consumer can use this method to retrieve information about NFVI capacity information. See clause 10.4.2.3.2.
40
41
42
43
44
45
46
47
48
49
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
50
          $ref: '#/components/responses/NfviCapacityInfos.Get.200'
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "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
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

  /nfvi_capacity_infos/{vimId}:
    parameters:
      - $ref: '#/components/parameters/VimId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
      description: |
77
        The API consumer can use this method for reading an individual VIM's NFVI capacity information. See clause 10.4.3.3.2.
78
79
80
81
82
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
83
          $ref: '#/components/responses/NfviCapacityInfo.Get.200'
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "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
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

  /capacity_thresholds:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
      description: |
109
        The API consumer can use this method to query information about NFVI capacity thresholds. See clause 10.4.4.3.2
110
111
112
113
114
115
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
116
          $ref: '#/components/responses/CapacityThresholds.Get.200'
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "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
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

    post:
      description: |
138
        The POST method creates a new NFVI capacity threshold. See clause 10.4.4.3.1.
139
140
141
142
143
144
145
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NfviCapacityThresholdRequest'
      responses:
        "201":
Giacomo Bernini's avatar
Giacomo Bernini committed
146
          $ref: '#/components/responses/CapacityThresholds.Post.201'
147
148
149
150
151
152
153
154
155
156
157
158
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
159
160
        "422":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/422
161
162
163
164
165
166
167
168
169
170
171
172
173
174
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

  /capacity_thresholds/{capacityThresholdId}:
    parameters:
      - $ref: '#/components/parameters/CapacityThresholdId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
      description: |
175
        The API consumer can use this method for reading information about an NFVI capacity threshold. See clause 10.4.5.3.2.
176
177
178
179
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
180
          $ref: '#/components/responses/IndividualCapacityThreshold.Get.200'
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "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
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

200
201
    patch:
      description: |
202
        This method allows to modify an "Individual capacity threshold" resource. See clause 10.4.5.3.4.
203
204
205
206
      requestBody:
        $ref: '#/components/requestBodies/IndividualNfviCapacityThresholdRequest'
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
207
          $ref: '#/components/responses/IndividualCapacityThreshold.Patch.200'
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "412":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/412
        "422":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/422
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

231
232
    delete:
      description: |
233
        This method allows to delete an NFVI capacity threshold. See clause 10.4.5.3.5.
234
235
      responses:
        "204":
Giacomo Bernini's avatar
Giacomo Bernini committed
236
          $ref: '#/components/responses/IndividualCapacityThreshold.Delete.204'
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
282
283
284
285
286
287
288
289
290
291
292
293
294
        "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
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "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
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

components:
  parameters:
    VimId:
      name: vimId
      in: path
      description: |
        Identifier of the VIM with associated NFVI capacity information.
        This identifier can be retrieved from the "vimId" attribute in the CapacityShortageNotification.
        It can also be retrieved from the "vimId" attribute in the payload body of the response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    CapacityThresholdId:
      name: capacityThresholdId
      in: path
      description: |
        Identifier of the capacity threshold.
        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 capacity threshold" 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:
    NfviCapacityThresholdRequest:
      description: |
        Request parameters to create a new "Individual capacity threshold" resource.
      content:
        application/json:
          schema:
            $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CreateCapacityThresholdRequest
      required: true

295
296
297
298
299
300
301
302
303
304
    IndividualNfviCapacityThresholdRequest:
      description: |
        Parameters for the capacity threshold modification.
        The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
      content:
        application/json:
          schema:
            $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThresholdModifications
      required: true

305
  responses:
Giacomo Bernini's avatar
Giacomo Bernini committed
306
    NfviCapacityInfos.Get.200:
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
      description: |
        Shall be returned when information about NFVI capacity information has been queried successfully.
        The response body shall contain NFVI capacity information, as defined in clause 10.5.2.4.
        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 clauses 5.2.2 of ETSI GS NFV-SOL 013.
        If the NFVO 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: |
            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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfo

Giacomo Bernini's avatar
Giacomo Bernini committed
343
    NfviCapacityInfo.Get.200:
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
      description: |
        Shall be returned when information of an individual VIM’s NFVI capacity has been read successfully.
        The response body shall contain a representation of  the NFVI capacity information, as defined in clause 10.5.2.4.
      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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityInfo

Giacomo Bernini's avatar
Giacomo Bernini committed
374
    CapacityThresholds.Get.200:
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
      description: |
        Shall be returned when information about zero or more capacity thresholds has been queried successfully.
        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.
        The response body shall contain in an array the representations of zero or more capacity thresholds, as
        defined in clause 10.5.2.8.
        If the NFVO 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: |
            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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThreshold

Giacomo Bernini's avatar
Giacomo Bernini committed
412
    CapacityThresholds.Post.201:
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
444
      description: |
        Shall be returned when a capacity threshold has been created successfully.
        The response body shall contain a representation of the created "Individual capacity threshold" resource,
        as defined in clause 10.5.2.8.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource.
      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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThreshold

Giacomo Bernini's avatar
Giacomo Bernini committed
445
    IndividualCapacityThreshold.Get.200:
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
474
475
      description: |
        Shall be returned when information about an individual capacity threshold has been read successfully.
        The response body shall contain in a representation of the capacity threshold, as defined in clause 10.5.2.8.
      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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThreshold

Giacomo Bernini's avatar
Giacomo Bernini committed
476
    IndividualCapacityThreshold.Patch.200:
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
      description: |
        200 OK
        Shall be returned when the request has been processed successfully.
        The response body shall contain a data structure of type "CapacityThresholdModifications".
      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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/NFVICapacityInformation_def.yaml#/components/schemas/CapacityThresholdModifications

Giacomo Bernini's avatar
Giacomo Bernini committed
508
    IndividualCapacityThreshold.Delete.204:
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
      description: |
        Shall be returned when the NFVI capacity threshold has been deleted 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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
534
      content: {}