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

info:
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
4
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
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:
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
19
20
  description: ETSI GS NFV-SOL 005 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
21

22
basePath: /vnfpkgm/v1
23
24
25
schemes:
  - https
consumes:
26
  - application/json
27
produces:
28
  - application/json
29
paths:
30
31
32
33
34
35
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

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

129
130
131
132
133
134
135
136
137
138
            Shall be returned when information about zero or more VNF packages has been queried successfully.
            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 "filter" URI parameter or one of the "all_fields", "fields", "exclude_fields" or
            "exclude_default" URI parameters was supplied in the request and is supported, the data in the
            response body shall have been transformed according to the rules specified in clauses 5.2.2 and
            5.3.2 of ETSI GS NFV SOL 013, respectively.
            If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013
            for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in
            clause 5.4.2.3 of ETSI GS NFV SOL 013.
rameshnaraya's avatar
rameshnaraya committed
139
140
141
142
143
144
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
145
            WWW-Authenticate:
146
              type: string
rameshnaraya's avatar
rameshnaraya committed
147
148
              description: >
                Challenge if the corresponding HTTP request has not provided
149
150
151
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
152
              minimum: 0
153
154
155
156
157
158
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
159
          schema:
rameshnaraya's avatar
rameshnaraya committed
160
            type: array
161
            items:
rameshnaraya's avatar
rameshnaraya committed
162
163
              properties:
                VnfPkgInfo:
164
                  $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
165
        400:
166
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
167
        401:
168
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
169
        403:
170
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
171
        404:
172
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
173
        405:
174
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
175
        406:
176
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
177
        416:
178
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
179
        500:
180
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
181
        503:
182
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
183
184

    post:
rameshnaraya's avatar
rameshnaraya committed
185
      summary: Create a new individual VNF package resource.
186
      description: >
rameshnaraya's avatar
rameshnaraya committed
187
        The POST method creates a new individual VNF package resource.
188
      parameters:
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          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
210
211
      responses:
        201:
212
          description: >
213
            201 Created            
214

215
            An individual VNF package resource has been created successfully.
216
217
218
219
220
            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
221
            VNF package resource.
222
          schema:
223
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
224
          headers:
225
            Content-Type:
226
              type: string
227
228
229
230
231
              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
232
              minimum: 1
233
            WWW-Authenticate:
234
              type: string
235
236
237
238
239
240
              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
241
242
243
244
245
246
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
247
248
249
  ###############################################################################
  # Individual VNF Package                                                      #
  ###############################################################################
250
  '/vnf_packages/{vnfPkgId}':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
251
    #ETSI GS NFV-SOL 005 V2.6.1 location: 9.4.3
252
    parameters:
253
      - name: vnfPkgId
254
255
        description: >
          Identifier of the VNF package. The identifier is allocated by the NFVO.  
256
257
        in: path
        type: string
258
        required: true
259
260
261
262
263
264
265
266
267
268
269
270
271
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
272
    get:
rameshnaraya's avatar
rameshnaraya committed
273
      summary: Read information about an individual VNF package.
274
      description: >
275
        The GET method reads the information of a VNF package.
276
277
278
279
280
281
282
283
284
285
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
286
287
          description: >
            200 OK
288

289
290
            Shall be returned when information of the VNF package has been read successfully.
            The response body shall contain the VNF package info representation defined in clause 9.5.2.5.
291
          schema:
292
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya's avatar
rameshnaraya committed
293
294
          headers:
            Content-Type:
295
              type: string
rameshnaraya's avatar
rameshnaraya committed
296
297
298
299
              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:
300
              type: string
rameshnaraya's avatar
rameshnaraya committed
301
302
303
304
              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.
305
306
              maximum: 1
              minimum: 0
307
308
309
310
311
312
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
313
        400:
314
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
315
        401:
316
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
317
        403:
318
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
319
        404:
320
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
321
        405:
322
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
323
        406:
324
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
325
        416:
326
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
327
        500:
328
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
329
        503:
330
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
331

332
    delete:
rameshnaraya's avatar
rameshnaraya committed
333
      summary: Delete an individual VNF package.
334
      description: >
335
        The DELETE method deletes an individual VNF Package resource.
336
337
338
      responses:
        204:
          description: >
339
            204 No Content
340

341
            The VNF package has been deleted successfully.
rameshnaraya's avatar
rameshnaraya committed
342
            The response body shall be empty.
343
344
345
346
347
348
349
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
350
351
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
352
        400:
353
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
354
        401:
355
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
356
        403:
357
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
358
        404:
359
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
360
        405:
361
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
362
        406:
363
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
364
        416:
365
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
366
        500:
367
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
368
        503:
369
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
370

371
    patch:
rameshnaraya's avatar
rameshnaraya committed
372
      summary: Update information about an individual VNF package.
373
      description: >
374
        "The PATCH method updates the information of a VNF package."
375

376
377
378
379
        "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:
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
        - name: body
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
          description: >
            Parameters for VNF package information modifications.
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
395
        200:
rameshnaraya's avatar
rameshnaraya committed
396
          description: >
397
            200 OK
398

399
400
            Shall be returned when the operation has been completed successfully.
            The response body shall contain attribute modifications for an "Individual VNF package" resource.
401
402
403
404
405
406
407
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
408
              type: string
409
410
              description: >
                Challenge if the corresponding HTTP request has not provided
411
412
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
413
414
              maximum: 1
              minimum: 0
415
416
417
418
419
420
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
421
          schema:
422
            properties:
423
              VnfPkgInfoModifications:
424
425
426
                $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
427
        400:
428
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
429
        401:
430
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
431
        403:
432
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
433
        404:
434
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
435
        405:
436
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
437
        406:
438
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
439
        416:
440
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
441
        500:
442
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
443
        503:
444
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
445

446
447
448
  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
449
  '/vnf_packages/{vnfPkgId}/vnfd':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
450
    #ETSI GS NFV-SOL 005 V2.6.1 location: 9.4.4
451
    parameters:
452
453
454
455
456
457
458
459
460
461
462
463
464
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
465
466
      - name: vnfPkgId
        description: >
467
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
468
469
        in: path
        type: string
470
        required: true
471
    get:
rameshnaraya's avatar
rameshnaraya committed
472
      summary: Read VNFD of an on-boarded VNF package.
473
      description: >
rameshnaraya's avatar
rameshnaraya committed
474
        The GET method reads the content of the VNFD within a VNF package.
475

rameshnaraya's avatar
rameshnaraya committed
476
        The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the
477
478
479
480
481
482
483
484
485
486
487
488
489
        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
490
        request and response data structures, and response codes.
491
      parameters:
492
493
494
495
496
497
498
499
500
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
501
502
      responses:
        200:
503
          description: >
504
            200 OK
505

506
507
508
509
510
            Shall be returned when the content of the VNFD has been read successfully.
            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.
511
512
513
514
515
516
517
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
518
              type: string
519
520
              description: >
                Challenge if the corresponding HTTP request has not provided
521
522
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
523
524
              maximum: 1
              minimum: 0
525
526
527
528
529
530
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
531
        400:
532
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
533
        401:
534
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
535
        403:
536
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
537
        404:
538
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
539
        405:
540
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
541
        406:
542
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
543
        409:
544
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
545
        416:
546
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
547
        500:
548
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
549
        503:
550
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
551

552
553
554
  ###############################################################################
  # VNF Package Content                                                         #
  ###############################################################################
555
  '/vnf_packages/{vnfPkgId}/package_content':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
556
    #ETSI GS NFV-SOL 005 V2.6.1 location: 9.4.5
557
    parameters:
558
559
560
561
562
563
564
565
566
567
568
569
570
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
571
      - name: vnfPkgId
572
        description: >
573
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
574
        in: path
575
        required: true
576
        type: string
577
    get:
rameshnaraya's avatar
rameshnaraya committed
578
      summary: Fetch an on-boarded VNF package.
579
      description: >
rameshnaraya's avatar
rameshnaraya committed
580
581
582
        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.
