NSLifecycleManagement.yaml 86.2 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      parameters:
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK
            
            API version information was read successfully.
            The response body shall contain API version information, as defined in clause 4.4.1.7.
          schema:
            $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        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' }
        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
  ###############################################################################
81
82
  # NSInstances                                                                 #
  ###############################################################################
83
84
85
  '/ns_instances':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
    post:
86
      summary: Create a NS instance resource.
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
      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
110
          type: string
111
112
113
114
115
116
        - 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
117
118
119
120
121
122
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
123
              - "CreateNsRequest"
rameshnaraya's avatar
rameshnaraya committed
124
125
126
127
128
            properties:
              CreateNsRequest:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
            description: >
              The NS creation parameters, as defined in clause 6.5.2.7. 
129
      responses:
130
        201:
131
132
          description: >
            201 Created
133

134
135
136
137
138
139
            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
140
141
142
143
144
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
145
          headers:
rameshnaraya's avatar
rameshnaraya committed
146
147
148
149
150
151
            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.
152
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
153
              type: "string"
154
155
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
156
157
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
158
159
              maximum: 1
              minimum: 0
160
161
162
163
164
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
165
              minimum: 1
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
        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:
185
          $ref: "responses/SOL005_resp.yaml#/responses/503"
186
    get:
187
      summary: Query multiple NS instances.
188
      description: >
189
        Query NS Instances.
190

191
192
193
194
195
196
197
198
        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"
199
          description: >
200
201
202
            "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.
203
            All attribute names that appear in the NsInstance and in data types
204
            referenced from it shall be supported by the NFVO in the filter expression."
205
206
207
208
        - name: "all_fields"
          in: "query"
          required: false
          type: "string"
209
          description: >
210
211
212
213
214
215
            "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"
216
          description: >
217
218
219
220
221
222
            "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"
223
          description: >
224
225
226
227
228
229
            "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"
230
          description: >
231
232
233
234
235
236
237
238
239
240
241
242
            "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"
243
244
245
246
247
248
249
        - 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
250
251
252
253
254
255
256
257
258
259
260
261
262
        - 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
263
          type: string
264
265
266
267
268
269
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
270
271
272
      responses:
        200:
          description: >
273
            200 OK
274

275
276
277
            Information about zero or more NS instances was
            queried successfully.
            The response body shall contain representations of
rameshnaraya's avatar
rameshnaraya committed
278
279
            zero or more NS instances, as defined in
            clause 6.5.2.8.
280
281
282
283
284
285
286
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
287
              type: "string"
288
289
              description: >
                Challenge if the corresponding HTTP request has not provided
290
291
292
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
293
              minimum: 0
294
295
296
297
298
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
299
              minimum: 1
300
301
302
303
304
305
            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
306
307
308
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
309
310
              properties:
                NsInstance:
311
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
        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
331
          $ref: "responses/SOL005_resp.yaml#/responses/503"
332
333
334
335

  ###############################################################################
  # Individual NS instance                                                      #
  ###############################################################################
336
337
338
339
340
341
342
343
344
345
  '/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
346
      summary: Read an individual NS instance resource.
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
      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
372
373
374
375
376
377
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
378
379
      responses:
        200:
380
381
          description: >
            200 OK
382

383
384
            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
385
386
387
388
389
          schema:
            type: "object"
            properties:
              NsInstance:
                $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
390
391
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
392
393
394
395
              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.
396
              maximum: 1
397
              minimum: 1
398
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
399
              type: "string"
400
401
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
402
                authorization, or error details if the corresponding HTTP request
403
                has provided an invalid authorization token.
404
405
              maximum: 1
              minimum: 0
406
407
408
409
410
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
411
              minimum: 1
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
        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:
431
432
          $ref: "responses/SOL005_resp.yaml#/responses/503"

433
    delete:
rameshnaraya's avatar
rameshnaraya committed
434
      summary: Delete NS instance resource.
435
436
      description: >
        Delete NS Identifier
437

438
439
440
441
442
443
444
445
446
        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
447
448
449
450
451
452
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
453
454
455
456
      responses:
        204:
          description: >
            204 No Content
457

458
459
460
461
462
            The NS instance resource and the associated NS
            identifier were deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
463
              type: "string"
464
465
              description: >
                Challenge if the corresponding HTTP request has not provided
466
467
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
468
469
              maximum: 1
              minimum: 0
470
471
472
473
474
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
475
              minimum: 1
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
        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"

497
498
499
  ###############################################################################
  # Instantiate NS task                                                         #
  ###############################################################################
