NSLifecycleManagement.yaml 83.8 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
252
253
254
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
255
256
257
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
258
259
              properties:
                NsInstance:
260
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
        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
280
          $ref: "responses/SOL005_resp.yaml#/responses/503"
281
282
283
284

  ###############################################################################
  # Individual NS instance                                                      #
  ###############################################################################
285
286
287
288
289
290
291
292
293
294
  '/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
295
      summary: Read an individual NS instance resource.
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
      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
321
322
323
324
325
326
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
327
328
      responses:
        200:
329
330
          description: >
            200 OK
331

332
333
            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
334
335
336
337
338
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
339
340
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
341
342
343
344
              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.
345
              maximum: 1
346
              minimum: 1
347
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
348
              type: "string"
349
350
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
351
                authorization, or error details if the corresponding HTTP request
352
                has provided an invalid authorization token.
353
354
              maximum: 1
              minimum: 0
355
356
357
358
359
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
360
              minimum: 1
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
        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:
380
381
          $ref: "responses/SOL005_resp.yaml#/responses/503"

382
    delete:
rameshnaraya's avatar
rameshnaraya committed
383
      summary: Delete NS instance resource.
384
385
      description: >
        Delete NS Identifier
386

387
388
389
390
391
392
393
394
395
        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
396
397
398
399
400
401
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
402
403
404
405
      responses:
        204:
          description: >
            204 No Content
406

407
408
409
410
411
            The NS instance resource and the associated NS
            identifier were deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
412
              type: "string"
413
414
              description: >
                Challenge if the corresponding HTTP request has not provided
415
416
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
417
418
              maximum: 1
              minimum: 0
419
420
421
422
423
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
424
              minimum: 1
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
        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"

446
447
448
  ###############################################################################
  # Instantiate NS task                                                         #
  ###############################################################################
449
450
451
452
453
454
455
456
457
  '/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
458
    post:
rameshnaraya's avatar
rameshnaraya committed
459
      summary: Instantiate a NS.
460
461
462
      description: >
        The POST method requests to instantiate a NS instance resource.
      parameters:
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
        - 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
484
485
486
487
488
489
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
490
491
492
493
494
495
496
497
498
499
500
501
        - 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.
502
503
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
504
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
        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"
525
526
527
528

  ###############################################################################
  # Scale NS task                                                               #
  ###############################################################################
529
530
531
532
533
534
535
536
537
  '/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
538
    post:
rameshnaraya's avatar
rameshnaraya committed
539
      summary: Scale a NS instance.
540
541
      description: >
        The POST method requests to scale a NS instance resource.
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
      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
564
565
566
567
568
569
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
570
571
572
573
574
575
576
577
578
579
580
581
        - 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.
582
583
584
585
586
587
588
589
590
591
592
593
594
595
      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:
596
          $ref: "responses/SOL005_resp.yaml#/responses/406"
597
598
599
600
601
602
        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"
603
604
605
606

  ###############################################################################
  # Update NS task                                                              #
  ###############################################################################
607
608
609
610
611
612
613
614
615
  '/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
616
    post:
rameshnaraya's avatar
rameshnaraya committed
617
      summary: Updates a NS instance.
618
619
620
      description: >
        Scale NS instance.
        The POST method requests to scale a NS instance resource.
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
      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
643
644
645
646
647
648
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
649
650
651
652
653
654
655
656
657
658
659
660
        - 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.
661
662
      responses:
        202:
663
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
        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"
682
683
684
685

  ###############################################################################
  # Heal NS task                                                                #
  ###############################################################################
686
687
  '/ns_instances/{nsInstanceId}/heal':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
688
689
690
    parameters:
      - name: nsInstanceId
        description: >
691
          Identifier of the NS instance to be healed.
692
693
694
695
        in: path
        type: string
        required: true
    post:
696
697
      summary: Heal a NS instance.
      description: >
698
699
700
701
        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.
702
      parameters:
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
        - 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
724
725
726
727
728
729
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
730
731
732
733
734
735
736
737
738
739
740
741
        - 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.
742
743
      responses:
        202:
744
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
        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:
762
          $ref: "responses/SOL005_resp.yaml#/responses/503"
763

764
765
766
  ###############################################################################
  # Terminate NS task                                                           #
  ###############################################################################
767
768
  '/ns_instances/{nsInstanceId}/terminate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
769
770
771
    parameters:
      - name: nsInstanceId
        description: >
772
          The identifier of the NS instance to be terminated.
773
774
775
776
        in: path
        type: string
        required: true
    post:
777
778
779
780
781
782
783
784
785
786
      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.
787
      parameters:
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
        - 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
809
810
811
812
813
814
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
815
816
817
818
819
820
821
822
823
824
825
826
        - 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.
827
828
      responses:
        202:
829
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
        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:
847
          $ref: "responses/SOL005_resp.yaml#/responses/503"
848

849
850
851
  ###############################################################################
  # NS LCM operation occurrences                                                #
  ###############################################################################
852
853
854
  '/ns_lcm_op_occs':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
    get:
rameshnaraya's avatar
rameshnaraya committed
855
      summary: Query multiple NS LCM operation occurrences.
856
      description: >
857
        Get Operation Status.
858
859
860
861
862
863
864
865
866
        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"
867
          description: >
868
869
870
            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.
871
            All attribute names that appear in the NsLcmOpOcc and in data types referenced
