NSDManagement.yaml 95.7 KB
Newer Older
1
swagger: 2.0
2

3
info:
4
5
  version: 1.0.0
  title: SOL005 - NSD Management Interface
6
7
8
9
10
11
12
  description: >
    SOL005 - NSD Management Interface 
    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
13
  license:
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact:
17
    name: NFV-SOL WG
18
externalDocs:
19
  description: ETSI GS NFV-SOL 005 V2.4.1
20
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
21
basePath: /nsd/v1
22
schemes:
23
  - https
24
consumes:
25
  - application/json
26
produces:
27
  - application/json
28
paths:
29
30
31
  ###############################################################################
  # NS Descriptors                                                              #
  ###############################################################################
32
  '/ns_descriptors':
33
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
34

35
    get:
36
      summary: Query information about multiple NS descriptor resources.
37
38
      description: >
        The GET method queries information about multiple NS descriptor resources.
39
40
        This method shall follow the provisions specified in the 
        Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters,
41
        request and response data structures, and response codes.
42
      parameters:
43
44
        - name: filter
          in: query
45
          required: false
46
47
          type: string
          description: >
48
49
50
51
52
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this filtering parameter as part
            of the URI query string. The OSS/BSS may supply this parameter.
            All attribute names that appear in the NsdInfo and in data types
            referenced from it shall be supported by the NFVO in the filter expression.
53
54
        - name: all_fields
          in: query
55
          required: false
56
57
58
59
60
61
          type: string
          description: >
            Include all complex attributes in the response. See clause 4.3.3 for details.
             The NFVO shall support this parameter.
        - name: fields
          in: query
62
          required: false
63
64
65
66
67
68
          type: string
          description: >
            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
69
          required: false
70
71
72
73
74
75
          type: string
          description: >
            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
76
          required: false
77
78
79
          type: string
          description: >
            Indicates to exclude the following complex attributes from the response. See
80
81
82
83
            clause 4.3.3 for details. The VNFM shall support this parameter.
            The following attributes shall be excluded from the NsdInfo structure in the
            response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
84
85
86
87
88
89
90
91
            userDefinedData.
        - 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
92
93
94
95
96
97
98
99
100
101
102
103
104
        - 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
105
106
107
108
109
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
110
          required: true
111
          type: string
112
113
      responses:
        200:
114
          description: >
115
            200 OK
116

117
            Information about zero or more NS descriptors.
118
119
            The response body shall contain a representation of
            zero or more NS descriptors, as defined in
120
            clause 5.5.2.2
121
122
          headers:
            Content-Type:
123
              description: The MIME type of the body of the response.
124
125
126
              type: string
              maximum: 1
              minimum: 1
127
            WWW-Authenticate:
128
              type: string
129
130
              description: >
                Challenge if the corresponding HTTP request has not provided
131
132
133
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
134
135
136
137
138
139
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
140
              minimum: 1
141
142
143
144
145
146
            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
147
148
149
          schema:
            type: array
            items:
150
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
151
        400:
152
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
153
        401:
154
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
155
        403:
156
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
157
        404:
158
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
159
        405:
160
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
161
        406:
162
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
163
        409:
164
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
165
        412:
166
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
167
        416:
168
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
169
        500:
170
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
171
        503:
172
173
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

174
    post:
175
      summary: Create a new NS descriptor resource.
176
      description: >
177
        The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor.
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
      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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
206
        - name: CreateNsdInfoRequest
207
208
209
          in: body
          required: true
          schema:
210
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
211
212
            description: >
              Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3
213
214
      responses:
        201:
215
216
          description: >
            Status 201
217

218
219
220
221
222
223
            An NS descriptor resource was created successfully, as a new NS descriptor resource. 
            The response body shall contain a representation
            of the new NS descriptor resource, as defined in clause 5.5.2.3 of GS NFV-SOL 005.
            The HTTP response shall include a "Location"
            HTTP header that contains the resource URI of the
            new NS descriptor resource.            
224
          schema:
225
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
226
227
          headers:
            Content-Type:
228
              type: string
229
230
231
232
233
              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.
            WWW-Authenticate:
234
              type: string
235
236
237
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
238
239
                has provided an invalid authorization token.
              maximum: 1
240
241
242
243
244
245
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
246
              minimum: 1
247
        400:
248
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
249
        401:
250
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
251
        403:
252
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
253
        404:
254
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
255
        405:
256
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
257
        406:
258
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
259
        409:
260
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
261
        412:
262
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
263
        416:
264
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
265
        500:
266
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
267
        503:
268
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
269
270
271
272

  ###############################################################################
  # Individual NS Descriptor                                                    #
  ###############################################################################
273
  '/ns_descriptors/{nsdInfoId}':
274
275
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
276
      - name: nsdInfoId
277
278
        description: >
          Identifier of the individual NS descriptor resource.
279
        in: path
280
        required: true
281
        type: string
282

283
    get:
284
      summary: Read information about an individual NS descriptor resource.
285
286
      description: >
        The GET method reads information about an individual NS descriptor.
287
288
        This method shall follow the provisions specified in GS NFV-SOL 005 Tables
        5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,
289
        request and response data structures, and response codes.
290
      parameters:
291
292
293
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
294
            Reference: IETF RFC 7231.
295
296
297
298
299
300
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
301
            Reference: IETF RFC 7235.
302
303
          in: header
          required: false
304
305
306
307
308
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
309
          required: true
310
          type: string
311
312
      responses:
        200:
313
314
          description: >
            200 OK
315

316
317
318
            Information about the individual NS descriptor.
            The response body shall contain a representation of
            the individual NS descriptor.            
319
          schema:
320
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
321
          headers:
322
            Content-Type:
323
              type: string
324
325
326
              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.
327
            WWW-Authenticate:
328
              type: string
329
330
              description: >
                Challenge if the corresponding HTTP request has not provided
331
332
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
333
334
              maximum: 1
              minimum: 0
335
336
337
338
339
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
340
              minimum: 1
341
        400:
342
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
343
        401:
344
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
345
        403:
346
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
347
        404:
348
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
349
        405:
350
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
351
        406:
352
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
353
        409:
354
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
355
        412:
356
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
357
        416:
358
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
359
        500:
360
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
361
        503:
362
363
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

364
    patch:
365
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
366
      description: >
367
        The PATCH method modifies the operational state and/or user defined
368
369
370
371
372
373
374
375
        data of an individual NS descriptor resource.  This method can be used to:
        1) Enable a previously disabled individual NS descriptor resource, allowing
        again its use for instantiation of new network service with this descriptor.
        The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as result.
        2) Disable a previously enabled individual NS descriptor resource, preventing
        any further use for instantiation of new network service(s) with this descriptor.
        The usage state (i.e. "IN_USE/NOT_IN_USE") shall not changes a result.
        3) Modify the user defined data of an individual NS descriptor resource.
376
      parameters:
377
        - name: NsdInfoModifications
378
379
380
          in: body
          required: true
          schema:
381
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
            description: >
              Parameters for the modification of an individual NS descriptor resource.
        - 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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
405
        200:
406
          description: >
407
            200 OK
408

409
410
411
412
            The operation was completed successfully.
            The response body shall contain attribute
            modifications for an 'Individual NS Descriptor'
            resource.
413
414
          headers:
            Content-Type:
415
416
417
418
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
419
            WWW-Authenticate:
420
              type: string
421
422
              description: >
                Challenge if the corresponding HTTP request has not provided
423
424
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
425
426
              maximum: 1
              minimum: 0
427
428
429
430
431
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
432
              minimum: 1
433
          schema:
434
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
435
        400:
436
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
437
        401:
438
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
439
        403:
440
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
441
        404:
442
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
443
        405:
444
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
445
        406:
446
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
447
        409:
448
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
449
        412:
450
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
451
        416:
452
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
453
        500:
454
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
455
        503:
456
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
457

458
    delete:
459
      summary: Delete an individual NS descriptor resource.
460
      description: >
461
462
463
464
465
466
467
468
        The DELETE method deletes an individual NS descriptor resource.
        An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState =
        NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method
        shall fail.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
469
            Reference: IETF RFC 7235.
470
471
          in: header
          required: false
472
473
474
475
476
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
477
          required: true
478
          type: string
479
480
      responses:
        204:
481
          description: >
482
            204 No Content
483

484
485
486
487
            The operation has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
488
              type: string
489
490
              description: >
                Challenge if the corresponding HTTP request has not provided
491
492
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
493
494
              maximum: 1
              minimum: 0
495
496
497
498
499
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
500
              minimum: 1
501
        400:
502
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
503
        401:
504
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
505
        403:
506
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
507
        404:
508
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
509
        405:
510
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
511
        406:
512
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
513
        409:
514
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
515
        412:
516
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
517
        416:
518
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
519
        500:
520
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
521
        503:
522
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
523
524
525
526
527


  ###############################################################################
  # NSD Content                                                                 #
  ###############################################################################
528
  '/ns_descriptors/{nsdInfoId}/nsd_content':
529
530
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
531
532
      - name: nsdInfoId
        in: path
533
        required: true
534
        type: string
535
    get:
536
      summary: Fetch the content of a NSD.
537
      description: >
538
539
540
        The GET method fetches the content of the NSD.
        The NSD can be implemented as a single file or as a collection of multiple files. 
        If the NSD is implemented in the form of multiple files, a ZIP file embedding
541
542
543
544
545
546
547
548
549
550
551
        these files shall be returned. If the NSD is implemented as a single file,
        either that file or a ZIP file embedding that file shall be returned.
        The selection of the format is controlled by the "Accept" HTTP header passed
        in the GET request:• If the "Accept" header contains only "text/plain"
        and the NSD is implemented as a single file, the file shall be returned;
        otherwise, an error message shall be returned.• If the "Accept" header
        contains only "application/zip", the single file or the multiple files
        that make up the NSD shall be returned embedded in a ZIP file.• If the
        "Accept" header contains both "text/plain" and "application/zip",
        it is up to the NFVO to choose the format to return for a single-file NSD;
        for a multi-file NSD, a ZIP file shall be returned.NOTE: The structure
552
        of the NSD zip file is outside the scope of the present document.
553
      parameters:
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235.
          in: header
          required: false
          type: string
        - name: Range
          in: header
          required: false
          type: string
          description: >
            "The request may contain a "Range" HTTP header to obtain single
            range of bytes from the NSD file. This can be used to continue an aborted
            transmission.If the NFVO does not support range requests, the NFVO
            shall ignore the 'Range" header, process the GET request, and return
            the whole NSD file with a 200 OK response (rather than returning a 4xx
            error status code)."
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
587
588
      responses:
        200:
589
          description: >
590
            200 OK
591

592
593
594
595
596
597
598
599
600
            On success, the content of the NSD is returned.
            The payload body shall contain a copy of the file
            representing the NSD or a ZIP file that contains the file
            or multiple files representing the NSD, as specified
            above.
            The "Content-Type" HTTP header shall be set
            according to the format of the returned file, i.e. to
            "text/plain" for a YAML file or to "application/zip" for a
            ZIP file.
601
602
          headers:
            Content-Type:
603
604
605
606
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
607
            WWW-Authenticate:
608
              type: string
609
610
              description: >
                Challenge if the corresponding HTTP request has not provided
611
612
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
613
614
              maximum: 1
              minimum: 0
615
616
617
618
619
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
620
              minimum: 1
621
        206:
622
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/206"
623
        400:
624
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
625
        401:
626
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
627
        403:
628
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
629
        404:
630
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
631
        405:
632
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
633
        406:
634
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
635
        409:
636
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
637
        412:
638
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
639
        416:
640
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
641
        500:
642
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
643
        503:
644
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
645

646
    put:
647
      summary: Upload the content of a NSD.
648
      description: >
649
650
        "The PUT method is used to upload the content of a NSD. The NSD
        to be uploaded can be implemented as a single file or as a collection of
651
652
653
654
655
        multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. 
        If the NSD is implemented in the form of multiple files, a ZIP file embedding these
        files shall be uploaded. 
        If the NSD is implemented as a single file, either that file or a ZIP file 
        embedding that file shall be uploaded. The "Content-Type"
656
        HTTP header in the PUT request shall be set accordingly based on the format
657
658
659
660
661
662
        selection of the NSD. 
        If the NSD to be uploaded is a text file, the "Content-Type"
        header is set to "text/plain". 
        If the NSD to be uploaded is a zip file,
        the "Content-Type" header is set to "application/zip". 
        This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2
663
664
        of GS-NFV-SOL 005 for URI query parameters, request and response data structures,
        and response codes."
665
      parameters:
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            The payload body contains a copy of the file representing the NSD
            or a ZIP file that contains the file or multiple files representing the NSD.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
690
691
      responses:
        202:
692
          description: >
693
            202 Accepted
694

695
696
697
            The NSD content was accepted for uploading, but the
            processing has not been completed. It is expected to
            take some time for processing (asynchronous mode).
698

699
            The response body shall be empty. 
700
701
702
703
704
705
706
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
707
              type: string
708
709
              description: >
                Challenge if the corresponding HTTP request has not provided
710
711
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
712
713
              maximum: 1
              minimum: 0
714
715
716
717
718
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
719
              minimum: 1
720
        204:
721
          description: >
722
            204 No Content
723

724
725
            The NSD content was successfully uploaded and validated (synchronous mode). 
            The response body shall be empty.
726
        206:
727
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/206"
728
        400:
729
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
730
        401:
731
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
732
        403:
733
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
734
        404:
735
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
736
        405:
737
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
738
        406:
739
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
740
        409:
741
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
742
        412:
743
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
744
        416:
745
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
746
        500:
747
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
748
        503:
749
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
750
751
752
753
754


  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
755
  '/pnf_descriptors':
756
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
757

758
    get:
759
      summary: Query information about multiple PNF descriptor resources.
760
      description: >
761
762
        "The GET method queries information about multiple PNF descriptor
        resources."
763
      parameters:
764
765
766
767
768
        - name: filter
          in: query
          required: false
          type: string
          description: >
769
770
771
772
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this filtering parameter as part
            of the URI query string. The OSS/BSS may supply this parameter.
            All attribute names that appear in the PnfdInfo and in data types
773
            referenced from it shall be supported by the NFVO in the filter expression.
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
        - name: all_fields
          in: query
          required: false
          type: string
          description: >
            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
          description: >
            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
          description: >
            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
          description: >
            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 PnfdInfo structure in the
            response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            userDefinedData.
        - name: nextpage_opaque_marker
          in: query
          type: string
          required: false
          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.
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
819
820
      responses:
        200:
821
          description: >
822
            200 OK
823

824
825
826
827
            Information about zero or more PNF descriptors.
            The response body shall contain a representation of
            zero or more PNF descriptors, as defined in
            clause 5.5.2.2
828
829
          headers:
            Content-Type:
830
831
832
833
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
834
            WWW-Authenticate:
835
              type: string
836
837
              description: >
                Challenge if the corresponding HTTP request has not provided
838
839
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
840
841
              maximum: 1
              minimum: 0
842
843
844
845
846
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
847
              minimum: 1
848
849
850
851
852
853
            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
854
          schema:
855
856
857
858
859
860
            description: >
              Information about zero or more PNF descriptors.
              The response body shall contain a representationin an array the representations
              of zero or more PNF descriptors, as defined in clause  5.5.2.2.
              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.
861
            type: array
862
            items:
863
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
864
        400:
865
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
866
        401:
867
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
868
        403:
869
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
870
        404:
871
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
872
        405:
873
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
874
        406:
875
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
876
        409:
877
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/409"
878
        412:
879
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/412"
880
        416:
881
          $ref: "responses/SOL005NSDescriptorManagement_resp.yaml#/responses/416"
882
        500:
883
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
884
        503:
885
886
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

887
    post:
888
      summary: Create a new PNF descriptor resource.
889
      description: >
890
        The POST method is used to create a new PNF descriptor resource
891
      parameters