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