VNFLifecycleManagement.yaml 98.5 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
    patch:
378
      #SOL002/SOL003 location: 5.4.3.3.4
379
      description: >
380
        This method modifies an "Individual VNF instance" resource.
381
382
383
384
385
386
      parameters:
        - name: vnfInfoModifications
          description: Input parameters for VNF info modification
          required: true
          in: body
          schema:
387
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
388
389
      responses:
        202:
390
391
392
393
394
          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
395
396
            the URI of the newly-created an "Individual VNF LCM operation occurrence" resource 
            corresponding to the operation.
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
            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
427
        400:
428
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
429
430
431
432
433
434
435
        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:
436
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
437
438
439
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
440
441
442
443
444
445
446
447
448
          # 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:
449
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
450
451
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
452
453
454
455
456
457
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
458
459
460
461
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
462
463
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
464
465
    delete:
      description: >
466
        This method deletes an "Individual VNF instance" resource.
467
468
      responses:
        204:
469
          description: >
470
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
471

472
            The "Individual VNF instance" resource and the associated VNF identifier were
473
474
475
476
477
478
479
480
481
482
483
            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
484
485
486
487
488
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
489
490
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification"
491
        400:
492
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
493
494
495
496
497
498
499
        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:
500
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
501
502
503
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
504
505
506
507
508
509
510
511
          # 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:
512
513
514
515
516
517
518
          $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"
519
520
521
522
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
523
524
525
526
527
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Instantiate VNF task                                                        #
  ###############################################################################
528
  '/vnf_instances/{vnfInstanceId}/instantiate':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
529
    #SOL002 location: 5.4.4.2
530
531
532
533
534
535
536
537
538
539
540
    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
541
542
543
544
545
546
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
547
548
549
550
551
552
553
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
554
    post:
555
556
557
558
559
560
561
562
563
      #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:
564
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
565
      responses:
566
        202:
567
          description: >
568
            202 ACCEPTED
Gergely Csatari's avatar
Gergely Csatari committed
569

570
            The request has been accepted for processing, but the processing has not been completed.
571
572
573
            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.
574
575
576
577
578
579
580
581
582
583
584
585
586
587
          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
588
589
590
591
592
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
593
594
595
596
597
598
599
600
601
602
            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
603
604
605
606
607
608
609
610
611
        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:
612
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
613
614
615
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
616
617
618
619
620
621
622
623
          # 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:
624
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
625
626
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
627
628
629
630
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
631
632
633
634
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
635
636
637
638
639
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Scale VNF task                                                              #
  ###############################################################################
640
  '/vnf_instances/{vnfInstanceId}/scale':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
641
    #SOL002 location: 5.4.5.2
642
643
644
645
646
647
648
649
650
651
652
    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
653
654
655
656
657
658
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
659
660
661
662
663
664
665
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
666
    post:
667
668
669
670
671
672
673
674
675
676
677
678
679
      #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:
680
681
682
          description: >
            202 ACCEPTED

683
            The request has been accepted for processing, but the processing has not been completed.
684
685
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
686
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
          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
716
717
718
719
720
721
722
        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:
723
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
724
        405:
725
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
726
727
728
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
729
730
731
732
733
734
735
736
737
          # 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:
738
739
740
741
742
743
744
          $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"
745
746
747
748
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
749
750
751
752
753
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Scale VNF to Level task                                                     #
  ###############################################################################
754
  '/vnf_instances/{vnfInstanceId}/scale_to_level':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
755
    #SOL002 location: 5.4.6.2
756
757
758
759
760
761
762
763
764
765
766
    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
767
768
769
770
771
772
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
773
774
775
776
777
778
779
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
780
    post:
781
782
783
784
785
786
787
788
789
790
791
792
793
      #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:
794
795
796
          description: >
            202 ACCEPTED

797
            The request has been accepted for processing, but the processing has not been completed.
798
799
800
801
802
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
            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
830
831
832
833
834
835
836
        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:
837
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
838
        405:
839
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
840
841
842
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
843
844
845
846
847
848
849
850
851
          # 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:
852
853
854
855
856
857
858
          $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"
859
860
861
862
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
863
864
865
866
867
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Change VNF Flavour task                                                     #
  ###############################################################################
868
869
870
871
872
873
874
875
876
877
878
879
880
881
  '/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
882
883
884
885
886
887
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
888
889
890
891
892
893
894
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
895
    post:
896
897
898
899
900
901
902
903
      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
904
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
905
906
      responses:
        202:
907
908
909
          description: >
            202 ACCEPTED

910
            The request has been accepted for processing, but the processing has not been completed.
911
912
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
913
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
          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
943
944
945
946
947
948
949
        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:
950
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
951
        405:
