VNFLifecycleManagement.yaml 98.8 KB
Newer Older
1
2
swagger: "2.0"

3
info:
4
  version: "1.5.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
moscatelli's avatar
moscatelli committed
5
  title: SOL002 - VNF Lifecycle Management interface
6
  description: >
moscatelli's avatar
moscatelli committed
7
    SOL002 - VNF Lifecycle Management interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
moscatelli's avatar
moscatelli committed
9
10
11
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. 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
  license:
moscatelli's avatar
moscatelli committed
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
16
17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20
21
  description: ETSI GS NFV-SOL 002 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf
22

23
basePath: /vnflcm/v1
24

25
schemes:
26
27
28
  - http
  - https

29
consumes:
30
31
  - application/json

32
produces:
33
34
35
  - application/json

paths:
36
37
38
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
39
  '/api_versions':
40
41
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

42
43
44
  ###############################################################################
  # VNF instances                                                               #
  ###############################################################################
45
  '/vnf_instances':
46
    #SOL002 location: 5.4.2
47
48
49
50
51
52
53
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
54
55
56
57
58
59
60
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
61
    post:
62
      description: >
63
        The POST method creates a new VNF instance resource based on a VNF package that is onboarded and in "ENABLED" state.
64
65
      parameters:
        - name: createVnfRequest
66
67
          description: >
            The VNF creation parameters, as defined in clause 5.5.2.3.
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        201:
88
89
90
          description: >
            201 CREATED

91
92
93
94
95
96
            Shall be returned when a new "Individual VNF Instance" resource and 
            the associated VNF instance identifier has been created successfully.
            The response body shall contain a representation of the created VNF 
            instance, as defined in clause 5.5.2.2.
            The HTTP response shall include a "Location" HTTP header that contains 
            the resource URI of the created VNF instance.
97
98
          headers:
            Content-Type:
99
100
              description: >
                The MIME type of the body of the response.
101
102
103
104
              type: string
              maximum: 1
              minimum: 1
            Location:
105
106
              description: >
                The resource URI of the created VNF instance
107
108
              type: string
              format: url
109
110
              maximum: 1
              minimum: 1
111
112
113
114
115
116
117
118
            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.
              type: string
              maximum: 1
              minimum: 0
119
            Version:
120
121
              description: >
                The used API version.
122
123
124
              type: string
              maximum: 1
              minimum: 1
125
          schema:
126
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
127
128
129
130
131
132
133
134
135
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
136
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
137
138
139
140
141
142
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
143
144
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
145
146
147
148
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
149
150
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
151
152
153
154
155
156
157
158
159
160
161
    get:
      description: >
        The GET method queries information about multiple VNF instances.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
162
163
        - name: filter
          description: >
164
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
165
166
167
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
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM may supply this parameter. All attribute names that appear in the VnfInstance
            and in data types referenced from it shall be supported by the VNFM in the filter expression.
            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
196
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
197
198
199
200
201
202
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
203
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
204
205
206
207
208
209
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
210
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
211
212
213
214
215
216
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
217
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
218
219
220
221
222
223
224
225
226
227
            The following attributes shall be excluded from the VnfInstance structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            -	vnfConfigurableProperties
            -	instantiatedVnfInfo
            -	metadata
            -	extensions
          in: query
          required: false
          type: string
228
229
230
231
232
233
234
235
236
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response.
            Shall be supported by the VNFM if the VNFM supports
            alternative 2 (paging) according to clause 5.4.2.1
            of ETSI GS NFV-SOL 013 for this resource.
          in: query
          required: false
          type: string
237
238
      responses:
        200:
239
          description: >
240
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
241

242
            Information about zero or more VNF instances has been queried
243
            successfully. The response body shall contain in an array the
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
            representations of zero or more VNF instances.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
259
260
261
262
263
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
264
265
266
          schema:
            type: array
            items:
267
              $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
268
        400:
269
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
270
271
272
273
274
275
276
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
277
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
278
279
280
281
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
282
283
284
285
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
286
287
288
289
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
290
291
292
293
294
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Individual VNF instance                                                     #
  ###############################################################################
295
  '/vnf_instances/{vnfInstanceId}':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
296
    #SOL002 location: 5.4.3.2
297
298
299
300
301
302
303
304
305
306
307
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the response
          to a POST request creating a new VNF instance resource. It can also
          be retrieved from the "id" attribute in the payload body of that
          response.
        in: path
        type: string
        required: true