872
            from it shall be supported by the NFVO in the filter expression.
873
874
875
876
        - name: "fields"
          in: "query"
          required: false
          type: "string"
877
          description: >
878
879
880
881
882
883
            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"
884
          description: >
885
886
887
888
889
890
            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"
891
          description: >
892
893
894
895
896
897
898
899
            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
900
901
902
903
904
905
906
        - 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
907
908
909
910
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
911
912
913
          in: header
          required: true
          type: string
914
915
916
917
918
919
920
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
921
922
923
924
925
926
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
927
928
929
      responses:
        200:
          description: >
930
            200 OK
931

932
            Status information for zero or more NS lifecycle
rameshnaraya's avatar
rameshnaraya committed
933
            management operation occurrences was queried successfully.
934
935
936
937
938
939
940
941
942
943
            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:
944
              type: "string"
945
946
              description: >
                Challenge if the corresponding HTTP request has not provided
947
948
949
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
950
              minimum: 0
951
952
953
954
955
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
956
              minimum: 1
957
958
959
960
961
962
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
963
964
965
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
966
967
              properties:
                NsLcmOpOcc:
968
                  $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
        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"

988
989
990
  ###############################################################################
  # Individual NS lifecycle operation occurrence                                #
  ###############################################################################
991
  '/ns_lcm_op_occs/{nsLcmOpOccId}':
992
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.10     
993
994
995
996
997
998
999
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence.
        in: path
        type: string
        required: true
1000
    get:
rameshnaraya's avatar
rameshnaraya committed
1001
      summary: Read an individual NS LCM operation occurrence resource.
1002
      description: >
1003
1004
1005
1006
1007
1008
        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.
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
      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
1031
1032
1033
1034
1035
1036
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1037
1038
      responses:
        200:
1039
1040
          description: >
            200 OK
1041

1042
1043
1044
1045
            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
1046
          schema:
1047
            type: "object"
rameshnaraya's avatar
rameshnaraya committed
1048
1049
1050
            properties:
              NsLcmOpOcc:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
1051
1052
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1053
              type: "string"
1054
              description: >
rameshnaraya's avatar
rameshnaraya committed
1055
1056
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
1057
              maximum: 1
1058
              minimum: 1
1059
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1060
              type: "string"
1061
1062
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1063
1064
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1065
              maximum: 1
1066
              minimum: 0
1067
1068
1069
1070
1071
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1072
              minimum: 1
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
        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:
1092
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1093

1094
1095
1096
  ###############################################################################
  # Retry operation task                                                        #
  ###############################################################################
1097
1098
1099
1100
1101
1102
  '/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.
1103

1104
1105
          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
1106
          attribute in the NsLcmOperationOccurrenceNotification.
1107
1108
1109
1110
        in: path
        type: string
        required: true
    post:
rameshnaraya's avatar
rameshnaraya committed
1111
      summary: Retry a NS lifecycle management operation occurrence.
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
      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
1127
1128
1129
1130
1131
1132
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
      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"
1154
1155
1156
1157

  ###############################################################################
  # Rollback a NS lifecycle management operation occurrence.                    #
  ###############################################################################
1158
1159
1160
1161
1162
1163
  '/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.
1164

1165
1166
1167
1168
1169
1170
1171
          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
1172
      summary: Rollback a NS lifecycle management operation occurrence.
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
      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
1188
1189
1190
1191
1192
1193
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
      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"

1216
1217
1218
  ###############################################################################
  # Continue a NS lifecycle management operation occurrence.                    #
  ###############################################################################
1219
1220
1221
1222
1223
1224
1225
1226
1227
  '/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
1228
    post:
rameshnaraya's avatar
rameshnaraya committed
1229
      summary: Continue a NS lifecycle management operation occurrence.
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
      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
1243
1244
1245
1246
1247
1248
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
      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"
1270
1271
1272
1273

  ###############################################################################
  # Fail operation task                                                         #
  ###############################################################################
1274
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
1275
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.14
1276
1277
1278
1279
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
1280

1281
1282
1283
1284
1285
1286
1287
1288
1289
          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
1290
      summary: Mark a NS lifecycle management operation occurrence as failed.
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
      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
1310
1311
1312
1313
1314
1315
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1316
1317
      responses:
        200:
1318
          description: 200 OK
rameshnaraya's avatar
rameshnaraya committed
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
          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"
1329
1330
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1331
1332
1333
1334
1335
              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.
1336
              maximum: 1
1337
              minimum: 1
1338
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1339
              type: "string"
1340
1341
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1342
1343
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1344
              maximum: 1
1345
              minimum: 0
1346
1347
1348
1349
1350
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1351
              minimum: 1
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
        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"
1370
1371
1372
1373

  ###############################################################################
  # Cancel operation task                                                       #
  ###############################################################################
1374
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
1375
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.15
1376
1377
1378
1379
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be canceled.
1380

rameshnaraya's avatar
rameshnaraya committed
1381
1382
          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"
1383
1384
1385
1386
1387
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1388
      summary: Cancel a NS lifecycle management operation occurrence.
1389
1390
1391
1392
1393
1394
1395
1396
1397
      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:
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
        - 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
1419
1420
1421
1422
1423
1424
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
        - 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.
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
      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:
1455
          description: >
1456
            409 Conflict.
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473

            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.