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

info:
Giacomo Bernini's avatar
Giacomo Bernini committed
4
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:4"
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
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
Giacomo Bernini's avatar
Giacomo Bernini committed
33
  '/api_versions':
34
35
    $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:
Giacomo Bernini's avatar
Giacomo Bernini committed
162
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
163
        400:
164
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
165
        401:
166
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
167
        403:
168
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
169
        404:
170
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
171
        405:
172
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
173
        406:
174
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
175
        416:
176
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
177
        500:
178
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
179
        503:
180
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
181
182

    post:
rameshnaraya's avatar
rameshnaraya committed
183
      summary: Create a new individual VNF package resource.
184
      description: >
rameshnaraya's avatar
rameshnaraya committed
185
        The POST method creates a new individual VNF package resource.
186
      parameters:
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
        - 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
208
209
      responses:
        201:
210
          description: >
211
            201 Created            
212

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

287
288
            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.
289
          schema:
290
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya's avatar
rameshnaraya committed
291
292
          headers:
            Content-Type:
293
              type: string
rameshnaraya's avatar
rameshnaraya committed
294
295
296
297
              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:
298
              type: string
rameshnaraya's avatar
rameshnaraya committed
299
300
301
302
              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.
303
304
              maximum: 1
              minimum: 0
305
306
307
308
309
310
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
311
        400:
312
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
313
        401:
314
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
315
        403:
316
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
317
        404:
318
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
319
        405:
320
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
321
        406:
322
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
323
        416:
324
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
325
        500:
326
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
327
        503:
328
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
329

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

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

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

374
375
376
377
        "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:
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
        - 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:
393
        200:
rameshnaraya's avatar
rameshnaraya committed
394
          description: >
395
            200 OK
396

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

444
445
446
  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
447
  '/vnf_packages/{vnfPkgId}/vnfd':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
448
    #ETSI GS NFV-SOL 005 V2.6.1 location: 9.4.4
449
    parameters:
450
451
452
453
454
455
456
457
458
459
460
461
462
      - 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
463
464
      - name: vnfPkgId
        description: >
465
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
466
467
        in: path
        type: string
468
        required: true
469
    get:
rameshnaraya's avatar
rameshnaraya committed
470
      summary: Read VNFD of an on-boarded VNF package.
471
      description: >
rameshnaraya's avatar
rameshnaraya committed
472
        The GET method reads the content of the VNFD within a VNF package.
473

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

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

550
551
552
  ###############################################################################
  # VNF Package Content                                                         #
  ###############################################################################
553
  '/vnf_packages/{vnfPkgId}/package_content':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
554
    #ETSI GS NFV-SOL 005 V2.6.1 location: 9.4.5
555
    parameters:
556
557
558
559
560
561
562
563
564
565
566
567
568
      - 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
569
      - name: vnfPkgId
570
        description: >
571
          Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
572
        in: path
573
        required: true
574
        type: string
575
    get:
rameshnaraya's avatar
rameshnaraya committed
576
      summary: Fetch an on-boarded VNF package.
577
      description: >
rameshnaraya's avatar
rameshnaraya committed
578
579
580
        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.
581
      parameters:
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
        - 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.
601
602
      responses:
        200:
603
          description: >
604
            200 OK
605

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

653
    put:
rameshnaraya's avatar
rameshnaraya committed
654
      summary: Upload a VNF package by providing the content of the VNF package.
655
      description: >
rameshnaraya's avatar
rameshnaraya committed
656
657
658
659
        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.
660
      consumes:
661
        - multipart/form-data
662
      parameters:
663
664
665
666
667
668
669
670
671
672
673
674
675
676
        - 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.
677
678
            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.
679
680
      responses:
        202:
681
          description: >
682
            202 Accepted
683

684
685
            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
686
            The response body shall be empty.
687
688
            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.
689
690
691
692
693
694
695
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
696
        409:
697
          description: >
698
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
699
        400:
700
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
701
        401:
702
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
703
        403:
704
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
705
        404:
706
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
707
        405:
708
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
709
        406:
710
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
711
        500:
712
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
713
        503:
714
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
715

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

768
769
            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
770
            The response body shall be empty.
771
772
773
774
775
776
777
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
778
        409:
779
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
780
        400:
781
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
782
        401:
783
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
784
        403:
785
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
786
        404:
787
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
788
        405:
789
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
790
        406:
791
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
792
        500:
793
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
794
        503:
795
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
796

797
798
799
  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
800
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
801
802
803
804
805
806
807
808
809
810
811
812
813
    #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: >
814
815
816
817
818
          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.
819
820
821
        in: path
        type: string
        required: true
822
823
824
825
826
827
828
829
830
831
832
833
834
      - 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
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
    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
862
863
864
865
866
867
            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.
868
869
870
871
872
873
874
875
876
877
878
879
880
881
          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
882
883
884
885
886
887
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
888
889
890
        206:
          description: >
            Partial Content.
891
892
893
894
895
896
897
898

            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.
899
900
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
          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"

938
939
940
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
941
  '/subscriptions'