Newer
Older
swagger: "2.0"
info:
version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL005 - VNF Package Management Interface
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
name: "NFV-SOL WG"
externalDocs:
description: ETSI GS NFV-SOL 005 V2.7.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
schemes:
- https
consumes:
Samir Medjiah
committed
###############################################################################
# API Versions #
###############################################################################
Samir Medjiah
committed
$ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
###############################################################################
# VNF Packages #
###############################################################################
rameshnaraya
committed
'/vnf_packages':
#ETSI GS NFV-SOL 005 V2.7.1 location: 9.4.2
Samir Medjiah
committed
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
post:
summary: Create a new individual VNF package resource.
description: >
The POST method creates a new individual VNF package resource.
parameters:
- 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
responses:
201:
description: >
201 Created
Shall be returned when an "Individual VNF
package" resource has been created successfully.
The response body shall contain a representation of
the new individual VNF package resource, as
defined in clause 9.5.2.5.
The HTTP response shall include a "Location"
HTTP header that contains the resource URI of the
individual VNF package resource.
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
headers:
Content-Type:
type: string
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
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
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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"
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
rameshnaraya
committed
get:
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.
rameshnaraya
committed
parameters:
- name: filter
in: query
rameshnaraya
committed
required: false
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.
rameshnaraya
committed
All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall
be supported by the NFVO in the filter expression.
- name: all_fields
in: query
rameshnaraya
committed
required: false
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.
- name: fields
in: query
rameshnaraya
committed
required: false
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.
- name: exclude_fields
in: query
rameshnaraya
committed
required: false
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.
- name: exclude_default
in: query
rameshnaraya
committed
required: false
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 for details.
rameshnaraya
committed
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
- 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.
rameshnaraya
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
200:
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
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
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
rameshnaraya
committed
items:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
###############################################################################
# Individual VNF Package #
###############################################################################
'/vnf_packages/{vnfPkgId}':
#ETSI GS NFV-SOL 005 V2.7.1 location: 9.4.3
parameters:
- name: vnfPkgId
description: >
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: path
type: string
required: true
- 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
get:
summary: Read information about an individual VNF package.
The GET method reads the information of a VNF package.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
responses:
200:
description: >
200 OK
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.
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
headers:
Content-Type:
type: string
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:
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
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
patch:
summary: Update information about an individual VNF package.
description: >
"The PATCH method updates the information of a VNF package."
"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:
- 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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
responses:
200:
description: >
200 OK
Shall be returned when the operation has been completed successfully.
The response body shall contain attribute modifications for an "Individual VNF package" resource.
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
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
properties:
VnfPkgInfoModifications:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications"
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"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
delete:
summary: Delete an individual VNF package.
description: >
The DELETE method deletes an individual VNF Package resource.
responses:
204:
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
204 No Content
The VNF package has been deleted successfully.
The response body shall be empty.
headers:
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
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"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# VNFD in an individual VNF package #
###############################################################################
'/vnf_packages/{vnfPkgId}/vnfd':
#ETSI GS NFV-SOL 005 V2.7.1 location: 9.4.4
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
- 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
get:
summary: Read VNFD of an on-boarded VNF package.
description: >
The GET method reads the content of the VNFD within a VNF package.
The default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 [5] where only the 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 and (if requested) further security information are included. This means that the structure of the
ZIP archive shall correspond to the directory structure used in the VNF package and that the archive shall contain the
following files from the package:
• TOSCA.meta (if available in the package).
• The main TOSCA definitions YAML file (either as referenced from TOSCA.meta or available as a file with
the extension ".yml" or ".yaml" from the root of the archive).
Every component of the VNFD referenced (recursively) from the main TOSCA definitions YAML file.
• The related security information, if the "include_signatures" URI parameter is provided, as follows:
- the manifest file;
- the singleton certificate file in the root of the VNF package (if available in the package);
- the signing certificates of the individual files included in the ZIP archive (if available in the package);
- the signatures of the individual files (if available in the package).
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: include_signatures
in: query
required: false
type: string
description: >
If this parameter is provided, the NFVO shall include in the ZIP archive the
security information as specified above.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
rameshnaraya
committed
responses:
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.
rameshnaraya
committed
headers:
description: The MIME type of the body of the response.
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
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
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"
###############################################################################
# Access Configuration for external artifacts #
###############################################################################
'/vnf_packages/{vnfPkgId}/ext_artifacts_access':
#ETSI GS NFV-SOL 005 V2.7.1 location: 9.4.4a
Samir Medjiah
committed
- 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
- name: vnfPkgId
description: >
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request creating a new Individual VNF package resource.
in: path
required: true
type: string
rameshnaraya
committed
get:
summary: Get the content of external VNF package artifacts.
The GET method reads the access configuration information that is used by the NFVO to get the content of external
VNF package artifacts.
This method shall follow the provisions specified in the Tables 9.4.4a.3.2-1 and 9.4.4a.3.2-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
responses:
200:
Shall be returned when the access configuration
information has been read successfully.
If no information has been provided previously, an
empty array shall be returned.
description: The MIME type of the body of the response.
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.
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
schema:
properties:
ExternalArtifactsAccessConfig:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
put:
summary: Download the content of external VNF package artifacts.
The PUT method provides the access configuration information for the NFVO to download the content of external VNF
package artifacts.
As precondition for invoking this method, the individual VNF package resource shall have been created, and the value
of "onboardingState" attribute shall equal to "CREATED" or "ERROR".
The resource representation in the payload body of the PUT request shall replace the current state of the resource.
This method shall follow the provisions specified in the Tables 9.4.4a.3.3-1 and 9.4.4a.3.3-2 for URI query parameters,
request and response data structures, and response codes.
rameshnaraya
committed
parameters:
description: >
The payload body contains the access configuration information
based on which the NFVO can obtain the external VNF package
artifact files.
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig"
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
rameshnaraya
committed
200:
Shall be returned when the attribute
"onboardingState" = "CREATED" or when the
attribute "onboardingState" = "ERROR" and the
VNF package has not been uploaded
successfully previously, to indicate that the
access configuration information has been stored
successfully by the NFVO.
The response body shall contain a representation
of the state of the resource.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
properties:
ExternalArtifactsAccessConfig:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig"
202:
$ref: "../responses/SOL005_resp.yaml#/responses/202"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Manifest in an individual VNF package #
###############################################################################
'/vnf_packages/{vnfPkgId}/manifest':
#ETSI GS NFV-SOL 005 V2.7.1 location: 9.4.4b
rameshnaraya
committed
parameters:
Samir Medjiah
committed
- 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
rameshnaraya
committed
- 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.
rameshnaraya
committed
in: path
type: string
rameshnaraya
committed
get:
The GET method reads the content of the manifest within a VNF package.
rameshnaraya
committed
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- application/zip
- name: include_signatures
in: query
required: false
type: string
description: >
If this parameter is provided, the NFVO shall return the manifest and related security
information (such as certificate) in a ZIP archive.
If this parameter is not given, the NFVO shall provide only a copy of the manifest
file.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
rameshnaraya
committed
responses:
200:
rameshnaraya
committed
Shall be returned when the content of the manifest has
been read successfully.
If the "include_signatures" URI query parameter was
absent in the request, or if the manifest file has all
security-related information embedded (i.e. there is no
separate certificate file), the payload body shall contain a
copy of the manifest file of the VNF package, and
the "Content-Type" HTTP header shall be set to
"text/plain".
If the "include_signatures" URI query parameter was
present in the related request and the manifest file does
not have all the security-related information embedded
(i.e. there is a separate certificate file), the "Content-Type"
HTTP header shall be set to "application/zip and the
payload body shall contain a ZIP archive which includes:
- a copy of the manifest file of the VNF package
- a copy of the related individual certificate file.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
rameshnaraya
committed
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# VNF Package Content #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/package_content':
#ETSI GS NFV-SOL 005 V2.7.1 location: 9.4.5
Samir Medjiah
committed
- 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
- name: vnfPkgId
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
rameshnaraya
committed
get:
The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the
NFVO.
The content of the package is provided as onboarded, i.e. depending on the security option used, the CSAR or the
CSAR wrapped in a ZIP archive together with an external signature is returned, as defined in clause 5.1 of ETSI
GS NFV-SOL 004 [5].
NOTE: Information about the applicable security option can be obtained by evaluating the
"packageSecurityOption" attribute in the "VnfPkgInfo" structure.
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.
rameshnaraya
committed
parameters:
- 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.
rameshnaraya
committed
responses:
200:
rameshnaraya
committed
Shall be returned when the whole content of the VNF package file has been read successfully.
rameshnaraya
committed
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.
rameshnaraya
committed
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
206:
$ref: "../responses/SOL005_resp.yaml#/responses/206"
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
rameshnaraya
committed
put:
summary: Upload a VNF package by providing the content of the VNF package.
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.
Upon start of the upload of the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo"
structure to "UPLOADING". Upon successful upload of the package, if the package references external artifacts, the
NFVO shall obtain the external artifacts. Subsequently, upon success, the NFVO shall set that attribute to
"PROCESSING" and shall process the package, which shall include checking package consistency. Upon successful
processing, the NFVO shall set the "onboardingState" attribute to "ONBOARDED". If an error occurs during uploading
the package, downloading the external artifacts or processing the package, the NFVO shall set the "onboardingState"
attribute to "ERROR" and shall populate the "onboardingFailureDetails" attribute in "VnfPkgInfo".
rameshnaraya
committed
consumes: