NSLifecycleManagement.yaml 83.1 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.0.0"
rameshnaraya's avatar
rameshnaraya committed
5
  title: SOL005 - NS Lifecycle Management Interface
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - NS Lifecycle Management Interface
8
9
10
11
12
13
14
15
    IMPORTANT: Please note that this file might be not aligned to the current
    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.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact:
17
18
19
20
21
22
23
24
25
26
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nslcm/v1"
schemes:
  - https
consumes:
  - "application/json"
produces:
27
  - "application/json"
28
paths:
29
30
31
  ###############################################################################
  # NSInstances                                                                 #
  ###############################################################################
32
33
34
  '/ns_instances':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
    post:
35
      summary: Create a NS instance resource.
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
      description: >
        The POST method creates a new NS instance resource.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
59
          type: string
60
61
62
63
64
65
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
rameshnaraya committed
66
67
68
69
70
71
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
72
              - "CreateNsRequest"
rameshnaraya's avatar
rameshnaraya committed
73
74
75
76
77
            properties:
              CreateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
            description: >
              The NS creation parameters, as defined in clause 6.5.2.7. 
78
      responses:
79
        201:
80
81
          description: >
            201 Created
82

83
84
85
86
87
88
            A NS Instance identifier was created successfully.
            The response body shall contain a representation of
            the created NS instance, as defined in clause 6.5.2.8.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the created
            NS instance.
rameshnaraya's avatar
rameshnaraya committed
89
90
91
92
93
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
94
          headers:
rameshnaraya's avatar
rameshnaraya committed
95
96
97
98
99
100
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
101
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
102
              type: "string"
103
104
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
105
106
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
107
108
              maximum: 1
              minimum: 0
109
110
111
112
113
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
114
              minimum: 1
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
134
          $ref: "responses/SOL005_resp.yaml#/responses/503"
135
    get:
136
      summary: Query multiple NS instances.
137
      description: >
138
        Query NS Instances.
139

140
141
142
143
144
145
146
147
        The GET method queries information about multiple NS instances.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
148
          description: >
149
150
151
            "Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI
            query string. The OSS/BSS may supply this parameter.
152
            All attribute names that appear in the NsInstance and in data types
153
            referenced from it shall be supported by the NFVO in the filter expression."
154
155
156
157
        - name: "all_fields"
          in: "query"
          required: false
          type: "string"
158
          description: >
159
160
161
162
163
164
            "Include all complex attributes in the response. See clause 4.3.3 for details.
            The NFVO shall support this parameter."
        - name: "fields"
          in: "query"
          required: false
          type: "string"
165
          description: >
166
167
168
169
170
171
            "Complex attributes to be included into the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."          
        - name: "exclude_fields"
          in: "query"
          required: false
          type: "string"
172
          description: >
173
174
175
176
177
178
            "Complex attributes to be excluded from the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."
        - name: "exclude_default"
          in: "query"
          required: false
          type: "string"
179
          description: >
180
181
182
183
184
185
186
187
188
189
190
191
            "Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the NsInstance structure in
            the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            - vnfInstances
            - pnfInfo
            - virtualLinkInfo
            - vnffgInfo
            - sapInfo
            - nsScaleStatus
            - additionalAffinityOrAntiAffinityRules"
192
193
194
195
196
197
198
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
199
200
201
202
203
204
205
206
207
208
209
210
211
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
212
          type: string
213
214
215
216
217
218
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
219
220
221
      responses:
        200:
          description: >
222
            200 OK
223

224
225
226
            Information about zero or more NS instances was
            queried successfully.
            The response body shall contain representations of
rameshnaraya's avatar
rameshnaraya committed
227
228
            zero or more NS instances, as defined in
            clause 6.5.2.8.
229
230
231
232
233
234
235
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
236
              type: "string"
237
238
              description: >
                Challenge if the corresponding HTTP request has not provided
239
240
241
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
242
              minimum: 0
243
244
245
246
247
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
248
              minimum: 1
249
250
251
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
252
253
              properties:
                NsInstance:
254
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
rameshnaraya's avatar
rameshnaraya committed
274
          $ref: "responses/SOL005_resp.yaml#/responses/503"
275
276
277
278

  ###############################################################################
  # Individual NS instance                                                      #
  ###############################################################################
279
280
281
282
283
284
285
286
287
288
  '/ns_instances/{nsInstanceId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.3
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance.
        in: path
        type: string
        required: true
    get:
rameshnaraya's avatar
rameshnaraya committed
289
      summary: Read an individual NS instance resource.
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
      description: >
        The GET method retrieves information about a NS instance by 
        reading an individual NS instance resource.   
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
315
316
317
318
319
320
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
321
322
      responses:
        200:
323
324
          description: >
            200 OK
325

326
327
            Information about an individual NS instance was queried successfully.
            The response body shall contain a representation of the NS instance.
rameshnaraya's avatar
rameshnaraya committed
328
329
330
331
332
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
333
334
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
335
336
337
338
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
339
              maximum: 1
340
              minimum: 1
341
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
342
              type: "string"
343
344
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
345
                authorization, or error details if the corresponding HTTP request
346
                has provided an invalid authorization token.
347
348
              maximum: 1
              minimum: 0
349
350
351
352
353
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
354
              minimum: 1
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
374
375
          $ref: "responses/SOL005_resp.yaml#/responses/503"

376
    delete:
rameshnaraya's avatar
rameshnaraya committed
377
      summary: Delete NS instance resource.
378
379
      description: >
        Delete NS Identifier
380

381
382
383
384
385
386
387
388
389
        This method deletes an individual NS instance resource.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
390
391
392
393
394
395
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
396
397
398
399
      responses:
        204:
          description: >
            204 No Content
400

401
402
403
404
405
            The NS instance resource and the associated NS
            identifier were deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
406
              type: "string"
407
408
              description: >
                Challenge if the corresponding HTTP request has not provided
409
410
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
411
412
              maximum: 1
              minimum: 0
413
414
415
416
417
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
418
              minimum: 1
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

440
441
442
  ###############################################################################
  # Instantiate NS task                                                         #
  ###############################################################################
443
444
445
446
447
448
449
450
451
  '/ns_instances/{nsInstanceId}/instantiate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.4
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be instantiated.
        in: path
        type: string
        required: true
452
    post:
rameshnaraya's avatar
rameshnaraya committed
453
      summary: Instantiate a NS.
454
455
456
      description: >
        The POST method requests to instantiate a NS instance resource.
      parameters:
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
478
479
480
481
482
483
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
484
485
486
487
488
489
490
491
492
493
494
495
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "InstantiateNsRequest"
            properties:
              InstantiateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
            description: >
              Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
496
497
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
498
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
519
520
521
522

  ###############################################################################
  # Scale NS task                                                               #
  ###############################################################################
523
524
525
526
527
528
529
530
531
  '/ns_instances/{nsInstanceId}/scale':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.5
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be scaled.
        in: path
        type: string
        required: true
532
    post:
rameshnaraya's avatar
rameshnaraya committed
533
      summary: Scale a NS instance.
534
535
      description: >
        The POST method requests to scale a NS instance resource.
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
558
559
560
561
562
563
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
564
565
566
567
568
569
570
571
572
573
574
575
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "ScaleNsRequest"
            properties:
              ScaleNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
            description: >
              Parameters for the scale NS operation, as defined in clause 6.5.2.13.
576
577
578
579
580
581
582
583
584
585
586
587
588
589
      responses:
        202:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
590
          $ref: "responses/SOL005_resp.yaml#/responses/406"
591
592
593
594
595
596
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
597
598
599
600

  ###############################################################################
  # Update NS task                                                              #
  ###############################################################################
601
602
603
604
605
606
607
608
609
  '/ns_instances/{nsInstanceId}/update':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.6
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be updated.
        in: path
        type: string
        required: true
610
    post:
rameshnaraya's avatar
rameshnaraya committed
611
      summary: Updates a NS instance.
612
613
614
      description: >
        Scale NS instance.
        The POST method requests to scale a NS instance resource.
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
637
638
639
640
641
642
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
643
644
645
646
647
648
649
650
651
652
653
654
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "UpdateNsRequest"
            properties:
              UpdateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
            description: >
              Parameters for the update NS operation, as defined in clause 6.5.2.11.
655
656
      responses:
        202:
657
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
676
677
678
679

  ###############################################################################
  # Heal NS task                                                                #
  ###############################################################################
680
681
  '/ns_instances/{nsInstanceId}/heal':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
682
683
684
    parameters:
      - name: nsInstanceId
        description: >
685
          Identifier of the NS instance to be healed.
686
687
688
689
        in: path
        type: string
        required: true
    post:
690
691
      summary: Heal a NS instance.
      description: >
692
693
694
695
        The POST method requests to heal a NS instance resource.
        This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and 
        6.4.7.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
696
      parameters:
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
718
719
720
721
722
723
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
724
725
726
727
728
729
730
731
732
733
734
735
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "HealNsRequest"
            properties:
              HealNsRequest:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
            description: >
              Parameters for the heal NS operation, as defined in clause 6.5.2.12.
736
737
      responses:
        202:
738
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
756
          $ref: "responses/SOL005_resp.yaml#/responses/503"
757

758
759
760
  ###############################################################################
  # Terminate NS task                                                           #
  ###############################################################################
761
762
  '/ns_instances/{nsInstanceId}/terminate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
763
764
765
    parameters:
      - name: nsInstanceId
        description: >
766
          The identifier of the NS instance to be terminated.
767
768
769
770
        in: path
        type: string
        required: true
    post:
771
772
773
774
775
776
777
778
779
780
      summary: Terminate a NS instance.
      description: >
        Terminate NS task.  
        The POST method terminates a NS instance. This method can only be 
        used with a NS instance in the INSTANTIATED
        state. Terminating a NS instance does not delete the NS instance identifier, 
        but rather transitions the NS into the NOT_INSTANTIATED state.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Tables 6.4.8.3.1-1 and 6.8.8.3.1-2.
781
      parameters:
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
803
804
805
806
807
808
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
809
810
811
812
813
814
815
816
817
818
819
820
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "TerminateNsRequest"
            properties:
              TerminateNsRequest:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
            description: >
              The terminate NS request parameters, as defined in  clause 6.5.2.14.
821
822
      responses:
        202:
823
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
841
          $ref: "responses/SOL005_resp.yaml#/responses/503"
842

843
844
845
  ###############################################################################
  # NS LCM operation occurrences                                                #
  ###############################################################################
846
847
848
  '/ns_lcm_op_occs':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
    get:
rameshnaraya's avatar
rameshnaraya committed
849
      summary: Query multiple NS LCM operation occurrences.
850
      description: >
851
        Get Operation Status.
852
853
854
855
856
857
858
859
860
        The client can use this method to query status information about multiple NS lifecycle management operation
        occurrences.
        This method shall follow the provisions specified in the Tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
861
          description: >
862
863
864
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
865
            All attribute names that appear in the NsLcmOpOcc and in data types referenced
866
            from it shall be supported by the NFVO in the filter expression.
867
868
869
870
        - name: "fields"
          in: "query"
          required: false
          type: "string"
871
          description: >
872
873
874
875
876
877
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
        - name: "exclude_fields"
          in: "query"
          required: false
          type: "string"
878
          description: >
879
880
881
882
883
884
            Complex attributes to be excluded from the response. See clause 4.3.3 for details.
            The NFVO should support this parameter.
        - name: "exclude_default"
          in: "query"
          required: false
          type: "string"
885
          description: >
886
887
888
889
890
891
892
893
            Indicates to exclude the following complex attributes from the response. See
            clause 4.3.3 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the NsLcmOpOcc structure in the
            response body if this parameter is provided:
            - operationParams
            - changedVnfInfo
            - error
            - resourceChanges
894
895
896
897
898
899
900
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
901
902
903
904
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
905
906
907
          in: header
          required: true
          type: string
908
909
910
911
912
913
914
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
915
916
917
918
919
920
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
921
922
923
      responses:
        200:
          description: >
924
            200 OK
925

926
            Status information for zero or more NS lifecycle
rameshnaraya's avatar
rameshnaraya committed
927
            management operation occurrences was queried successfully.
928
929
930
931
932
933
934
935
936
937
            The response body shall contain representations of
            zero or more NS instances, as defined in
            clause 5.5.2.13.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
938
              type: "string"
939
940
              description: >
                Challenge if the corresponding HTTP request has not provided
941
942
943
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
944
              minimum: 0
945
946
947
948
949
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
950
              minimum: 1
951
952
953
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
954
955
              properties:
                NsLcmOpOcc:
956
                  $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

976
977
978
  ###############################################################################
  # Individual NS lifecycle operation occurrence                                #
  ###############################################################################
979
  '/ns_lcm_op_occs/{nsLcmOpOccId}':
980
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.10     
981
982
983
984
985
986
987
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence.
        in: path
        type: string
        required: true
988
    get:
rameshnaraya's avatar
rameshnaraya committed
989
      summary: Read an individual NS LCM operation occurrence resource.
990
      description: >
991
992
993
994
995
996
        The client can use this method to retrieve status information about
        a NS lifecycle management operation occurrence by
        reading an individual "NS LCM operation occurrence" resource.
        This method shall follow the provisions specified in the
        Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
1019
1020
1021
1022
1023
1024
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1025
1026
      responses:
        200:
1027
1028
          description: >
            200 OK
1029

1030
1031
1032
1033
            Information about an individual NS instance was queried successfully.
            The response body shall contain status information
            about a NS lifecycle management operation
            occurrence (see clause 6.5.2.3).
rameshnaraya's avatar
rameshnaraya committed
1034
          schema:
1035
            type: "object"
rameshnaraya's avatar
rameshnaraya committed
1036
1037
1038
            properties:
              NsLcmOpOcc:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
1039
1040
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1041
              type: "string"
1042
              description: >
rameshnaraya's avatar
rameshnaraya committed
1043
1044
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
1045
              maximum: 1
1046
              minimum: 1
1047
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1048
              type: "string"
1049
1050
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1051
1052
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1053
              maximum: 1
1054
              minimum: 0
1055
1056
1057
1058
1059
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1060
              minimum: 1
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1080
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1081

1082
1083
1084
  ###############################################################################
  # Retry operation task                                                        #
  ###############################################################################
1085
1086
1087
1088
1089
1090
  '/ns_lcm_op_occs/{nsLcmOpOccId}/retry':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.11
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be retried.
1091

1092
1093
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
rameshnaraya's avatar
rameshnaraya committed
1094
          attribute in the NsLcmOperationOccurrenceNotification.
1095
1096
1097
1098
        in: path
        type: string
        required: true
    post:
rameshnaraya's avatar
rameshnaraya committed
1099
      summary: Retry a NS lifecycle management operation occurrence.
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
      description: >
        The POST method initiates retrying a NS lifecycle management operation 
        if that operation has experienced a temporary
        failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
        This method shall follow the provisions specified in the 
        Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1115
1116
1117
1118
1119
1120
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1142
1143
1144
1145

  ###############################################################################
  # Rollback a NS lifecycle management operation occurrence.                    #
  ###############################################################################
1146
1147
1148
1149
1150
1151
  '/ns_lcm_op_occs/{nsLcmOpOccId}/rollback':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.12
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be rolled back.
1152

1153
1154
1155
1156
1157
1158
1159
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1160
      summary: Rollback a NS lifecycle management operation occurrence.
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
      description: >
        The POST method initiates rolling back a NS lifecycle operation 
        if that operation has experienced a temporary failure,
        i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
        This method shall follow the provisions specified in the 
        Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1176
1177
1178
1179
1180
1181
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1204
1205
1206
  ###############################################################################
  # Continue a NS lifecycle management operation occurrence.                    #
  ###############################################################################
1207
1208
1209
1210
1211
1212
1213
1214
1215
  '/ns_lcm_op_occs/{nsLcmOpOccId}/continue':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.13
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be continued.
        in: path
        required: true
        type: string
1216
    post:
rameshnaraya's avatar
rameshnaraya committed
1217
      summary: Continue a NS lifecycle management operation occurrence.
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
      description: >
        The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure,
        i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
        This method shall follow the provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1231
1232
1233
1234
1235
1236
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1258
1259
1260
1261

  ###############################################################################
  # Fail operation task                                                         #
  ###############################################################################
1262
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
1263
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.14
1264
1265
1266
1267
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
1268

1269
1270
1271
1272
1273
1274
1275
1276
1277
          This identifier can be retrieved from the resource referenced by 
          he "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. 
          It can also be retrieved from the "nsLcmOpOccId"
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1278
      summary: Mark a NS lifecycle management operation occurrence as failed.
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
      description: >
        The POST method marks a NS lifecycle management operation 
        occurrence as "finally failed" if that operation
        occurrence is in "FAILED_TEMP" state.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
1298
1299
1300
1301
1302
1303
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1304
1305
      responses:
        200:
1306
          description: 200 OK
rameshnaraya's avatar
rameshnaraya committed
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
          schema:
            type: "object"
            description: >
              The state of the NS lifecycle management operation
              occurrence was changed successfully.
              The response shall include a representation of the NS
              lifecycle management operation occurrence resource.
            properties:
              NsLcmOpOcc:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
1317
1318
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1319
1320
1321
1322
1323
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
1324
              maximum: 1
1325
              minimum: 1
1326
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1327
              type: "string"
1328
1329
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1330
1331
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1332
              maximum: 1
1333
              minimum: 0
1334
1335
1336
1337
1338
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1339
              minimum: 1
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1358
1359
1360
1361

  ###############################################################################
  # Cancel operation task                                                       #
  ###############################################################################
1362
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
1363
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.15
1364
1365
1366
1367
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be canceled.
1368

rameshnaraya's avatar
rameshnaraya committed
1369
1370
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
          to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
1371
1372
1373
1374
1375
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1376
      summary: Cancel a NS lifecycle management operation occurrence.
1377
1378
1379
1380
1381
1382
1383
1384
1385
      description: >
        The POST method initiates canceling an ongoing NS lifecycle 
        management operation while it is being executed or
        rolled back, i.e. the related "NS LCM operation occurrence" is 
        either in "PROCESSING" or "ROLLING_BACK" state.
        This method shall follow the provisions specified in the 
        Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
      parameters:
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
1407
1408
1409
1410
1411
1412
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "CancelMode"
            properties:
              CancelMode:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/CancelMode"
            description: >
              The POST request to this resource shall include a CancelMode
              structure in the payload body to choose between "graceful" and
              "forceful" cancellation.
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
      responses:
        202:
          $ref: "responses/SOL005_resp.yaml#/responses/202"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
1443
          description: >
1444
            409 Conflict.
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461

            Error: The operation cannot be executed currently, due
            to a conflict with the state of the NS LCM operation
            occurrence resource.
            Typically, this is due to the fact that the operation
            occurrence is not in STARTING, PROCESSING or
            ROLLING_BACK state.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
1462
              type: "string"
1463
1464
              description: >
                Challenge if the corresponding HTTP request has not provided