500
501
502
503
504
505
506
507
508
  '/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
509
    post:
rameshnaraya's avatar
rameshnaraya committed
510
      summary: Instantiate a NS.
511
512
513
      description: >
        The POST method requests to instantiate a NS instance resource.
      parameters:
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
        - 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
535
536
537
538
539
540
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
541
542
543
544
545
546
547
548
549
550
551
552
        - 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.
553
554
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
555
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
        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"
576
577
578
579

  ###############################################################################
  # Scale NS task                                                               #
  ###############################################################################
580
581
582
583
584
585
586
587
588
  '/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
589
    post:
rameshnaraya's avatar
rameshnaraya committed
590
      summary: Scale a NS instance.
591
592
      description: >
        The POST method requests to scale a NS instance resource.
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
      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
615
616
617
618
619
620
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
621
622
623
624
625
626
627
628
629
630
631
632
        - 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.
633
634
635
636
637
638
639
640
641
642
643
644
645
646
      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:
647
          $ref: "responses/SOL005_resp.yaml#/responses/406"
648
649
650
651
652
653
        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"
654
655
656
657

  ###############################################################################
  # Update NS task                                                              #
  ###############################################################################
658
659
660
661
662
663
664
665
666
  '/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
667
    post:
rameshnaraya's avatar
rameshnaraya committed
668
      summary: Updates a NS instance.
669
670
671
      description: >
        Scale NS instance.
        The POST method requests to scale a NS instance resource.
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
      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
694
695
696
697
698
699
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
700
701
702
703
704
705
706
707
708
709
710
711
        - 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.
712
713
      responses:
        202:
714
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
        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"
733
734
735
736

  ###############################################################################
  # Heal NS task                                                                #
  ###############################################################################
737
738
  '/ns_instances/{nsInstanceId}/heal':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
739
740
741
    parameters:
      - name: nsInstanceId
        description: >
742
          Identifier of the NS instance to be healed.
743
744
745
746
        in: path
        type: string
        required: true
    post:
747
748
      summary: Heal a NS instance.
      description: >
749
750
751
752
        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.
753
      parameters:
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
        - 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
775
776
777
778
779
780
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
781
782
783
784
785
786
787
788
789
790
791
792
        - 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.
793
794
      responses:
        202:
795
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
        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:
813
          $ref: "responses/SOL005_resp.yaml#/responses/503"
814

815
816
817
  ###############################################################################
  # Terminate NS task                                                           #
  ###############################################################################
818
819
  '/ns_instances/{nsInstanceId}/terminate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
820
821
822
    parameters:
      - name: nsInstanceId
        description: >
823
          The identifier of the NS instance to be terminated.
824
825
826
827
        in: path
        type: string
        required: true
    post:
828
829
830
831
832
833
834
835
836
837
      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.
838
      parameters:
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
        - 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
860
861
862
863
864
865
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
866
867
868
869
870
871
872
873
874
875
876
877
        - 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.
878
879
      responses:
        202:
880
          $ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
        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:
898
          $ref: "responses/SOL005_resp.yaml#/responses/503"
899

900
901
902
  ###############################################################################
  # NS LCM operation occurrences                                                #
  ###############################################################################
903
904
905
  '/ns_lcm_op_occs':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
    get:
rameshnaraya's avatar
rameshnaraya committed
906
      summary: Query multiple NS LCM operation occurrences.
907
      description: >
908
        Get Operation Status.
909
910
911
912
913
914
915
916
917
        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"
918
          description: >
919
920
921
            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.
922
            All attribute names that appear in the NsLcmOpOcc and in data types referenced
923
            from it shall be supported by the NFVO in the filter expression.
924
925
926
927
        - name: "fields"
          in: "query"
          required: false
          type: "string"
928
          description: >
929
930
931
932
933
934
            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"
935
          description: >
936
937
938
939
940
941
            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"
942
          description: >
943
944
945
946
947
948
949
950
            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
951
952
953
954
955
956
957
        - 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
958
959
960
961
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
962
963
964
          in: header
          required: true
          type: string
965
966
967
968
969
970
971
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
972
973
974
975
976
977
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
978
979
980
      responses:
        200:
          description: >
981
            200 OK
982

983
            Status information for zero or more NS lifecycle
rameshnaraya's avatar
rameshnaraya committed
984
            management operation occurrences was queried successfully.
985
986
987
988
989
990
991
992
993
994
            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:
995
              type: "string"
996
997
              description: >
                Challenge if the corresponding HTTP request has not provided