952
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
953
954
955
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
956
957
958
959
960
961
962
963
964
          # 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:
965
966
967
968
969
970
971
          $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"
972
973
974
975
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
976
977
978
979
980
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Terminate VNF task                                                          #
  ###############################################################################
981
  '/vnf_instances/{vnfInstanceId}/terminate':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
982
    #SOL002 location: 5.4.8.2
983
984
985
986
987
988
989
990
991
992
993
    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
994
995
996
997
998
999
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1000
1001
1002
1003
1004
1005
1006
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1007
    post:
1008
1009
1010
1011
1012
1013
1014
1015
      description: >
        The POST method terminates a VNF instance.
      parameters:
        - name: TerminateVnfRequest
          description: Parameters for the VNF termination.
          in: body
          required: true
          schema:
1016
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest"
1017
1018
      responses:
        202:
1019
1020
1021
          description: >
            202 ACCEPTED

1022
            The request has been accepted for processing.
1023
1024
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
Sana Zulfiqar's avatar
Sana Zulfiqar committed
1025
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
          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
1055
1056
1057
1058
1059
1060
1061
1062
1063
        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:
1064
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1065
1066
1067
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1068
1069
1070
1071
1072
1073
1074
1075
1076
          # 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:
1077
1078
1079
1080
1081
1082
1083
          $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"
1084
1085
1086
1087
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1088
1089
1090
1091
1092
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Heal VNF task                                                               #
  ###############################################################################
1093
  '/vnf_instances/{vnfInstanceId}/heal':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
1094
    #SOL002 location: 5.4.9.2
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be healed. 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
1106
1107
1108
1109
1110
1111
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1112
1113
1114
1115
1116
1117
1118
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1119
    post:
1120
      description: >
1121
        The POST method requests to heal a VNF instance.
1122
1123
1124
1125
1126
1127
      parameters:
        - name: HealVnfRequest
          description: Parameters for the Heal VNF operation.
          in: body
          required: true
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
1128
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
1129
1130
      responses:
        202:
1131
1132
1133
          description: >
            202 ACCEPTED

1134
            The request has been accepted for processing, but the processing has not been completed.
1135
1136
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
1137
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
          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
1167
1168
1169
1170
1171
1172
1173
        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:
1174
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1175
        405:
1176
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1177
1178
1179
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1180
1181
1182
1183
1184
1185
1186
1187
1188
          # 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:
1189
1190
1191
1192
1193
1194
1195
          $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"
1196
1197
1198
1199
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1200
1201
1202
1203
1204
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Operate VNF task                                                            #
  ###############################################################################
1205
  '/vnf_instances/{vnfInstanceId}/operate':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
1206
    #SOL002 location: 5.4.9.2
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be operated. 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
1218
1219
1220
1221
1222
1223
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1224
1225
1226
1227
1228
1229
1230
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1231
    post:
1232
      description: >
1233
        The POST method changes the operational state of a VNF instance.
1234
1235
1236
1237
1238
1239
      parameters:
        - name: OperateVnfRequest
          description: Parameters for the Operate VNF operation.
          in: body
          required: true
          schema:
1240
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
1241
1242
      responses:
        202:
1243
1244
1245
          description: >
            202 ACCEPTED

1246
            The request has been accepted for processing, but the processing has not been completed.
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
            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
1279
1280
1281
1282
1283
1284
1285
        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:
1286
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1287
        405:
1288
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1289
1290
1291
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1292
1293
1294
1295
1296
1297
1298
1299
1300
          # 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 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:
1301
1302
1303
1304
1305
1306
1307
          $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"
1308
1309
1310
1311
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1312
1313
1314
1315
1316
1317
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Change external VNF connectivity task                                       #
  ###############################################################################
  '/vnf_instances/{vnfInstanceId}/change_ext_conn':
Sana Zulfiqar's avatar
Sana Zulfiqar committed
1318
    #SOL002 location: 5.4.9.2
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance of which the external connectivity 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
1331
1332
1333
1334
1335
1336
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1337
1338
1339
1340
1341
1342
1343
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1344
    post:
1345
1346
1347
1348
      description: >
        The POST method changes the external connectivity of a VNF instance.
      parameters:
        - name: ChangeExtVnfConnectivityRequest
1349
          description: >
1350
1351
1352
1353
            Parameters for the Change external VNF connectivity operation.
          in: body
          required: true
          schema:
1354
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest"
1355
1356
      responses:
        202:
1357
1358
1359
          description: >
            202 ACCEPTED

1360
            The request has been accepted for processing, but the processing has not been completed.
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
            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
1393
1394
1395
1396
1397
1398
1399
1400
1401
        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:
1402
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1403
1404
1405
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1406
1407
1408
1409
1410
1411
1412
1413
          # 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 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: