NSDManagement.yaml 96.5 KB
Newer Older
1
swagger: "2.0"
2

3
info:
4
  version: "1.0.0"
5
  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
14
  license:
    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
21
22
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nsd/v1"
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
    get:
35
      summary: Query information about multiple NS descriptor resources.
36
37
      description: >
        The GET method queries information about multiple NS descriptor resources.
38
39
        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,
40
        request and response data structures, and response codes.
41
      parameters:
42
43
        - name: filter
          in: query
44
          required: false
45
46
          type: string
          description: >
47
48
49
50
51
            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.
52
53
        - name: all_fields
          in: query
54
          required: false
55
56
57
58
59
60
          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
61
          required: false
62
63
64
65
66
67
          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
68
          required: false
69
70
71
72
73
74
          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
75
          required: false
76
77
78
          type: string
          description: >
            Indicates to exclude the following complex attributes from the response. See
79
80
81
82
            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:
83
84
85
86
87
88
89
90
            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
91
92
93
94
95
96
97
98
99
100
101
102
103
        - 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
104
105
106
107
108
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
109
          required: true
110
          type: string
111
112
      responses:
        200:
113
          description: >
114
            200 OK
115

116
            Information about zero or more NS descriptors.
117
118
            The response body shall contain a representation of
            zero or more NS descriptors, as defined in
119
            clause 5.5.2.2
120
121
          headers:
            Content-Type:
122
              description: The MIME type of the body of the response.
123
124
125
              type: string
              maximum: 1
              minimum: 1
126
            WWW-Authenticate:
127
              type: string
128
129
              description: >
                Challenge if the corresponding HTTP request has not provided
130
131
132
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
133
134
135
136
137
138
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
139
              minimum: 1
140
141
142
143
144
145
            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
146
147
148
149
150
          schema:
            type: array
            items:
              properties:
                NsdInfo:
151
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
152
        400:
153
154
155
156
157
158
159
160
161
162
163
164
165
166
          $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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
167
          $ref: "responses/SOL005_resp.yaml#/responses/412"
168
169
170
171
172
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
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
206
207
208
209
210
211
212
213
214
215
216
217
      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
        - name: body
          in: body
          required: true
          schema:
            type: object
            required:
              - CreateNsdInfoRequest
            properties:
              CreateNsdInfoRequest:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
            description: >
              Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3
218
219
      responses:
        201:
220
221
          description: >
            Status 201
222

223
224
225
226
227
228
            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.            
229
          schema:
230
            type: object
231
232
233
234
235
            properties:
              NsdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
          headers:
            Content-Type:
236
              type: string
237
238
239
240
241
              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:
242
              type: string
243
244
245
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
246
247
                has provided an invalid authorization token.
              maximum: 1
248
249
250
251
252
253
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
254
              minimum: 1
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
270
          $ref: "responses/SOL005_resp.yaml#/responses/412"
271
272
273
274
275
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
276
277
278
279
280
          $ref: "responses/SOL005_resp.yaml#/responses/503"

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

323
324
325
            Information about the individual NS descriptor.
            The response body shall contain a representation of
            the individual NS descriptor.            
326
          schema:
327
            type: object
328
329
330
            properties:
              NsdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
331
          headers:
332
            Content-Type:
333
              type: string
334
335
336
              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.
337
            WWW-Authenticate:
338
              type: string
339
340
              description: >
                Challenge if the corresponding HTTP request has not provided
341
342
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
343
344
              maximum: 1
              minimum: 0
345
346
347
348
349
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
350
              minimum: 1
351
352
353
354
355
356
357
358
359
360
361
362
        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"
363
        409:
364
365
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
366
          $ref: "responses/SOL005_resp.yaml#/responses/412"
367
368
369
370
371
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
372
          $ref: "responses/SOL005_resp.yaml#/responses/503"
373
    patch:
374
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
375
      description: >
376
        The PATCH method modifies the operational state and/or user defined
377
378
379
380
381
382
383
384
        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.
385
      parameters:
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
        - name: body
          in: body
          required: true
          schema:
            type: object
            required:
              - NsdInfoModifications
            properties:
              NsdInfoModifications:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
            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:
419
        200:
420
          description: >
421
            200 OK
422

423
424
425
426
            The operation was completed successfully.
            The response body shall contain attribute
            modifications for an 'Individual NS Descriptor'
            resource.
427
428
          headers:
            Content-Type:
429
430
431
432
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
433
            WWW-Authenticate:
434
              type: string
435
436
              description: >
                Challenge if the corresponding HTTP request has not provided
437
438
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
439
440
              maximum: 1
              minimum: 0
441
442
443
444
445
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
446
              minimum: 1
447
          schema:
448
449
            type: array
            items:
450
              properties:
451
                NsdInfoModifications:
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
468
          $ref: "responses/SOL005_resp.yaml#/responses/412"
469
470
471
472
473
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
474
475
          $ref: "responses/SOL005_resp.yaml#/responses/503"

476
    delete:
477
      summary: Delete an individual NS descriptor resource.
478
      description: >
479
480
481
482
483
484
485
486
487
488
489
        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.
            Reference: IETF RFC 7235
          in: header
          required: false
490
491
492
493
494
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
495
          required: true
496
          type: string
497
498
      responses:
        204:
499
          description: >
500
            204 No Content
501

502
503
504
505
            The operation has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
506
              type: string
507
508
              description: >
                Challenge if the corresponding HTTP request has not provided
509
510
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
511
512
              maximum: 1
              minimum: 0
513
514
515
516
517
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
518
              minimum: 1
519
520
521
522
523
524
525
526
527
528
529
530
531
532
        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/NSDescriptorManagement_resp.yaml#/responses/409"
533
        412:
534
          $ref: "responses/SOL005_resp.yaml#/responses/412"
535
536
537
538
539
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
540
541
542
543
544
545
          $ref: "responses/SOL005_resp.yaml#/responses/503"


  ###############################################################################
  # NSD Content                                                                 #
  ###############################################################################
546
  '/ns_descriptors/{nsdInfoId}/nsd_content':
547
548
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
549
550
      - name: nsdInfoId
        in: path
551
        required: true
552
        type: string
553
    get:
554
      summary: Fetch the content of a NSD.
555
      description: >
556
557
558
        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
559
560
561
562
563
564
565
566
567
568
569
        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
570
        of the NSD zip file is outside the scope of the present document.
571
      parameters:
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
        - 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
605
606
      responses:
        200:
607
          description: >
608
            200 OK
609

610
611
612
613
614
615
616
617
618
            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.
619
620
          headers:
            Content-Type:
621
622
623
624
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
625
            WWW-Authenticate:
626
              type: string
627
628
              description: >
                Challenge if the corresponding HTTP request has not provided
629
630
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
631
632
              maximum: 1
              minimum: 0
633
634
635
636
637
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
638
              minimum: 1
639
        206:
640
641
642
643
644
645
646
647
648
649
650
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        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"
651
        406:
652
          $ref: "responses/SOL005_resp.yaml#/responses/406"
653
        409:
654
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED"
655
        412:
656
          $ref: "responses/SOL005_resp.yaml#/responses/412"
657
        416:
658
659
660
661
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
662
663
          $ref: "responses/SOL005_resp.yaml#/responses/503"

664
    put:
665
      summary: Upload the content of a NSD.
666
      description: >
667
668
        "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
669
670
671
672
673
        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"
674
        HTTP header in the PUT request shall be set accordingly based on the format
675
676
677
678
679
680
        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
681
682
        of GS-NFV-SOL 005 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
705
706
707
        - 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
708
709
      responses:
        202:
710
          description: >
711
            202 Accepted
712

713
714
715
            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).
716

717
            The response body shall be empty. 
718
719
720
721
722
723
724
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
725
              type: string
726
727
              description: >
                Challenge if the corresponding HTTP request has not provided
728
729
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
730
731
              maximum: 1
              minimum: 0
732
733
734
735
736
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
737
              minimum: 1
738
        204:
739
          description: >
740
            204 No Content
741

742
743
            The NSD content was successfully uploaded and validated (synchronous mode). 
            The response body shall be empty.
744
745
746
747
748
749
750
751
752
753
754
755
756
757
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        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"
758
        409:
759
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED"
760
        412:
761
          $ref: "responses/SOL005_resp.yaml#/responses/412"
762
763
764
765
766
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
767
768
769
770
771
772
          $ref: "responses/SOL005_resp.yaml#/responses/503"


  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
773
  '/pnf_descriptors':
774
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
775
    get:
776
      summary: Query information about multiple PNF descriptor resources.
777
      description: >
778
779
        "The GET method queries information about multiple PNF descriptor
        resources."
780
      parameters:
781
782
783
784
785
        - name: filter
          in: query
          required: false
          type: string
          description: >
786
787
788
789
            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
790
            referenced from it shall be supported by the NFVO in the filter expression.
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
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
        - 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
836
837
      responses:
        200:
838
          description: >
839
            200 OK
840

841
842
843
844
            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
845
846
          headers:
            Content-Type:
847
848
849
850
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
851
            WWW-Authenticate:
852
              type: string
853
854
              description: >
                Challenge if the corresponding HTTP request has not provided
855
856
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
857
858
              maximum: 1
              minimum: 0
859
860
861
862
863
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
864
              minimum: 1
865
866
867
868
869
870
            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
871
          schema:
872
873
874
875
876
877
            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.
878
            type: array
879
            items:
880
881
882
              properties:
                PnfdInfo:
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
        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/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
898
          $ref: "responses/SOL005_resp.yaml#/responses/412"
899
900
901
902
903
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
904
          $ref: "responses/SOL005_resp.yaml#/responses/503"
905
    post:
906
      summary: Create a new PNF descriptor resource.
907
      description: >
908
        The POST method is used to create a new PNF descriptor resource
909
      parameters:
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
        - 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: body
          in: body
          required: true
          schema:
            type: object
            required:
              - CreatePnfdInfoRequest
            properties:
              CreatePnfdInfoRequest:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
            description: >
              Parameters of creating a PNF descriptor resource.
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
950
        201:
951
952
          description: >
            201 Created
953

954
955
956
957
958
959
960
            A PNF descriptor resource was created successfully, as a new PNF descriptor resource.
            The response body shall contain a representation of
            the new PNF descriptor resource, as defined in
            clause 5.5.2.5.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the new
            PNF descriptor resource.            
961
          schema:
962
            type: object
963
964
965
            properties:
              PnfdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
966
967
          headers:
            Content-Type:
968
              type: string
969
970
971
972
              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.
973
            WWW-Authenticate:
974
              type: string
975
976
              description: >
                Challenge if the corresponding HTTP request has not provided
977
                authorization, or error details if the corresponding HTTP request
978
979
                has provided an invalid authorization token.
              maximum: 1
980
981
982
983
984
985
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
986
              minimum: 1
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
        206:
          $ref: "responses/SOL005_resp.yaml#/responses/206"
        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"
For faster browsing, not all history is shown. View entire blame