NSDManagement.yaml 94.1 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
16
17
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact: 
    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
32
###############################################################################
# NS Descriptors                                                              #
###############################################################################
  '/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
38
39
40
      description: > 
        "The GET method queries information about multiple NS descriptor resources.
        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,
        request and response data structures, and response codes."
41
      parameters:
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
        - name: "filter"
          in: "query"
          required: false
          type: "string"
          description: >  
            "Attribute-based filtering parameters according to clause 4.3.2.
            The NFVO shall support receiving filtering parameters as part of the URI query
            string. The OSS/BSS may supply filtering parameters.
            All attribute names that appear in the NsdInfo and in data types referenced from
            it shall be supported in attribute-based filtering parameters."
        - 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 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:
            userDefinedData."
        - 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
97
98
99
100
101
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
102
          required: true
103
          type: string
104
105
      responses:
        200:
106
          description: >
107
            200 OK
108
109
            
            Information about zero or more NS descriptors.
110
111
            The response body shall contain a representation of
            zero or more NS descriptors, as defined in
112
            clause 5.5.2.2
113
114
          headers:
            Content-Type:
115
              description: The MIME type of the body of the response.
116
117
118
              type: string
              maximum: 1
              minimum: 1
119
            WWW-Authenticate:
120
              type: "string"
121
122
              description: >
                Challenge if the corresponding HTTP request has not provided
123
124
125
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
126
127
128
129
130
131
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
132
              minimum: 1
133
134
135
136
137
138
          schema:
            type: array
            items:
              properties:
                NsdInfo:
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"                   
139
        400:
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
          $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:
          $ref: "responses/SOL005_resp.yaml#/responses/412"           
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"    
161
    post:
162
      summary: Create a new NS descriptor resource.
163
      description: >  
164
165
        The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor.
      parameters:    
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
      - 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
186
        type: string
187
188
189
190
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
191
        required: true
192
        type: string
193
194
195
196
197
198
199
200
201
202
203
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "CreateNsdInfoRequest"
          properties:
            CreateNsdInfoRequest:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
          description: >
204
            Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3
205
206
      responses:
        201:
207
208
209
210
211
212
213
214
215
          description: >
            Status 201
            
            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.            
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
          schema:
            type: "object"
            properties:
              NsdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
          headers:
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
233
234
                has provided an invalid authorization token.
              maximum: 1
235
236
237
238
239
240
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
241
              minimum: 1
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
        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:
          $ref: "responses/SOL005_resp.yaml#/responses/412"          
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
263
264
          $ref: "responses/SOL005_resp.yaml#/responses/503"  
          
265
266
267
268
###############################################################################
# Individual NS Descriptor                                                    #
###############################################################################                
  '/ns_descriptors/{nsdInfoId}':
269
270
271
272
273
274
275
276
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
      - name: "nsdInfoId"
        description: >
          Identifier of the individual NS descriptor resource.
        in: "path"
        required: true
        type: "string"    
277
    get:
278
      summary: Read information about an individual NS descriptor resource.
279
280
281
282
283
      description: >  
        "The GET method reads information about an individual NS descriptor.
        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,
        request and response data structures, and response codes."
284
      parameters:
285
286
287
288
289
290
291
292
293
294
295
296
297
        - 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
298
299
300
301
302
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
303
          required: true
304
          type: string
305
306
      responses:
        200:
307
308
309
310
311
312
          description: >
            200 OK
            
            Information about the individual NS descriptor.
            The response body shall contain a representation of
            the individual NS descriptor.            
313
          schema:
314
            type: "object"            
315
316
317
            properties:
              NsdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
318
          headers:
319
320
321
322
323
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
324
            WWW-Authenticate:
325
              type: "string"
326
327
              description: >
                Challenge if the corresponding HTTP request has not provided
328
329
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
330
331
              maximum: 1
              minimum: 0
332
333
334
335
336
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
337
              minimum: 1
338
339
340
341
342
343
344
345
346
347
348
349
        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"
350
        409:
351
352
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
353
          $ref: "responses/SOL005_resp.yaml#/responses/412"        
354
355
356
357
358
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
359
          $ref: "responses/SOL005_resp.yaml#/responses/503"
360
    patch:
361
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
362
      description: >  