308
309
310
311
312
313
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
314
315
316
317
318
319
320
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
321
322
    get:
      description: >
323
        Information about a VNF instance by reading an "Individual VNF instance".
324
325
      responses:
        200:
326
          description: >
327
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
328

329
330
331
            Information about an individual VNF instance has been read successfully.
            The response body shall contain a representation of the VNF instance,
            as defined in clause 5.5.2.2.
332
333
334
335
336
337
338
339
340
341
342
343
344
345
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
346
347
348
349
350
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
351
          schema:
352
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
353
354
355
356
357
358
359
360
361
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
362
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
363
364
365
366
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
367
368
369
370
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
371
372
373
374
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
375
376
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
377
378
379
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
380
        This method modifies an "Individual VNF instance" resource. Changes to
381
382
383
384
385
386
387
388
389
390
391
        the VNF configurable properties are applied to the configuration in
        the VNF instance, and are reflected in the representation of this
        resource. Other changes are applied to the VNF instance information
        managed by the VNFM, and are reflected in the representation of this
        resource
      parameters:
        - name: vnfInfoModifications
          description: Input parameters for VNF info modification
          required: true
          in: body
          schema:
392
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
393
394
      responses:
        202:
395
396
397
398
399
          description: >
            202 ACCEPTED

            The request was accepted for processing, but the processing has not been completed.
            On success, the HTTP response shall include a "Location" HTTP header that contains
400
401
            the URI of the newly-created an "Individual VNF LCM operation occurrence" resource 
            corresponding to the operation.
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
            The response body shall be empty.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
432
        400:
433
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
434
435
436
437
438
439
440
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
441
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
442
443
444
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
445
446
447
448
449
450
451
452
453
          # description: >
          #   409 CONFLICT

          #   Error: The operation cannot be executed currently, due to a conflict with the state
          #   of the "Individual VNF instance" resource.
          #   Typically, this is due to the fact that another LCM operation is ongoing.
          #   The response body shall contain a ProblemDetails structure, in which the "detail"
          #   attribute should convey more information about the error.
          # schema:
454
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
455
456
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
457
458
459
460
461
462
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
463
464
465
466
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
467
468
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
469
470
    delete:
      description: >
471
        This method deletes an "Individual VNF instance" resource.
472
473
      responses:
        204:
474
          description: >
475
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
476

477
            The "Individual VNF instance" resource and the associated VNF identifier were
478
479
480
481
482
483
484
485
486
487
488
            deleted 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.
              type: string
              maximum: 1
              minimum: 0
489
490
491
492
493
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
494
495
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification"
496
        400:
497
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
498
499
500
501
502
503
504
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
505
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
506
507
508
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
509
510
511
512
513
514
515
516
          # description: >
          #   409 CONFLICT

          #   Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
          #   Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state.
          #   The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
          #   convey more information about the error.
          # schema:
517
518
519
520
521
522
523
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
524
525
526
527
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
528
529
530
531
532
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Instantiate VNF task                                                        #
  ###############################################################################
533
  '/vnf_instances/{vnfInstanceId}/instantiate':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
534
    #SOL002 location: 5.4.4.2
535
536
537
538
539
540
541
542
543
544
545
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the response
          to a POST request creating a new VNF instance resource. It can also
          be retrieved from the "id" attribute in the payload body of that
          response.
        in: path
        type: string
        required: true
546
547
548
549
550
551
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
552
553
554
555
556
557
558
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
559
    post:
560
561
562
563
564
565
566
567
568
      #SOL003 location: 5.4.4.3.1
      description: >
        The POST method instantiates a VNF instance.
      parameters:
        - name: InstantiateVnfRequest
          description: Parameters for the VNF instantiation.
          in: body
          required: true
          schema:
569
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
570
      responses:
571
        202:
572
          description: >
573
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
574

575
            The request has been accepted for processing, but the processing has not been completed.
576
577
578
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
579
580
581
582
583
584
585
586
587
588
589
590
591
592
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
593
594
595
596
597
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
598
599
600
601
602
603
604
605
606
607
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
608
609
610
611
612
613
614
615
616
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
617
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
618
619
620
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
621
622
623
624
625
626
627
628
          # description: >
          #   409 CONFLICT

          #   Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
          #   Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state.
          #   The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
          #   convey more information about the error.
          # schema:
629
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
630
631
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
632
633
634
635
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
636
637
638
639
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
640
641
642
643
644
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Scale VNF task                                                              #
  ###############################################################################
645
  '/vnf_instances/{vnfInstanceId}/scale':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