583
      parameters:
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - application/zip
        - 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.
603
604
      responses:
        200:
605
          description: >
606
            200 OK
607

608
            Shall be returned when the whole content of the VNF package file has been read successfully.
609
            The response body shall include a copy of the VNF package file.
610
611
            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.
612
613
614
615
616
617
618
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
619
              type: string
620
621
              description: >
                Challenge if the corresponding HTTP request has not provided
622
623
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
624
625
              maximum: 1
              minimum: 0
626
627
628
629
630
631
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
632
        206:
633
          $ref: "../responses/SOL005_resp.yaml#/responses/206"
634
635
636
637
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
638
        400:
639
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
640
        401:
641
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
642
        403:
643
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
644
        404:
645
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
646
        405:
647
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
648
        406:
649
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
650
        500:
651
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
652
        503:
653
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
654

655
    put:
rameshnaraya's avatar
rameshnaraya committed
656
      summary: Upload a VNF package by providing the content of the VNF package.
657
      description: >
rameshnaraya's avatar
rameshnaraya committed
658
659
660
661
        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.
662
      consumes:
663
        - multipart/form-data
664
      parameters:
665
666
667
668
669
670
671
672
673
674
675
676
677
678
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - application/zip
        - in: formData
          name: file
          required: false
          type: file
          description: >
            The payload body contains a ZIP file that represents the VNF package.
679
680
            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.
681
682
      responses:
        202:
683
          description: >
684
            202 Accepted
685

686
687
            The VNF package has been accepted for uploading, but the processing has not been completed.
            It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
688
            The response body shall be empty.
689
690
            The client can track the uploading progress by receiving the "VnfPackageOnBoardingNotification"
            from the NFVO or by reading the status of the individual VNF package resource using the GET method.
691
692
693
694
695
696
697
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
698
        409:
699
          description: >
700
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
701
        400:
702
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
703
        401:
704
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
705
        403:
706
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
707
        404:
708
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
709
        405:
710
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
711
        406:
712
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
713
        500:
714
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
715
        503:
716
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
717

718
719
720
  ###############################################################################
  # Upload VNF package from URI task                                            #
  ###############################################################################
721
722
723
  '/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
724
      summary: Upload a VNF package by providing the address information of the VNF package.
725
      description: >
726
727
728
729
        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.        
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
      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
745
746
747
748
749
750
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
751
752
753
754
755
756
757
758
759
760
761
762
763
764
        - 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.
765
766
      responses:
        202:
rameshnaraya's avatar
rameshnaraya committed
767
          description: >
768
            202 Accepted
769

770
771
            The information about the VNF package has been received successfully, but the on-boarding
            has not been completed. It is expected to take some time for processing.
rameshnaraya's avatar
rameshnaraya committed
772
            The response body shall be empty.
773
774
775
776
777
778
779
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
780
        409:
781
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
782
        400:
783
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
784
        401:
785
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
786
        403:
787
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
788
        404:
789
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
790
        405:
791
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
792
        406:
793
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
794
        500:
795
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
796
        503:
797
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
798

799
800
801
  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
802
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
803
804
805
806
807
808
809
810
811
812
813
814
815
    #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: >
816
817
818
819
820
          Sequence of one or path segments representing the path of the artifact within the VNF package,
          relative to the root of the 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.
821
822
823
        in: path
        type: string
        required: true
824
825
826
827
828
829
830
831
832
833
834
835
836
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
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
    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: 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
864
865
866
867
868
869
            Shall be returned when the whole content of the artifact file has been read successfully.
            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.
870
871
872
873
874
875
876
877
878
879
880
881
882
883
          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
884
885
886
887
888
889
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
890
891
892
        206:
          description: >
            Partial Content.
893
894
895
896
897
898
899
900

            If the NFVO supports range requests, this response shall be returned when a single consecutive byte
            range from the content of the artifact file has been read successfully according to the request.
            The response body shall contain the requested part 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".
            The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
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
932
933
934
935
936
937
938
939
          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"

940
941
942
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
943
  '/subscriptions':