363
        The PATCH method modifies the operational state and/or user defined
364
365
366
367
368
369
370
371
        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.
372
      parameters:
373
      - name: "body"
374
375
376
377
378
379
380
381
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "NsdInfoModifications"
          properties:
            NsdInfoModifications:
382
383
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
          description: >  
384
            Parameters for the modification of an individual NS descriptor resource.
385
386
387
388
389
390
391
392
393
394
395
396
397
      - 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
398
399
400
401
402
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
403
        required: true
404
        type: string
405
      responses:      
406
        200:
407
          description: >
408
409
            200 OK
            
410
411
412
413
            The operation was completed successfully.
            The response body shall contain attribute
            modifications for an 'Individual NS Descriptor'
            resource.
414
415
          headers:
            Content-Type:
416
417
418
419
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
420
            WWW-Authenticate:
421
              type: "string"
422
423
              description: >
                Challenge if the corresponding HTTP request has not provided
424
425
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
426
427
              maximum: 1
              minimum: 0
428
429
430
431
432
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
433
              minimum: 1
434
          schema:
435
436
            type: array
            items:
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
              properties:
                NsdInfoModifications:            
                  $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:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
          
    delete:
464
      summary: Delete an individual NS descriptor resource.
465
466
467
468
469
470
471
472
473
474
475
476
      description: >  
        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
477
478
479
480
481
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
482
          required: true
483
          type: string
484
485
486
487
488
489
490
491
492
      responses:
        204:
          description: >  
            204 No Content
            
            The operation has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
493
              type: "string"
494
495
              description: >
                Challenge if the corresponding HTTP request has not provided
496
497
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
498
499
              maximum: 1
              minimum: 0
500
501
502
503
504
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
505
              minimum: 1
506
507
508
509
510
511
512
513
514
515
516
517
518
519
        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"
520
        412:
521
522
523
524
525
526
527
528
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"  
          
529
      
530
531
532
533
###############################################################################
# NSD Content                                                                 #
###############################################################################         
  '/ns_descriptors/{nsdInfoId}/nsd_content':
534
535
536
537
538
539
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
      - name: "nsdInfoId"
        in: "path"
        required: true
        type: "string"    
540
    get:
541
      summary: Fetch the content of a NSD.
542
      description: >  
543
544
545
        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
546
547
548
549
550
551
552
553
554
555
556
        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
557
        of the NSD zip file is outside the scope of the present document.
558
      parameters:
559
560
561
562
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
        in: header
563
        required: true
564
565
566
567
568
569
570
571
572
        type: string
        enum: 
          - text/plain
          - application/zip
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
573
        required: false
574
575
        type: string
      - name: "Range"
576
577
578
        in: "header"
        required: false
        type: "string"
579
580
581
582
583
584
585
        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)."
586
587
588
589
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
590
        required: true
591
        type: string
592
593
      responses:
        200:
594
          description: >  
595
596
            200 OK
            
597
598
599
600
601
602
603
604
605
            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.
606
607
          headers:
            Content-Type:
608
609
610
611
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
612
            WWW-Authenticate:
613
              type: "string"
614
615
              description: >
                Challenge if the corresponding HTTP request has not provided
616
617
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
618
619
              maximum: 1
              minimum: 0
620
621
622
623
624
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
625
              minimum: 1
626
        206:
627
628
629
630
631
632
633
634
635
636
637
          $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"
638
        406:
639
          $ref: "responses/SOL005_resp.yaml#/responses/406"
640
        409:
641
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED"
642
643
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
644
        416:
645
646
647
648
649
650
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"           
              
651
    put:
652
      summary: Upload the content of a NSD.
653
654
655
      description: >  
        "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
656
657
658
659
660
        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"
661
        HTTP header in the PUT request shall be set accordingly based on the format
662
663
664
665
666
667
        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
668
669
        of GS-NFV-SOL 005 for URI query parameters, request and response data structures,
        and response codes."
670
      parameters:
671
672
673
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
674
675
          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.
676
        in: header
677
        required: true
678
679
680
681
682
683
684
685
686
687
688
        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
689
690
691
692
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
693
        required: true
694
        type: string
695
696
      responses:
        202:
697
          description: >  
698
            202 Accepted
699
700
701
702
703
704
            
            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).
            
            The response body shall be empty. 
