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

info:
4
  version: "1.2.0"
5
  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
  description: ETSI GS NFV-SOL 005 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
21
basePath: /vnfpkgm/v1
22
schemes:
23
  - http
24
25
  - https
consumes:
26
  - application/json
27
produces:
28
  - application/json
29
paths:
30
  ###############################################################################
31
32
33
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
34
35
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

36
  ###############################################################################
37
38
  # VNF Packages                                                                #
  ###############################################################################
39
40
41
  '/vnf_packages':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
    get:
rameshnaraya's avatar
rameshnaraya committed
42
      summary: Query VNF packages information.
43
      description: >
rameshnaraya's avatar
rameshnaraya committed
44
45
46
47
        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.
48
      parameters:
49
50
        - name: filter
          in: query
51
          required: false
52
          type: string
53
          description: >
54
55
56
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI query string. The
            OSS/BSS may supply this parameter.
57
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
58
            be supported by the NFVO in the filter expression.
59
60
        - name: all_fields
          in: query
61
          required: false
62
          type: string
63
          description: >
rameshnaraya's avatar
rameshnaraya committed
64
65
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
66
67
        - name: fields
          in: query
68
          required: false
69
          type: string
70
          description: >
rameshnaraya's avatar
rameshnaraya committed
71
72
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
73
74
        - name: exclude_fields
          in: query
75
          required: false
76
          type: string
77
          description: >
rameshnaraya's avatar
rameshnaraya committed
78
79
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
80
81
        - name: exclude_default
          in: query
82
          required: false
83
          type: string
84
          description: >
rameshnaraya's avatar
rameshnaraya committed
85
86
87
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            The NFVO shall support this parameter.
88
89
90
91
92
93
            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
94
            - checksum
95
96
97
98
99
100
101
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
102
103
104
105
106
107
108
109
110
111
112
113
114
        - 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
115
          type: string
116
117
118
119
120
121
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
122
123
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
124
          description: >
125
            200 OK
126

127
128
129
130
131
132
133
            Information about zero or more VNF packages was successfully queried.
            The response body shall contain in an array the VNF package info 
            representations that match the attribute filter, i.e., zero or more 
            VNF package info representations as defined in clause 9.5.2.5.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
rameshnaraya's avatar
rameshnaraya committed
134
135
136
137
138
139
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
140
            WWW-Authenticate:
141
              type: string
rameshnaraya's avatar
rameshnaraya committed
142
143
              description: >
                Challenge if the corresponding HTTP request has not provided
144
145
146
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
147
              minimum: 0
148
149
150
151
152
153
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
154
155
156
157
158
159
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
160
          schema:
rameshnaraya's avatar
rameshnaraya committed
161
            type: array
162
            items:
rameshnaraya's avatar
rameshnaraya committed
163
164
              properties:
                VnfPkgInfo:
165
                  $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
166
        400:
167
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
168
        401:
169
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
170
        403:
171
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
172
        404:
173
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
174
        405:
175
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
176
        406:
177
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
178
        416:
179
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
180
        500:
181
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
182
        503:
183
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
184
185

    post:
rameshnaraya's avatar
rameshnaraya committed
186
      summary: Create a new individual VNF package resource.
187
      description: >
rameshnaraya's avatar
rameshnaraya committed
188
        The POST method creates a new individual VNF package resource.
189
      parameters:
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
        - 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
211
212
213
214
215
216
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
217
218
        - name: body
          in: body
219
220
          required: true
          schema:
221
222
223
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
          description: >
            IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
224
225
      responses:
        201:
226
          description: >
227
            201 Created            
228

229
            An individual VNF package resource has been created successfully.
230
231
232
233
234
            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
235
            VNF package resource.
236
          schema:
237
238
            properties:
              VnfPkgInfo:
239
                $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
240
          headers:
241
            Content-Type:
242
              type: string
243
244
245
246
247
              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
248
              minimum: 1
249
            WWW-Authenticate:
250
              type: string
251
252
253
254
255
256
              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
257
258
259
260
261
262
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
263

264
265
266
  ###############################################################################
  # Individual VNF Package                                                      #
  ###############################################################################
267
268
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
269
    parameters:
270
      - name: vnfPkgId
271
272
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
273
274
        in: path
        type: string
275
        required: true
276
    get:
rameshnaraya's avatar
rameshnaraya committed
277
      summary: Read information about an individual VNF package.
278
      description: >
279
        The GET method reads the information of a VNF package.
280
281
282
283
284
285
286
287
288
289
290
291
292
293
      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
294
          type: string
295
296
297
298
299
300
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
301
302
      responses:
        200:
303
304
          description: >
            200 OK
305

306
307
308
            Information of the VNF package was read successfully.
            The response body shall contain the VNF package
            info representation defined in clause 9.5.2.5.     
309
          schema:
310
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya's avatar
rameshnaraya committed
311
312
          headers:
            Content-Type:
313
              type: string
rameshnaraya's avatar
rameshnaraya committed
314
315
316
317
              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:
318
              type: string
rameshnaraya's avatar
rameshnaraya committed
319
320
321
322
              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.
323
324
              maximum: 1
              minimum: 0
325
326
327
328
329
330
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
331
        400:
332
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
333
        401:
334
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
335
        403:
336
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
337
        404:
338
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
339
        405:
340
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
341
        406:
342
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
343
        416:
344
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
345
        500:
346
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
347
        503:
348
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
349
    delete:
rameshnaraya's avatar
rameshnaraya committed
350
      summary: Delete an individual VNF package.
351
      description: >
352
        The DELETE method deletes an individual VNF Package resource.
353
354
355
356
357
358
359
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
360
          type: string
361
362
363
364
365
366
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
367
368
369
      responses:
        204:
          description: >
370
            204 No Content
371

rameshnaraya's avatar
rameshnaraya committed
372
373
            The VNF package was deleted successfully.
            The response body shall be empty.
374
        400:
375
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
376
        401:
377
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
378
        403:
379
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
380
        404:
381
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
382
        405:
383
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
384
        406:
385
386
387
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
388
        416:
389
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
390
        500:
391
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
392
        503:
393
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
394
    patch:
rameshnaraya's avatar
rameshnaraya committed
395
      summary: Update information about an individual VNF package.
396
      description: >
397
        "The PATCH method updates the information of a VNF package."
398

399
400
401
402
        "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:
403
404
        - name: body
          in: body
405
406
          required: true
          schema:
407
408
409
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
          description: >
            Parameters for VNF package information modifications.
410
411
412
413
414
415
416
417
418
419
420
421
422
423
        - 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
424
425
426
427
428
429
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
430
      responses:
431
        200:
rameshnaraya's avatar
rameshnaraya committed
432
          description: >
433
            200 OK
434

rameshnaraya's avatar
rameshnaraya committed
435
            The operation was completed successfully.
436
            The response body shall contain attribute
rameshnaraya's avatar
rameshnaraya committed
437
438
            modifications for an "Individual VNF
            package" resource
439
440
441
442
443
444
445
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
446
              type: string
447
448
              description: >
                Challenge if the corresponding HTTP request has not provided
449
450
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
451
452
              maximum: 1
              minimum: 0
453
454
455
456
457
458
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
459
          schema:
460
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
461
        400:
462
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
463
        401:
464
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
465
        403:
466
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
467
        404:
468
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
469
        405:
470
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
471
        406:
472
473
474
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
475
        416:
476
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
477
        500:
478
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
479
        503:
480
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
481
482
483
484

  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
485
486
487
488
489
  '/vnf_packages/{vnfPkgId}/vnfd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4
    parameters:
      - name: vnfPkgId
        description: >
Samir Medjiah's avatar
Samir Medjiah committed
490
          Identifier of the VNF package. The identifier is allocated by the NFVO.
491
492
        in: path
        type: string
493
        required: true
494
    get:
rameshnaraya's avatar
rameshnaraya committed
495
      summary: Read VNFD of an on-boarded VNF package.
496
      description: >
rameshnaraya's avatar
rameshnaraya committed
497
        The GET method reads the content of the VNFD within a VNF package.
498

rameshnaraya's avatar
rameshnaraya committed
499
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
500
501
502
503
504
505
506
507
508
509
510
511
512
        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
513
        request and response data structures, and response codes.
514
      parameters:
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
        - 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
531
532
533
534
535
536
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
537
538
      responses:
        200:
539
          description: >
540
            200 OK
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556

            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:
557
              type: string
558
559
              description: >
                Challenge if the corresponding HTTP request has not provided
560
561
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
562
563
              maximum: 1
              minimum: 0
564
565
566
567
568
569
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
570
        400:
571
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
572
        401:
573
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
574
        403:
575
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
576
        404:
577
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
578
        405:
579
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
580
        406:
581
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
582
        409:
583
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
584
        416:
585
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
586
        500:
587
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
588
        503:
589
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
590
591
592
593

  ###############################################################################
  # VNF Package Content                                                         #
  ###############################################################################
594
  '/vnf_packages/{vnfPkgId}/package_content':
595
596
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
    parameters:
597
      - name: vnfPkgId
598
        description: >
Samir Medjiah's avatar
Samir Medjiah committed
599
          Identifier of the VNF package. The identifier is allocated by the NFVO.
600
        in: path
601
        required: true
602
        type: string
603
    get:
rameshnaraya's avatar
rameshnaraya committed
604
      summary: Fetch an on-boarded VNF package.
605
      description: >
rameshnaraya's avatar
rameshnaraya committed
606
607
608
        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.
609
      parameters:
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
        - 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
625
626
        - name: Range
          in: header
627
          required: false
628
          type: string
629
630
631
632
633
634
635
          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.
636
637
638
639
640
641
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
642
643
      responses:
        200:
644
          description: >
645
            200 OK
646
647
648
649
650
651
652
653
654
655
656
657
658
659

            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:
660
              type: string
661
662
              description: >
                Challenge if the corresponding HTTP request has not provided
663
664
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
665
666
              maximum: 1
              minimum: 0
667
668
669
670
671
672
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
673
        206:
674
          $ref: "../responses/SOL005_resp.yaml#/responses/206"
675
        400:
676
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
677
        401:
678
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
679
        403:
680
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
681
        404:
682
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
683
        405:
684
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
685
        406:
686
687
688
689
690
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
691
        500:
692
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
693
        503:
694
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
695

696
    put:
rameshnaraya's avatar
rameshnaraya committed
697
      summary: Upload a VNF package by providing the content of the VNF package.
698
      description: >
rameshnaraya's avatar
rameshnaraya committed
699
700
701
702
        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.
703
      consumes:
704
        - multipart/form-data
705
      parameters:
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
        - 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].
730
731
732
733
734
735
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
736
737
      responses:
        202:
738
          description: >
739
            202 Accepted
740

rameshnaraya's avatar
rameshnaraya committed
741
742
743
744
            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.
745
        400:
746
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
747
        401:
748
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
749
        403:
750
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
751
        404:
752
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
753
        405:
754
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
755
        406:
756
757
758
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
759
        500:
760
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
761
        503:
762
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
763

764
765
766
  ###############################################################################
  # Upload VNF package from URI task                                            #
  ###############################################################################
767
768
769
  '/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
770
      summary: Upload a VNF package by providing the address information of the VNF package.
771
      description: >
772
773
774
775
        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.        
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
      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
798
        - name: vnfPkgId
799
800
          description: >
            Identifier of the VNF package. The identifier is allocated by the NFVO.
801
          in: path
802
          required: true
803
804
805
          type: string
        - name: body
          in: body
806
807
          required: true
          schema:
808
809
810
811
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
          description: >
            The payload body contains the address information based on
            which the NFVO can obtain the content of the VNF package.
812
813
814
815
816
817
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
818
819
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
820
          description: >
821
            202 Accepted
822

rameshnaraya's avatar
rameshnaraya committed
823
            The information about the VNF package was received
824
825
            successfully, but the on-boarding has not been
            completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
826
            The response body shall be empty.
827
        409:
828
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
829
        400:
830
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
831
        401:
832
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
833
        403:
834
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
835
        404:
836
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
837
        405:
838
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
839
        406:
840
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
841
        500:
842
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
843
        503:
844
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
845
846
847
848

  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
849
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
850
851
852
853
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7
    parameters:
      - name: vnfPkgId
        description: >
854
          Identifier of the VNF package.
855
856
857
858
859
860
861
862
          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: >
863
864
865
866
867
868
869
          Sequence of one or path segments representing the path of the artifact 
          within the VNF package.
          EXAMPLE: foo/bar/run.sh
          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.
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
        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
903
904
905
906
907
908
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
      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:
927
              type: string