998
999
1000
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
1001
              minimum: 0
1002
1003
1004
1005
1006
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1007
              minimum: 1
1008
1009
1010
1011
1012
1013
            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
1014
1015
1016
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
1017
1018
              properties:
                NsLcmOpOcc:
1019
                  $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
        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"

1039
1040
1041
  ###############################################################################
  # Individual NS lifecycle operation occurrence                                #
  ###############################################################################
1042
  '/ns_lcm_op_occs/{nsLcmOpOccId}':
1043
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.10     
1044
1045
1046
1047
1048
1049
1050
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence.
        in: path
        type: string
        required: true
1051
    get:
rameshnaraya's avatar
rameshnaraya committed
1052
      summary: Read an individual NS LCM operation occurrence resource.
1053
      description: >
1054
1055
1056
1057
1058
1059
        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.
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
      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
1082
1083
1084
1085
1086
1087
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1088
1089
      responses:
        200:
1090
1091
          description: >
            200 OK
1092

1093
1094
1095
1096
            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
1097
          schema:
1098
            type: "object"
rameshnaraya's avatar
rameshnaraya committed
1099
1100
1101
            properties:
              NsLcmOpOcc:
                $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
1102
1103
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1104
              type: "string"
1105
              description: >
rameshnaraya's avatar
rameshnaraya committed
1106
1107
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
1108
              maximum: 1
1109
              minimum: 1
1110
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1111
              type: "string"
1112
1113
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1114
1115
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1116
              maximum: 1
1117
              minimum: 0
1118
1119
1120
1121
1122
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1123
              minimum: 1
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
        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:
1143
          $ref: "responses/SOL005_resp.yaml#/responses/503"
1144

1145
1146
1147
  ###############################################################################
  # Retry operation task                                                        #
  ###############################################################################
1148
1149
1150
1151
1152
1153
  '/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.
1154

1155
1156
          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
1157
          attribute in the NsLcmOperationOccurrenceNotification.
1158
1159
1160
1161
        in: path
        type: string
        required: true
    post:
rameshnaraya's avatar
rameshnaraya committed
1162
      summary: Retry a NS lifecycle management operation occurrence.
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
      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
1178
1179
1180
1181
1182
1183
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
      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"
1205
1206
1207
1208

  ###############################################################################
  # Rollback a NS lifecycle management operation occurrence.                    #
  ###############################################################################
1209
1210
1211
1212
1213
1214
  '/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.
1215

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

1267
1268
1269
  ###############################################################################
  # Continue a NS lifecycle management operation occurrence.                    #
  ###############################################################################
1270
1271
1272
1273
1274
1275
1276
1277
1278
  '/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
1279
    post:
rameshnaraya's avatar
rameshnaraya committed
1280
      summary: Continue a NS lifecycle management operation occurrence.
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
      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
1294
1295
1296
1297
1298
1299
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
      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"
1321
1322
1323
1324

  ###############################################################################
  # Fail operation task                                                         #
  ###############################################################################
1325
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
1326
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.14
1327
1328
1329
1330
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
1331

1332
1333
1334
1335
1336
1337
1338
1339
1340
          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
1341
      summary: Mark a NS lifecycle management operation occurrence as failed.
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
      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
1361
1362
1363
1364
1365
1366
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1367
1368
      responses:
        200:
1369
          description: 200 OK
rameshnaraya's avatar
rameshnaraya committed
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
          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"
1380
1381
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
1382
1383
1384
1385
1386
              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.
1387
              maximum: 1
1388
              minimum: 1
1389
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
1390
              type: "string"
1391
1392
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
1393
1394
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1395
              maximum: 1
1396
              minimum: 0
1397
1398
1399
1400
1401
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
1402
              minimum: 1
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
        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"
1421
1422
1423
1424

  ###############################################################################
  # Cancel operation task                                                       #
  ###############################################################################
1425
  '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
1426
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.15
1427
1428
1429
1430
    parameters:
      - name: nsLcmOpOccId
        description: >
          Identifier of a NS lifecycle management operation occurrence to be canceled.
1431

rameshnaraya's avatar
rameshnaraya committed
1432
1433
          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"
1434
1435
1436
1437
1438
          attribute in the NsLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
    post:
rameshnaraya's avatar
rameshnaraya committed
1439
      summary: Cancel a NS lifecycle management operation occurrence.
1440
1441
1442
1443
1444
1445
1446
1447
1448
      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:
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
        - 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
1470
1471
1472
1473
1474
1475
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
moscatelli's avatar