705
706
707
708
709
710
711
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
712
              type: "string"
713
714
              description: >
                Challenge if the corresponding HTTP request has not provided
715
716
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
717
718
              maximum: 1
              minimum: 0
719
720
721
722
723
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
724
              minimum: 1
725
        204:
726
          description: >  
727
728
729
730
            204 No Content
            
            The NSD content was successfully uploaded and validated (synchronous mode). 
            The response body shall be empty.
731
732
733
734
735
736
737
738
739
740
741
742
743
744
        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"
745
        409:
746
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED"
747
748
749
750
751
752
753
754
755
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
          
756
     
757
758
759
760
###############################################################################
# PNF Descriptors                                                             #
###############################################################################      
  '/pnf_descriptors':
761
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
762
    get:
763
      summary: Query information about multiple PNF descriptor resources.
764
765
766
      description: >  
        "The GET method queries information about multiple PNF descriptor
        resources."
767
      parameters:
768
      - name: "filter"
769
770
771
        in: "query"
        required: false
        type: "string"
772
773
774
775
776
777
        description: >  
          Attribute-based filtering parameters according to clause 4.3.2.
          The NFVO shall support receiving filtering parameters as part of the URI
          query string. The OSS/BSS may supply filtering parameters.
          All attribute names that appear in the PnfdInfo and in data types referenced
          from it shall be supported in attribute-based filtering parameters.
778
779
780
781
      - name: "all_fields"
        in: "query"
        required: false
        type: "string"
782
783
784
785
786
        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"
787
788
        required: false
        type: "string"
789
790
791
792
793
794
795
796
797
798
799
800
        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"
801
802
        required: false
        type: "string"
803
804
805
806
807
808
809
        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.
810
811
812
813
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
814
        required: true
815
        type: string
816
817
      responses:
        200:
818
819
820
821
822
823
824
          description: >  
            200 OK
            
            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
825
826
          headers:
            Content-Type:
827
828
829
830
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
831
            WWW-Authenticate:
832
              type: "string"
833
834
              description: >
                Challenge if the corresponding HTTP request has not provided
835
836
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
837
838
              maximum: 1
              minimum: 0
839
840
841
842
843
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
844
              minimum: 1
845
          schema:
846
            type: "array"
847
            items:
848
849
850
              properties:
                PnfdInfo:
                  $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
        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:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"                
873
    post:
874
      summary: Create a new PNF descriptor resource.
875
      description: >  
876
        The POST method is used to create a new PNF descriptor resource
877
      parameters:
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
      - 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
899
900
901
902
903
904
905
906
907
908
909
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "CreatePnfdInfoRequest"
          properties:
            CreatePnfdInfoRequest:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
          description: >
910
911
912
913
914
            Parameters of creating a PNF descriptor resource.
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
915
        required: true
916
        type: string
917
      responses:    
918
        201:
919
920
921
922
923
924
925
926
927
928
          description: >
            201 Created
            
            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.            
929
930
931
932
933
          schema:
            type: "object"
            properties:
              PnfdInfo:
                $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
934
935
          headers:
            Content-Type:
936
937
938
939
940
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
941
            WWW-Authenticate:
942
              type: "string"
943
944
              description: >
                Challenge if the corresponding HTTP request has not provided
945
                authorization, or error details if the corresponding HTTP request
946
947
                has provided an invalid authorization token.
              maximum: 1
948
949
950
951
952
953
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
954
              minimum: 1
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
        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"
        409:
          $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"         
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"               
###############################################################################
# Individual PNF Descriptor                                                   #
###############################################################################               
  '/pnf_descriptors/{pnfdInfoId}':
983
984
985
986
987
988
989
990
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
    parameters:
      - name: "pnfdInfoId"
        description: >
          Identifier of the individual PNF descriptor resource.
        in: "path"
        required: true
        type: "string"    
991
    get:
992
      summary: Read an individual PNFD resource.
993
      description: >  
994
        The GET method reads information about an individual PNF descriptor.
995
996
        This method shall follow the provisions specified in the Tables 5.4.6.3.2-1
        and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and
997
998
999
1000
        response data structures, and response codes.
      parameters:
      - name: "Accept"
        in: "header"
For faster browsing, not all history is shown. View entire blame