NSLifecycleManagement.yaml 67.3 KB
Newer Older
1
2
swagger: "2.0"
info:
3
  version: "1.1.0"
4
  title: "SOL005 - NS Lifecycle Management Interface"
5
  description: >
rameshnaraya's avatar
rameshnaraya committed
6
    SOL005 - NS Lifecycle Management Interface
7
8
9
10
11
12
13
14
    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
15
  contact:
16
17
    name: "NFV-SOL WG"
externalDocs:
18
19
  description: ETSI GS NFV-SOL 005 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
20
basePath: /nslcm/v1
21
schemes:
22
  - http
23
24
  - https
consumes:
25
  - application/json
26
produces:
27
  - application/json
28
paths:
29
  ###############################################################################
30
31
32
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
33
34
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

35
  ###############################################################################
36
37
  # NSInstances                                                                 #
  ###############################################################################
38
39
40
  '/ns_instances':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
    post:
41
      summary: Create a NS instance resource.
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
      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
65
          type: string
66
67
68
69
70
71
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
72
73
        - name: body
          in: body
rameshnaraya's avatar
rameshnaraya committed
74
75
          required: true
          schema:
76
77
78
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
          description: >
            The NS creation parameters, as defined in clause 6.5.2.7.
79
      responses:
80
        201:
81
82
          description: >
            201 Created
83

84
85
86
87
88
89
            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
90
          schema:
91
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
92
          headers:
rameshnaraya's avatar
rameshnaraya committed
93
            Content-Type:
94
              type: string
rameshnaraya's avatar
rameshnaraya committed
95
96
97
98
              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.
99
            WWW-Authenticate:
100
              type: string
101
102
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
103
104
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
105
106
              maximum: 1
              minimum: 0
107
108
109
110
111
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
112
              minimum: 1
113
        400:
114
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
115
        401:
116
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
117
        403:
118
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
119
        404:
120
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
121
        405:
122
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
123
        406:
124
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
125
        409:
126
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
127
        416:
128
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
129
        500:
130
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
131
        503:
132
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
133
    get:
134
      summary: Query multiple NS instances.
135
      description: >
136
        Query NS Instances.
137

138
139
140
141
        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:
142
143
        - name: filter
          in: query
144
          required: false
145
          type: string
146
          description: >
147
            Attribute-based filtering expression according to clause 4.3.2.
148
149
            The NFVO shall support receiving this parameter as part of the URI
            query string. The OSS/BSS may supply this parameter.
150
            All attribute names that appear in the NsInstance and in data types
151
152
153
            referenced from it shall be supported by the NFVO in the filter expression.
        - name: all_fields
          in: query
154
          required: false
155
          type: string
156
          description: >
157
158
159
160
            Include all complex attributes in the response. See clause 4.3.3 for details.
            The NFVO shall support this parameter.
        - name: fields
          in: query
161
          required: false
162
          type: string
163
          description: >
164
165
            "Complex attributes to be included into the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."          
166
167
        - name: exclude_fields
          in: query
168
          required: false
169
          type: string
170
          description: >
171
172
            "Complex attributes to be excluded from the response. See clause 4.3.3 for
            details. The NFVO should support this parameter."
173
174
        - name: exclude_default
          in: query
175
          required: false
176
          type: string
177
          description: >
178
179
180
181
182
183
184
185
186
187
188
189
            "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"
190
191
192
193
194
195
196
        - 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
197
198
199
200
201
202
203
204
205
206
207
208
209
        - 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
210
          type: string
211
212
213
214
215
216
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
217
218
219
      responses:
        200:
          description: >
220
            200 OK
221

222
223
224
225
226
227
            Information about zero or more NS instances was queried successfully.
            The response body shall contain in an array the representations of
            zero or more NS instances, as defined in clause 6.5.2.8.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
228
229
230
231
232
233
234
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
235
              type: string
236
237
              description: >
                Challenge if the corresponding HTTP request has not provided
238
239
240
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
241
              minimum: 0
242
243
244
245
246
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
247
              minimum: 1
248
249
250
251
252
253
            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
254
255
256
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
257
258
              properties:
                NsInstance:
259
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
260
        400:
261
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
262
        401:
263
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
264
        403:
265
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
266
        404:
267
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
268
        405:
269
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
270
        406:
271
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
272
        409:
273
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
274
        416:
275
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
276
        500:
277
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
278
        503:
279
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
280
281
282
283

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

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

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

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

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

442
443
444
  ###############################################################################
  # Instantiate NS task                                                         #
  ###############################################################################
445
446
447
448
449
450
451
452
453
  '/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
454
    post:
rameshnaraya's avatar
rameshnaraya committed
455
      summary: Instantiate a NS.
456
457
458
      description: >
        The POST method requests to instantiate a NS instance resource.
      parameters:
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
        - 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
480
481
482
483
484
485
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
486
487
        - name: body
          in: body
488
489
          required: true
          schema:
490
491
492
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
          description: >
            Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
493
494
      responses:
        202:
495
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
496
        400:
497
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
498
        401:
499
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
500
        403:
501
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
502
        404:
503
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
504
        405:
505
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
506
        406:
507
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
508
        409:
509
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
510
        416:
511
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
512
        500:
513
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
514
        503:
515
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
516
517
518
519

  ###############################################################################
  # Scale NS task                                                               #
  ###############################################################################
520
521
522
523
524
525
526
527
528
  '/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
529
    post:
rameshnaraya's avatar
rameshnaraya committed
530
      summary: Scale a NS instance.
531
532
      description: >
        The POST method requests to scale a NS instance resource.
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
      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
555
556
557
558
559
560
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
561
562
        - name: body
          in: body
563
564
          required: true
          schema:
565
566
567
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
          description: >
            Parameters for the scale NS operation, as defined in clause 6.5.2.13.
568
569
      responses:
        202:
570
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
571
        400:
572
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
573
        401:
574
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
575
        403:
576
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
577
        404:
578
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
579
        405:
580
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
581
        406:
582
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
583
        409:
584
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
585
        500:
586
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
587
        503:
588
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
589
590
591
592

  ###############################################################################
  # Update NS task                                                              #
  ###############################################################################
593
594
595
596
597
598
599
600
601
  '/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
602
    post:
rameshnaraya's avatar
rameshnaraya committed
603
      summary: Updates a NS instance.
604
605
606
      description: >
        Scale NS instance.
        The POST method requests to scale a NS instance resource.
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
      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
629
630
631
632
633
634
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
635
636
        - name: body
          in: body
637
638
          required: true
          schema:
639
640
641
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
          description: >
            Parameters for the update NS operation, as defined in clause 6.5.2.11.
642
643
      responses:
        202:
644
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
645
        400:
646
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
647
        401:
648
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
649
        403:
650
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
651
        404:
652
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
653
        405:
654
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
655
        406:
656
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
657
        409:
658
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
659
        500:
660
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
661
        503:
662
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
663
664
665
666

  ###############################################################################
  # Heal NS task                                                                #
  ###############################################################################
667
668
  '/ns_instances/{nsInstanceId}/heal':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
669
670
671
    parameters:
      - name: nsInstanceId
        description: >
672
          Identifier of the NS instance to be healed.
673
674
675
676
        in: path
        type: string
        required: true
    post:
677
678
      summary: Heal a NS instance.
      description: >
679
680
681
682
        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.
683
      parameters:
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
        - 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
705
706
707
708
709
710
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
711
712
        - name: body
          in: body
713
714
          required: true
          schema:
715
716
717
            $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
          description: >
            Parameters for the heal NS operation, as defined in clause 6.5.2.12.
718
719
      responses:
        202:
720
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
721
        400:
722
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
723
        401:
724
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
725
        403:
726
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
727
        404:
728
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
729
        405:
730
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
731
        406:
732
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
733
        409:
734
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
735
        500:
736
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
737
        503:
738
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
739

740
741
742
  ###############################################################################
  # Terminate NS task                                                           #
  ###############################################################################
743
744
  '/ns_instances/{nsInstanceId}/terminate':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
745
746
747
    parameters:
      - name: nsInstanceId
        description: >
748
          The identifier of the NS instance to be terminated.
749
750
751
752
        in: path
        type: string
        required: true
    post:
753
754
755
756
757
758
759
760
761
762
      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.
763
      parameters:
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
        - 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
785
786
787
788
789
790
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
791
792
        - name: body
          in: body
793
794
          required: true
          schema:
795
796
797
            $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
          description: >
            The terminate NS request parameters, as defined in  clause 6.5.2.14.
798
799
      responses:
        202:
800
          $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
801
        400:
802
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
803
        401:
804
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
805
        403:
806
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
807
        404:
808
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
809
        405:
810
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
811
        406:
812
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
813
        409:
814
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
815
        500:
816
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
817
        503:
818
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
819

820
821
822
  ###############################################################################
  # NS LCM operation occurrences                                                #
  ###############################################################################
823
824
825
  '/ns_lcm_op_occs':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
    get:
rameshnaraya's avatar
rameshnaraya committed
826
      summary: Query multiple NS LCM operation occurrences.
827
      description: >
828
        Get Operation Status.
829
830
831
832
833
        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:
834
835
        - name: filter
          in: query
836
          required: false
837
          type: string
838
          description: >
839
840
841
            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.
842
            All attribute names that appear in the NsLcmOpOcc and in data types referenced
843
            from it shall be supported by the NFVO in the filter expression.
844
845
        - name: fields
          in: query
846
          required: false
847
          type: string
848
          description: >
849
850
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
851
852
        - name: exclude_fields
          in: query
853
          required: false
854
          type: string
855
          description: >
856
857
            Complex attributes to be excluded from the response. See clause 4.3.3 for details.
            The NFVO should support this parameter.
858
859
        - name: exclude_default
          in: query
860
          required: false
861
          type: string
862
          description: >
863
864
865
866
867
868
869
870
            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
871
872
873
874
875
876
877
        - 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
878
879
880
881
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
882
883
884
          in: header
          required: true
          type: string
885
886
887
888
889
890
891
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
892
893
894
895
896
897
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
898
899
900
      responses:
        200:
          description: >
901
            200 OK
902

903
904
905
906
907
908
909
            Status information for zero or more NS lifecycle management operation 
            occurrences was queried successfully. 
            The response body shall contain in an array the representations of
            zero or more NS instances, as defined in clause 5.5.2.13.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
910
911
912
913
914
915
916
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
917
              type: string
918
919
              description: >
                Challenge if the corresponding HTTP request has not provided
920
921
922
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
923
              minimum: 0
924
925
926
927
928
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
929
              minimum: 1
930
931
932
933
934
935
            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
936
937
938
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
939
940
              properties:
                NsLcmOpOcc:
941
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
942
        400:
943
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
944
        401:
945
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
946
        403:
947
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
948
        404:
949
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
950
        405:
951
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
952
        406:
953
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
954
        409:
955
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
956
        500:
957
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
958
        503: