VNFPackageManagement.yaml 44.4 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.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf

22
basePath: /vnfpkgm/v1
23
24
25
schemes:
  - https
consumes:
26
  - application/json
27
produces:
28
  - application/json
29
paths:
30
31
32
  ###############################################################################
  # VNF Packages                                                                #
  ###############################################################################
33
34
35
  '/vnf_packages':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2
    get:
rameshnaraya's avatar
rameshnaraya committed
36
      summary: Query VNF packages information.
37
      description: >
rameshnaraya's avatar
rameshnaraya committed
38
39
40
41
        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.
42
      parameters:
43
44
        - name: filter
          in: query
45
          required: false
46
          type: string
47
          description: >
48
49
50
            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.
51
            All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
52
            be supported in attribute-based filtering parameters.
53
54
        - name: all_fields
          in: query
55
          required: false
56
          type: string
57
          description: >
rameshnaraya's avatar
rameshnaraya committed
58
59
            Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
            shall support this parameter.
60
61
        - name: fields
          in: query
62
          required: false
63
          type: string
64
          description: >
rameshnaraya's avatar
rameshnaraya committed
65
66
            Complex attributes to be included into the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.         
67
68
        - name: exclude_fields
          in: query
69
          required: false
70
          type: string
71
          description: >
rameshnaraya's avatar
rameshnaraya committed
72
73
            Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
            NFVO should support this parameter.
74
75
        - name: exclude_default
          in: query
76
          required: false
77
          type: string
78
          description: >
rameshnaraya's avatar
rameshnaraya committed
79
80
81
            Indicates to exclude the following complex attributes from the response. See clause 4.3.3
            for details.
            The NFVO shall support this parameter.
82
83
84
85
86
87
            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
88
            - checksum
89
90
91
92
93
94
95
96
97
98
99
100
101
        - 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
102
          type: string
103
104
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
105
          description: >
106
            200 OK
107

108
            Information of the selected VNF packages.
rameshnaraya's avatar
rameshnaraya committed
109
110
111
112
113
114
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
115
            WWW-Authenticate:
116
              type: string
rameshnaraya's avatar
rameshnaraya committed
117
118
              description: >
                Challenge if the corresponding HTTP request has not provided
119
120
121
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
122
              minimum: 0
123
          schema:
rameshnaraya's avatar
rameshnaraya committed
124
            type: array
125
            items:
rameshnaraya's avatar
rameshnaraya committed
126
127
              properties:
                VnfPkgInfo:
128
                  $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
129
        400:
130
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
131
        401:
132
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
133
        403:
134
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
135
        404:
136
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
137
        405:
138
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
139
        406:
140
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
141
        416:
142
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
143
        500:
144
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
145
        503:
146
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
147
148

    post:
rameshnaraya's avatar
rameshnaraya committed
149
      summary: Create a new individual VNF package resource.
150
      description: >
rameshnaraya's avatar
rameshnaraya committed
151
        The POST method creates a new individual VNF package resource.
152
      parameters:
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
        - 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:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest"
          description: >
            IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
181
182
      responses:
        201:
183
          description: >
184
            201 Created            
185

186
            An individual VNF package resource has been created successfully.
187
188
189
190
191
            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
192
            VNF package resource.
193
          schema:
194
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
195
          headers:
196
            Content-Type:
197
              type: string
198
199
200
201
202
              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
203
              minimum: 1
204
            WWW-Authenticate:
205
              type: string
206
207
208
209
210
211
              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
212
213
214
215

  ###############################################################################
  # Individual VNF Package                                                      #
  ###############################################################################
216
217
  '/vnf_packages/{vnfPkgId}':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3
218
    parameters:
219
      - name: vnfPkgId
220
221
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
222
223
        in: path
        type: string
224
        required: true
225
    get:
rameshnaraya's avatar
rameshnaraya committed
226
      summary: Read information about an individual VNF package.
227
      description: >
228
        The GET method reads the information of a VNF package.
229
230
231
232
233
234
235
236
237
238
239
240
241
242
      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
243
          type: string
244
245
      responses:
        200:
246
247
          description: >
            200 OK
248

249
            Information of the VNF package.            
250
          schema:
251
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya's avatar
rameshnaraya committed
252
253
          headers:
            Content-Type:
254
              type: string
rameshnaraya's avatar
rameshnaraya committed
255
256
257
258
              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:
259
              type: string
rameshnaraya's avatar
rameshnaraya committed
260
261
262
263
              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.
264
265
              maximum: 1
              minimum: 0
266
        400:
267
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
268
        401:
269
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
270
        403:
271
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
272
        404:
273
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
274
        405:
275
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
276
        406:
277
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
278
        416:
279
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
280
        500:
281
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
282
        503:
283
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
284

285
    delete:
rameshnaraya's avatar
rameshnaraya committed
286
      summary: Delete an individual VNF package.
287
      description: >
288
        The DELETE method deletes an individual VNF Package resource.
289
290
291
292
293
294
295
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
296
          type: string
297
298
299
      responses:
        204:
          description: >
300
            204 No Content
301

rameshnaraya's avatar
rameshnaraya committed
302
303
            The VNF package was deleted successfully.
            The response body shall be empty.
304
305
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
306
        400:
307
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
308
        401:
309
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
310
        403:
311
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
312
        404:
313
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
314
        405:
315
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
316
        406:
317
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
318
        416:
319
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
320
        500:
321
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
322
        503:
323
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
324

325
    patch:
rameshnaraya's avatar
rameshnaraya committed
326
      summary: Update information about an individual VNF package.
327
      description: >
328
        "The PATCH method updates the information of a VNF package."
329

330
331
332
333
        "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:
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
        - name: body
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
          description: >
            Parameters for VNF package information modifications.
        - 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:
356
        200:
rameshnaraya's avatar
rameshnaraya committed
357
          description: >
358
            200 OK
359

rameshnaraya's avatar
rameshnaraya committed
360
            The operation was completed successfully.
361
            The response body shall contain attribute
rameshnaraya's avatar
rameshnaraya committed
362
363
            modifications for an "Individual VNF
            package" resource
364
365
366
367
368
369
370
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
371
              type: string
372
373
              description: >
                Challenge if the corresponding HTTP request has not provided
374
375
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
376
377
378
              maximum: 1
              minimum: 0
          schema:
379
            properties:
380
              VnfPkgInfoModifications:
381
382
383
                $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
384
        400:
385
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
386
        401:
387
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
388
        403:
389
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
390
        404:
391
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
392
        405:
393
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
394
        406:
395
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
396
        416:
397
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
398
        500:
399
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
400
        503:
401
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
402

403
404
405
  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
406
407
408
409
410
  '/vnf_packages/{vnfPkgId}/vnfd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4
    parameters:
      - name: vnfPkgId
        description: >
411
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
412
413
        in: path
        type: string
414
        required: true
415
    get:
rameshnaraya's avatar
rameshnaraya committed
416
      summary: Read VNFD of an on-boarded VNF package.
417
      description: >
rameshnaraya's avatar
rameshnaraya committed
418
        The GET method reads the content of the VNFD within a VNF package.
419

rameshnaraya's avatar
rameshnaraya committed
420
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
421
422
423
424
425
426
427
428
429
430
431
432
433
        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
434
        request and response data structures, and response codes.
435
      parameters:
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
        - 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
452
453
      responses:
        200:
454
          description: >
455
            200 OK
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471

            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:
472
              type: string
473
474
              description: >
                Challenge if the corresponding HTTP request has not provided
475
476
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
477
478
479
              maximum: 1
              minimum: 0
        400:
480
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
481
        401:
482
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
483
        403:
484
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
485
        404:
486
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
487
        405:
488
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
489
        406:
490
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
491
        409:
492
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
493
        416:
494
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
495
        500:
496
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
497
        503:
498
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
499

500
501
502
  ###############################################################################
  # VNF Package Content                                                         #
  ###############################################################################
503
  '/vnf_packages/{vnfPkgId}/package_content':
504
505
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5
    parameters:
506
      - name: vnfPkgId
507
        description: >
508
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
509
        in: path
510
        required: true
511
        type: string
512
    get:
rameshnaraya's avatar
rameshnaraya committed
513
      summary: Fetch an on-boarded VNF package.
514
      description: >
rameshnaraya's avatar
rameshnaraya committed
515
516
517
        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.
518
      parameters:
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
        - 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.
545
546
      responses:
        200:
547
          description: >
548
            200 OK
549
550
551
552
553
554
555
556
557
558
559
560
561
562

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

593
    put:
rameshnaraya's avatar
rameshnaraya committed
594
      summary: Upload a VNF package by providing the content of the VNF package.
595
      description: >
rameshnaraya's avatar
rameshnaraya committed
596
597
598
599
        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.
600
      consumes:
601
        - multipart/form-data
602
      parameters:
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
        - 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].
627
628
      responses:
        202:
629
          description: >
630
            202 Accepted
631

rameshnaraya's avatar
rameshnaraya committed
632
633
634
635
            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.
636
        409:
637
          description: >
638
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
639
        400:
640
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
641
        401:
642
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
643
        403:
644
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
645
        404:
646
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
647
        405:
648
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
649
        406:
650
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
651
        500:
652
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
653
        503:
654
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
655

656
657
658
  ###############################################################################
  # Upload VNF package from URI task                                            #
  ###############################################################################
659
660
661
  '/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
662
      summary: Upload a VNF package by providing the address information of the VNF package.
663
      description: >
664
665
666
667
        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.        
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
      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: 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:
            $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.
697
698
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
699
          description: >
700
            202 Accepted
701

rameshnaraya's avatar
rameshnaraya committed
702
            The information about the VNF package was received
703
704
            successfully, but the on-boarding has not been
            completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
705
            The response body shall be empty.
706
        409:
707
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
708
        400:
709
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
710
        401:
711
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
712
        403:
713
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
714
        404:
715
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
716
        405:
717
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
718
        406:
719
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
720
        500:
721
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
722
        503:
723
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
724

725
726
727
  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
728
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
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
    #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"

855
856
857
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
858
  '/subscriptions':
859
    #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8
860
    post:
rameshnaraya's avatar
rameshnaraya committed
861
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
862
      description: >
863
        The POST method creates a new subscription.
rameshnaraya's avatar
rameshnaraya committed
864
865
866
867
868
869
870
871
        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).
872
      parameters:
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
        - 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:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
          description: >
            Representation of the created subscription resource.
            The HTTP response shall include a "Location" HTTP header that
            points to the created subscription resource.
903
904
      responses:
        201:
rameshnaraya's avatar
rameshnaraya committed
905
          description: >
906
            201 Created
907

908
            Representation of the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
909
910
            The HTTP response shall include a "Location"
            HTTP header that points to the created subscription resource.
911
912
913
914
915
916
917
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
918
              type: string
919
920
              description: >
                Challenge if the corresponding HTTP request has not provided
921
922
923
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
924
              minimum: 0
925
926
927
          schema:
            type: array
            items:
928
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
929
        303:
930
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
931
        400:
932
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
933
        401:
934
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
935
        403:
936
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
937
        404:
938
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
939
        405:
940
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
941
        406:
942
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
943
        416:
944
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
945
        500:
946
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
947
        503:
948
          $ref: "../responses/SOL005_resp.yaml#/responses/503"