646
    #SOL002 location: 5.4.5.2
647
648
649
650
651
652
653
654
655
656
657
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled. This identifier can be
          retrieved from the resource referenced by the "Location" HTTP header
          in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
658
659
660
661
662
663
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
664
665
666
667
668
669
670
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
671
    post:
672
673
674
675
676
677
678
679
680
681
682
683
684
      #SOL003 location: 5.4.5.3.1
      description: >
        The POST method requests to scale a VNF instance resource
        incrementally.
      parameters:
        - name: ScaleVnfRequest
          description: Parameters for the scale VNF operation.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
      responses:
        202:
685
686
687
          description: >
            202 ACCEPTED

688
            The request has been accepted for processing, but the processing has not been completed.
689
690
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
691
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
721
722
723
724
725
726
727
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
728
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
729
        405:
730
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
731
732
733
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
734
735
736
737
738
739
740
741
742
          # description: >
          #   409 CONFLICT

          #   Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
          #   Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
          #   or that another lifecycle management operation is ongoing.
          #   The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
          #   convey more information about the error.
          # schema:
743
744
745
746
747
748
749
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
750
751
752
753
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
754
755
756
757
758
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Scale VNF to Level task                                                     #
  ###############################################################################
759
  '/vnf_instances/{vnfInstanceId}/scale_to_level':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
760
    #SOL002 location: 5.4.6.2
761
762
763
764
765
766
767
768
769
770
771
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled to a target level. This
          identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new VNF instance resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
772
773
774
775
776
777
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
778
779
780
781
782
783
784
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
785
    post:
786
787
788
789
790
791
792
793
794
795
796
797
798
      #SOL003 location: 5.4.6.3.1
      description: >
        The POST method requests to scale a VNF instance resource to a target
        level.
      parameters:
        - name: ScaleVnfToLevelRequest
          description: Parameters for the scale VNF to Level operation.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
      responses:
        202:
799
800
801
          description: >
            202 ACCEPTED

802
            The request has been accepted for processing, but the processing has not been completed.
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
835
836
837
838
839
840
841
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
842
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
843
        405:
844
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
845
846
847
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
848
849
850
851
852
853
854
855
856
          # description: >
          #   409 CONFLICT

          #   Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
          #   Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
          #   or that another lifecycle management operation is ongoing.
          #   The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
          #   convey more information about the error.
          # schema:
857
858
859
860
861
862
863
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
864
865
866
867
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
868
869
870
871
872
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Change VNF Flavour task                                                     #
  ###############################################################################
873
874
875
876
877
878
879
880
881
882
883
884
885
886
  '/vnf_instances/{vnfInstanceId}/change_flavour':
    #SOL003 location: 5.4.7.2
    parameters:
      - name: vnfInstanceId
        description: >
          The identifier of the VNF instance of which the deployment flavour
          is requested to be changed. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the
          response to a POST request creating a new VNF instance resource. It
          can also be retrieved from the "id" attribute in the payload body of
          that response.
        in: path
        type: string
        required: true
887
888
889
890
891
892
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
893
894
895
896
897
898
899
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
900
    post:
901
902
903
904
905
906
907
908
      description: >
        The POST method changes the deployment flavour of a VNF instance.
      parameters:
        - name: ChangeVnfFlavourRequest
          description: Parameters for the Change VNF Flavour operation.
          in: body
          required: true
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
909
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
910
911
      responses:
        202:
912
913
914
          description: >
            202 ACCEPTED

915
            The request has been accepted for processing, but the processing has not been completed.
916
917
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
918
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
948
949
950
951
952
953
954
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
955
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
956
        405:
957
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
958
959
960
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
961
962
963
964
965
966
967
968
969
          # description: >
          #   409 CONFLICT

          #   Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
          #   Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
          #   or that another lifecycle management operation is ongoing.
          #   The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
          #   convey more information about the error.
          # schema:
970
971
972
973
974
975
976
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
977
978
979
980
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
981
982
983
984
985
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Terminate VNF task                                                          #
  ###############################################################################
986
  '/vnf_instances/{vnfInstanceId}/terminate':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
987
    #SOL002 location: 5.4.8.2
988
989
990
991
992
993
994
995
996
997
998
    parameters:
      - name: vnfInstanceId
        description: >
          The identifier of the VNF instance to be terminated. This identifier
          can be retrieved from the resource referenced by the "Location" HTTP
          header in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
999
1000
      - name: Version
        description: >
For faster browsing, not all history is shown. View entire blame