VNFPackageManagement.yaml 45.7 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
5
  version: "1.1.0"
  title: SOL005 - VNF Package Management Interface
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - VNF Package Management Interface
8
9
10
11
12
13
14
15
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact: 
17
18
    name: "NFV-SOL WG"
externalDocs:
19
20
21
  description: ETSI GS NFV-SOL 005 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/vnfpkgm/v1"
22
23
24
schemes:
  - https
consumes:
25
  - "application/json"
26
produces:
27
  - "application/json"  
28
paths:
29
30
31
###############################################################################
# VNF Packages                                                                #
###############################################################################
32
33
34
  '/vnf_packages':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
    get:
rameshnaraya's avatar
rameshnaraya committed
35
      summary: Query VNF packages information.
36
      description: > 
rameshnaraya's avatar
rameshnaraya committed
37
38
39
40
        The GET method queries the information of the VNF packages matching the filter.
        This method shall follow the provisions specified in the 
        Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
41
      parameters:
42
43
        - name: "filter"
          in: "query"
44
          required: false
45
46
47
48
49
          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.
50
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
51
52
53
            be supported in attribute-based filtering parameters.
        - name: "all_fields"
          in: "query"
54
          required: false
55
56
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
57
58
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
59
60
        - name: "fields"
          in: "query"
61
          required: false
62
63
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
64
65
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
66
67
        - name: "exclude_fields"
          in: "query"
68
          required: false
69
70
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
71
72
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
73
74
        - name: "exclude_default"
          in: "query"
75
          required: false
76
77
          type: "string"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
78
79
80
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            The NFVO shall support this parameter.
81
82
83
84
85
86
            The following attributes shall be excluded from the VnfPkgInfo structure in the response
            body if this parameter is provided, or none of the parameters "all_fields," "fields",
            "exclude_fields", "exclude_default" are provided:
            - softwareImages
            - additionalArtifacts
            - userDefinedData
rameshnaraya's avatar
rameshnaraya committed
87
            - checksum
88
89
90
91
92
93
94
95
96
97
98
99
100
        - 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
101
          type: string      
102
103
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
104
          description: >
105
            200 OK
106
107
            
            Information of the selected VNF packages.
rameshnaraya's avatar
rameshnaraya committed
108
109
110
111
112
113
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
114
115
            WWW-Authenticate:            
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
116
117
              description: >
                Challenge if the corresponding HTTP request has not provided
118
119
120
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
121
              minimum: 0                 
122
          schema:
rameshnaraya's avatar
rameshnaraya committed
123
            type: array
124
            items:
rameshnaraya's avatar
rameshnaraya committed
125
126
              properties:
                VnfPkgInfo:
127
                  $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
128
        400:
129
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
130
        401:
131
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
132
        403:
133
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
134
        404:
135
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
136
        405:
137
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
138
        406:
139
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
140
        416:
141
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
142
        500:
143
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
144
        503:
145
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
146
147

    post:
rameshnaraya's avatar
rameshnaraya committed
148
      summary: Create a new individual VNF package resource.
149
      description: >  
rameshnaraya's avatar
rameshnaraya committed
150
        The POST method creates a new individual VNF package resource.
151
      parameters:
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
      - 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:
          - "CreateVnfPkgInfoRequest"
          properties:
            CreateVnfPkgInfoRequest:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
183
184
          description: >
            IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
185
            
186
187
      responses:
        201:
188
          description: >  
189
            201 Created            
190
            
191
            An individual VNF package resource has been created successfully.
192
193
194
195
196
            The response body shall contain a representation of
            the new individual VNF package resource, as defined
            in clause 9.5.2.4.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the individual
197
            VNF package resource.
198
          schema:
199
200
            properties:
              VnfPkgInfo:
201
                $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
202
          headers:
203
            Content-Type:
204
              type: "string"
205
206
207
208
209
              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.
              maximum: 1
210
              minimum: 1                
211
            WWW-Authenticate:
212
              type: "string"
213
214
215
216
217
218
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
219
220
221
###############################################################################
# Individual VNF Package                                                      #
###############################################################################                
222
223
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
224
    parameters:
225
      - name: "vnfPkgId"
226
227
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
228
229
        in: "path"
        type: "string" 
230
        required: true
231
    get:
rameshnaraya's avatar
rameshnaraya committed
232
      summary: Read information about an individual VNF package.
233
      description: >  
234
        The GET method reads the information of a VNF package.
235
236
237
238
239
240
241
242
243
244
245
246
247
248
      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
249
          type: string      
250
251
      responses:
        200:
252
253
          description: >
            200 OK
254
255
            
            Information of the VNF package.            
256
          schema:
257
258
259
260
            type: "object"   
            properties:
              VnfPkgInfo:
                $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya's avatar
rameshnaraya committed
261
262
          headers:
            Content-Type:
263
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
264
265
266
267
              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:
268
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
269
270
271
272
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
273
274
              maximum: 1
              minimum: 0
275
        400:
276
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
277
        401:
278
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
279
        403:
280
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
281
        404:
282
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
283
        405:
284
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
285
        406:
286
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
287
        416:
288
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
289
        500:
290
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
291
        503:
292
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
293
    delete:
rameshnaraya's avatar
rameshnaraya committed
294
      summary: Delete an individual VNF package.
295
      description: >  
296
        The DELETE method deletes an individual VNF Package resource.
297
298
299
300
301
302
303
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
304
          type: string          
305
306
307
      responses:
        204:
          description: >
308
            204 No Content
309
            
rameshnaraya's avatar
rameshnaraya committed
310
311
            The VNF package was deleted successfully.
            The response body shall be empty.
312
313
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
314
        400:
315
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
316
        401:
317
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
318
        403:
319
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
320
        404:
321
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
322
        405:
323
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
324
        406:
325
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
326
        416:
327
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
328
        500:
329
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
330
        503:
331
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
332
    patch:
rameshnaraya's avatar
rameshnaraya committed
333
      summary: Update information about an individual VNF package.
334
      description: >  
335
        "The PATCH method updates the information of a VNF package."
336
        
337
338
339
340
        "This method shall follow the provisions specified in the 
        Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters,
        request and response data structures, and response codes."
      parameters:
341
342
343
344
345
346
347
348
349
350
351
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "VnfPkgInfoModifications"
          properties:
            VnfPkgInfoModifications:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
          description: >  
352
            Parameters for VNF package information modifications.
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
      - 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:          
368
        200:
rameshnaraya's avatar
rameshnaraya committed
369
          description: >
370
            200 OK
371
            
rameshnaraya's avatar
rameshnaraya committed
372
            The operation was completed successfully.
373
            The response body shall contain attribute
rameshnaraya's avatar
rameshnaraya committed
374
375
            modifications for an "Individual VNF
            package" resource
376
377
378
379
380
381
382
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
383
              type: "string"
384
385
              description: >
                Challenge if the corresponding HTTP request has not provided
386
387
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
388
389
390
              maximum: 1
              minimum: 0
          schema:
391
392
393
394
395
            properties:
              VnfPkgInfoModifications:            
                $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
396
        400:
397
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
398
        401:
399
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
400
        403:
401
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
402
        404:
403
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
404
        405:
405
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
406
        406:
407
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
408
        416:
409
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
410
        500:
411
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
412
        503:
413
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
414
415
416
417
          
###############################################################################
# VNFD in an individual VNF package                                           #
###############################################################################         
418
419
420
421
422
  '/vnf_packages/{vnfPkgId}/vnfd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4
    parameters:
      - name: vnfPkgId
        description: >
423
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
424
425
        in: path
        type: string
426
        required: true   
427
    get:
rameshnaraya's avatar
rameshnaraya committed
428
      summary: Read VNFD of an on-boarded VNF package.
429
      description: >  
rameshnaraya's avatar
rameshnaraya committed
430
        The GET method reads the content of the VNFD within a VNF package.
431
        
rameshnaraya's avatar
rameshnaraya committed
432
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
433
434
435
436
437
438
439
440
441
442
443
444
445
        form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD 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 VNFD 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
        VNFD 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 VNFD; for a multi-file VNFD, a ZIP file shall be returned.
        The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 004 [5] where only the YAML files
        representing the VNFD, and information necessary to navigate the ZIP file and to identify the file that is the entry point
        for parsing the VNFD (such as TOSCA-meta or manifest files or naming conventions) are included.
        This method shall follow the provisions specified in the Tables 9.4.4.3.2-1 and 9.4.4.3.2-2 for URI query parameters,
rameshnaraya's avatar
rameshnaraya committed
446
        request and response data structures, and response codes.
447
      parameters:
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
      - 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
464
465
      responses:
        200:
466
          description: > 
467
            200 OK
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483

            On success, the content of the VNFD is returned.
            The payload body shall contain a copy of the file
            representing the VNFD or a ZIP file that contains the
            file or multiple files representing the VNFD, 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.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
484
              type: "string"
485
486
              description: >
                Challenge if the corresponding HTTP request has not provided
487
488
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
489
490
491
              maximum: 1
              minimum: 0
        400:
492
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
493
        401:
494
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
495
        403:
496
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
497
        404:
498
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
499
        405:
500
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
501
        406:
502
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
503
        409:
504
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
505
        416:
506
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
507
        500:
508
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
509
        503:
510
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
511
512
513
514
          
###############################################################################
# VNF Package Content                                                         #
###############################################################################         
515
  '/vnf_packages/{vnfPkgId}/package_content':
516
517
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
    parameters:
518
      - name: "vnfPkgId"
519
        description: >
520
521
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
        in: "path"
522
        required: true
523
        type: "string"    
524
    get:
rameshnaraya's avatar
rameshnaraya committed
525
      summary: Fetch an on-boarded VNF package.
526
      description: >  
rameshnaraya's avatar
rameshnaraya committed
527
528
529
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
        This method shall follow the provisions specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
530
      parameters:
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
        in: header
        required: true
        type: string
        enum:
          - 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 VNF package file. This can be used to
          continue an aborted transmission.
           
          If the NFVO does not support range requests, it should return the
          whole file with a 200 OK response instead.
557
558
      responses:
        200:
559
          description: > 
560
            200 OK
561
562
563
564
565
566
567
568
569
570
571
572
573
574

            On success, a copy of the VNF package file is returned.
            The response body shall include a copy of the VNF package file.
            The "Content-Type" HTTP header shall be set
            according to the type of the file, i.e. to "application/zip"
            for a VNF Package as defined in ETSI
            GS NFV-SOL 004 [5].
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
575
              type: "string"
576
577
              description: >
                Challenge if the corresponding HTTP request has not provided
578
579
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
580
581
582
              maximum: 1
              minimum: 0
        206:
583
          $ref: "../responses/SOL005_resp.yaml#/responses/206"
584
585
586
587
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
588
        400:
589
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
590
        401:
591
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
592
        403:
593
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
594
        404:
595
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
596
        405:
597
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
598
        406:
599
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
600
        500:
601
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
602
        503:
603
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
604
              
605
    put:
rameshnaraya's avatar
rameshnaraya committed
606
      summary: Upload a VNF package by providing the content of the VNF package.
607
      description: >  
rameshnaraya's avatar
rameshnaraya committed
608
609
610
611
        The PUT method uploads the content of a VNF package.
        This method shall follow the provisions specified in the 
        Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters,
        request and response data structures, and response codes.
612
      consumes:
613
        - multipart/form-data        
614
      parameters:
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
      - name: Accept
        description: >
          Content-Types that are acceptable for the response.
        in: header
        required: true
        type: string
        enum: 
          - application/zip
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - in: formData
        name: file
        required: false
        type: file
        description: >
          The payload body contains a ZIP file that represents the VNF package.
          The "Content-Type" HTTP header shall be set according to the
          type of the file, i.e. to "application/zip" for a VNF Package as
          defined in ETSI GS NFV-SOL 004 [5].      
639
640
      responses:
        202:
641
          description: > 
642
            202 Accepted
643
            
rameshnaraya's avatar
rameshnaraya committed
644
645
646
647
            The VNF package was accepted for uploading, but the
            processing has not been completed. It is expected to
            take some time for processing.
            The response body shall be empty.
648
649
650
        409:
          description: >         
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
651
        400:
652
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
653
        401:
654
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
655
        403:
656
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
657
        404:
658
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
659
        405:
660
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
661
        406:
662
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
663
        500:
664
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
665
        503:
666
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
667

668
669
670
###############################################################################
# Upload VNF package from URI task                                            #
###############################################################################         
671
672
673
  '/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6   
    post:
rameshnaraya's avatar
rameshnaraya committed
674
      summary: Upload a VNF package by providing the address information of the VNF package.
675
      description: >          
676
677
678
679
        The POST method provides the information for the NFVO to get the content of a VNF package.
        This method shall follow the provisions specified in the 
        Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters,
        request and response data structures, and response codes.        
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
      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: "vnfPkgId"
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.
        in: "path"
        required: true
        type: "string"          
        
      - name: "body"
        in: "body"
        required: true
        schema:
          type: "object"
          required:
          - "UploadVnfPkgFromUriRequest"
          properties:
            UploadVnfPkgFromUriRequest:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
720
721
          description: >
            The payload body contains the address information based on
722
723
            which the NFVO can obtain the content of the VNF package.         
          
724
725
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
726
          description: >
727
            202 Accepted
728
            
rameshnaraya's avatar
rameshnaraya committed
729
            The information about the VNF package was received
730
731
            successfully, but the on-boarding has not been
            completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
732
            The response body shall be empty.
733
        409:
734
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
735
        400:
736
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
737
        401:
738
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
739
        403:
740
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
741
        404:
742
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
743
        405:
744
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
745
        406:
746
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
747
        500:
748
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
749
        503:
750
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
751
752
753
754
          
###############################################################################          
# Individual VNF package artifact                                             #     
###############################################################################
755
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
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
875
876
877
878
879
880
881
882
883
884
885
   #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7      
   parameters:
     - name: vnfPkgId
       description: >
         Identifier of the on-boarded VNF package. 
         The identifier is allocated by the NFVO.
         This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
         VnfPackageChangeNotification.
       in: path
       type: string
       required: true    
     - name: artifactPath
       description: >
         Path of the artifact within the VNF package. 
         This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts" entry in
         the body of the response to a GET request querying the "Individual VNF package" or the "VNF packages"
         resource.
       in: path
       type: string
       required: true
   get:
     summary: Fetch individual VNF package artifact.
     description: >
       The GET method fetches the content of an artifact within a VNF package.
       This method shall follow the provisions specified in the 
       Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters,
       request and response data structures, and response codes.
     parameters:
       - name: Accept
         description: >
           Content-Types that are acceptable for the response.
         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: Range
         description: >
           The request may contain a "Range" HTTP header to obtain single
           range of bytes from the VNF package file. This can be used to
           continue an aborted transmission.
           If the NFVO does not support range requests, it should return the
           whole file with a 200 OK response instead.
         in: header
         type: string
     responses:
       200:
         description: > 
           200 OK
            On success, the content of the artifact is returned.
           The payload body shall contain a copy of the artifact file from
           the VNF package, as defined by ETSI GS NFV-SOL 004.
           The "Content-Type" HTTP header shall be set according to the
           content type of the artifact file. If the content type cannot be
           determined, the header shall be set to the value
           "application/octet-stream".
         headers:
           Content-Type:
             description: The MIME type of the body of the response.
             type: string
             maximum: 1
             minimum: 1           
           WWW-Authenticate:
             type: "string"
             description: >
               Challenge if the corresponding HTTP request has not provided
               authorization, or error details if the corresponding HTTP request
               has provided an invalid authorization token.
             maximum: 1
             minimum: 0
               
       206:
         description: > 
           Partial Content.
           On success, if the NFVO supports range requests, a single
           consecutive byte range from the content of the VNF package file is
           returned.
           The response body shall contain the requested part of the VNF
           package file.
           The "Content-Range" HTTP header shall be provided according to
           IETF RFC 7233.
           The "Content-Type" HTTP header shall be set as defined above for
           the "200 OK" response.
         headers:
           Content-Range:
             type: string
             maximum: 1
             minimum: 1
           Content-Type:
             description: The MIME type of the body of the response.
             type: string
             maximum: 1
             minimum: 1           
           WWW-Authenticate:
             type: "string"
             description: >
               Challenge if the corresponding HTTP request has not provided
               authorization, or error details if the corresponding HTTP request
               has provided an invalid authorization token.
             maximum: 1
             minimum: 0               
       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/SOL005_resp.yaml#/responses/409"
       416:
         $ref: "../responses/SOL005_resp.yaml#/responses/416"
       500:
         $ref: "../responses/SOL005_resp.yaml#/responses/500"
       503:
         $ref: "../responses/SOL005_resp.yaml#/responses/503"
         
##############################################################################
# Subscriptions                                                               #
###############################################################################
886
  '/subscriptions':
887
   #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8   
888
    post:
rameshnaraya's avatar
rameshnaraya committed
889
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
890
      description: >   
891
        The POST method creates a new subscription.
rameshnaraya's avatar
rameshnaraya committed
892
893
894
895
896
897
898
899
        This method shall follow the provisions specified in the Tables 9.4.8.3.1-1 and 9.4.8.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
        Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
        same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
        to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
        the existing subscription resource with the same filter and callbackUri).
900
      parameters:
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
      - 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:
          - "PkgmSubscriptionRequest"
          properties:
            PkgmSubscriptionRequest:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
932
933
934
935
          description: >
            Representation of the created subscription resource.
            The HTTP response shall include a "Location" HTTP header that
            points to the created subscription resource.
936
            
937
938
      responses:
        201:
rameshnaraya's avatar
rameshnaraya committed
939
          description: >
940
            201 Created
941
            
942
            Representation of the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
943
944
            The HTTP response shall include a "Location"
            HTTP header that points to the created subscription resource.
945
946
947
948
949
950
951
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
952
              type: "string"
953
954
              description: >
                Challenge if the corresponding HTTP request has not provided
955
956
957
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
958
              minimum: 0              
959
960
961
          schema:
            type: array
            items:
962
963
964
              properties:
                PkgmSubscription:
                  $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
965
        303:
966
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
967
        400:
968
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
969
        401:
970
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
971
        403:
972
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
973
        404:
974
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
975
        405:
976
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
977
        406:
978
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
979
        416:
980
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
981
        500:
982
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
983
        503:
984
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
985
    get:
986
      summary: Query multiple subscriptions.
moscatelli's avatar