Newer
Older
swagger: "2.0"
info:
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/rep/nfv/SOL005/issues
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.8.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.08.01_60/gs_NFV-SOL005v020801p.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.8.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
###############################################################################
# Individual VNF Package #
###############################################################################
'/vnf_packages/{vnfPkgId}':
#ETSI GS NFV-SOL 005 V2.8.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
306
307
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
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
376
377
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
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
$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:
430
431
432
433
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
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.8.1 location: 9.4.4
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
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.
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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
The VNFD is implemented as a collection of one or more files. A ZIP archive embedding these
files shall be returned when reading this resource.
The default format of the ZIP archive shall comply with the CSAR format as specified in ETSI
GS NFV-SOL 004 where only the files representing the VNFD and information needed to navigate
the ZIP archive and to identify the file that is the entry point for parsing the VNFD and (if requested)
further security information are included, and software images as well as other artifacts referenced
from the YAML files are excluded. 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.
NOTE 1: For a VNFD based on TOSCA, it includes all the imported type definition files as indicated
in the top level service template and in any of the lower level service template if it has any as
described in ETSI GS NFV-SOL 001.
NOTE 2: For a VNFD based on YANG, it includes the file as indicated by the "yang_definitions" keyname
in the metadata section of the main yaml file as described in ETSI GS NFV-SOL 004.
- 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).
Tree examples are provided below.
NOTE 3: These examples do not show the security related files.
EXAMPLE 1: Assuming a request is sent for the following VNF package (as described in clause A.1 in ETSI GS NFV-SOL 004):
!------TOSCA-Metadata
!------TOSCA.meta (metadata for navigating the ZIP file)
!------Definitions
!----- MRF.yaml (main VNFD file)
!----- OtherTemplates (e.g. type definitions referenced by the main VNFD file)
!------Files
!----- ChangeLog.txt
!----- image(s)
!----- other artifacts
!------Tests
!----- file(s)
!------Licenses
!----- file(s)
!------Scripts
!----- install.sh
!----- MRF.mf
The NFVO will return a ZIP file of the following format:
!------TOSCA-Metadata
!------TOSCA.meta
!------Definitions
!----- MRF.yaml
!----- OtherTemplates
EXAMPLE 2: Assuming a request is sent for the following VNF package (a VNF package without a TOSCA Metadata directory,
as described in clause A.2 in ETSI GS NFV-SOL 004):
!------MRF.yaml (main VNFD file)
!------MRF.mf
!------ChangeLog.txt
!------Tests
!----- file(s)
!------Licenses
!----- file(s)
!------Artifacts
!----- install.sh
!----- start.yang
The NFVO will return a ZIP file of the following format:
!------MRF.yaml
EXAMPLE 3: Assuming a request is sent for the following VNF package (a VNF package with the YANG VNFD without a
TOSCA-Metadata directory, as described in clause A.3 in ETSI GS NFV SOL 004):
!----CompanyVNFD.yaml
!----CompanyVNFD.xml
!----CompanyVNFD.mf
!----ChangeLog.txt
!-----Files
!-----Instance Data Files
!----start.xml
!-----Licenses
!-----Scripts
!-----install.sh
The NFVO will return a ZIP file of the following format:
!----CompanyVNFD.yaml
!----CompanyVNFD.xml (indicated in the yang_definitions metadata in CompanyVNFD.yaml)
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.8.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.8.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.8.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: The PUT method uploads the content of a 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", the "operationalState" attribute to
"ENABLED", and the "usageState" attribute to "NOT_IN_USE". In addition, the NFVO shall set the value of the attributes
in the "VnfPkgInfo" that are copied from the VNFD (refer to clause 9.5.2.5). 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:
- 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.
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
responses:
202:
Shall be returned when the VNF package has been
accepted for uploading, but the processing has not
been completed. It is expected to take some time
for processing.
The response body shall be empty. See note.
Samir Medjiah
committed
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"
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
###############################################################################
# VNF package artifact #
###############################################################################
'/vnf_packages/{vnfPkgId}/artifacts':
#ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.5a
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
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: 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: Fetch set of VNF package artifacts.
description: >
The GET method shall return an archive that contains a set of artifacts according to the provisions for
inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package.
The criteria for exclusion/inclusion of an artifact in the archive are defined as follows:
• Artifacts that are software images shall be excluded from the archive.
• Artifacts that are not software images and that are external to the VNF package shall be excluded from the
archive unless the URI query parameter "include_external_artifacts" has been provided.
External artifacts shall be included in the archive using the content of the "artifactPath" attribute as the path.
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
• All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive,
unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts
shall be excluded.
• All additional artifacts included in the VNF package that are non-MANO artifacts shall be included in the
archive, unless:
- the URI query parameter "exclude_all_non_mano_artifacts" has been provided, in which case such
artifacts shall be excluded;
- the URI query parameter "select_non_mano_artifact_sets" has been provided and is supported by the
NFVO, in which case only those non-MANO artifacts shall be included whose non-MANO artifact set
identifier matches one of the values of the query parameter.
Package metadata such as manifest file or VNFD shall not be included in the archive.
This method shall follow the provisions specified in the Tables 9.4.5a.3.2-1 and 9.4.5a.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
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 archive containing the artifacts. This can
be used to continue an aborted transmission.
If the "Range" header is present in the request and the NFVO
does not support responding to range requests with a 206
response, it shall return a 200 OK response instead as defined
below.
- name: include_signatures
in: query
required: false
type: string
description: >
If this parameter is provided, the NFVO shall include in the ZIP
archive the individual signatures and, if provided, related
certificates for the included artifacts, in the format in which they
are provided in the VNF package.
If this parameter is not given, the NFVO shall only provide copies
of the artifact files.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
- name: exclude_all_mano_artifacts
in: query
required: false
type: string
description: >
Flag (i.e. parameter without value) that instructs the NFVO to
exclude the set of additional MANO artifacts (i.e. those that are
not images) from the response payload body.
The NFVO shall support this parameter. The OSS/BSS may supply
this parameter.
- name: exclude_all_non_mano_artifacts
in: query
required: false
type: string
description: >
Flag (i.e. parameter without value) that instructs the NFVO to
exclude the set of non-MANO artifacts from the response payload
body.
The NFVO shall support this parameter. The OSS/BSS may supply
this parameter.
- name: include_external_artifacts
description: >
Flag (i.e. parameter without value) that instructs the NFVO to include
external artifacts in the response payload body. It shall not be treated
as an error if this flag is provided but there is no external artifact to
include in the result. If this parameter is missing, no external artifacts
shall be included.
The NFVO shall support this parameter. The OSS/BSS may supply this parameter.
in: query
type: string
- name: select_non_mano_artifact_sets
in: query
required: false
type: string
description: >
Comma-separated list of non-MANO artifact set identifiers for
which the artifacts are to be included in the response body.
The NFVO should support this parameter. If the NFVO does not
support this parameter, it shall ignore it, i.e. provide a response as
if no parameter was provided. The OSS/BSS may supply this
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
parameter.
responses:
200:
description: >
200 OK
Shall be returned when the whole content of the
archive containing the artifact files has been read
successfully.
The payload body shall be a ZIP archive containing
the requested set of artifacts selected according to the
provisions specified above in this clause, and, if the
flag "include_signatures" was provided in the related
request, the applicable signature files and, if available,
the separate certificate files from the VNF package.
The "Content-Type" HTTP header shall be set to
"application/zip".
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
206:
description: >
206 Partial Content.
If the NFVO supports range requests, this response
shall be returned when a single consecutive byte
range from the content of the archive that would have
been returned in a "200 OK" response has been read
successfully according to the request.
The response body shall contain the requested part of
the archive.
The "Content-Type" HTTP header shall be set to
"application/zip".
The "Content-Range" HTTP header shall be provided
according to IETF RFC 7233 [10].
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"
###############################################################################
# Upload VNF package from URI task #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
#ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.6
rameshnaraya
committed
post:
summary: Upload a VNF package by providing the address information of the VNF package.
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.
Upon start of obtaining the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo" structure
to "UPLOADING". Upon successfully obtaining 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", the "operationalState" attribute to "ENABLED", and the
"usageState" attribute to "NOT_IN_USE". In addition, the NFVO shall set the value of the attributes in the "VnfPkgInfo"
that are copied from the VNFD (refer to clause 9.5.2.5). If an error occurs during obtaining 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".
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
Samir Medjiah
committed
- 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 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.
rameshnaraya
committed
responses:
202:
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.
Samir Medjiah
committed
headers:
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
409:
$ref: "../responses/SOL005_resp.yaml#/responses/409"
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"
###############################################################################
# Individual VNF package artifact #
###############################################################################
rameshnaraya
committed
'/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
#ETSI GS NFV-SOL 005 V2.8.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: >
For an artifact contained as a file in the VNF package, this variable shall contain a sequence of
one or more path segments representing the path of the artifact within the VNF package, relative to
the root of the package. See note 3.
EXAMPLE: foo/bar/m%40ster.sh
For an external artifact represented as a URI in the VNF package manifest, this variable shall
contain a sequence of one or more path segments as synthesized by the NFVO (see
clause 9.5.3.3), representing this artifact.
See note 2 and note 3
in: path
type: string
required: true
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
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
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
- name: include_signatures
in: query
required: false
type: string
description: >
If this parameter is provided, the NFVO shall return the artifact and related
security information (such as signature and optional certificate) in a ZIP archive.
If this parameter is not given, the NFVO shall provide only a copy of the artifact
file.
This URI query parameter is a flag, i.e. it shall have no value.
The NFVO shall support this parameter.
responses:
200:
description: >
200 OK
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
Shall be returned when the whole content of the
artifact file has been read successfully.
If the "include_signatures" request URI parameter
was not provided in the related request, the payload
body shall contain a copy of the artifact file from the
VNF package, as defined by ETSI
GS NFV-SOL 004 [5], and the "Content-Type"
HTTP header shall be set according to the content
type of the artifact file. If the artifact is encrypted,
the header shall be set to the value
"application/cms" (IETF RFC 7193 [17]). If the
content type cannot be determined, the header shall
be set to the value "application/octet-stream".
If the "include_signatures" request URI parameter
was provided in the related request, the "ContentType" HTTP header shall be set to "application/zip"
and the payload body shall contain a ZIP archive
which includes:
- a copy of the artifact file from the VNF
package, as defined by ETSI
GS NFV-SOL 004 [5];
- the related security information (individual
signature file and optional related
individual certificate file).
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
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
206:
description: >
Partial Content.
If the NFVO supports range requests and the
"include_signatures" request URI parameter was
not present in the related request, 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 [5].
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 [10].
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
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"
###############################################################################
# Subscriptions #
###############################################################################
rameshnaraya
committed
'/subscriptions':
#ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.8
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
rameshnaraya
committed
post:
summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
rameshnaraya
committed
The POST method creates a new subscription.
This method shall follow the provisions specified in the Tables 9.4.8.3.1-1 and 9.4.8.3.1-2 for URI
query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, a new "Individual subscription" resource as defined
in clause 9.4.9 shall have been created. This method shall not trigger any notification.
Creation of two "Individual subscription" resources with the same callback URI and the same filter can
result in performance degradation and will provide duplicates of notifications to the OSS/BSS, and might
make sense only in very rare use cases. Consequently, the NFVO may either allow creating a new "Individual
subscription" resource if another "Individual subscription" resource with the same filter and callback URI
already exists (in which case it shall return the "201 Created" response code), or may decide to not create
a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response
code referencing the existing "Individual subscription" resource with the same filter and callback URI).
rameshnaraya
committed
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/PkgmSubscriptionRequest"
description: >
Details of the subscription to be created.
rameshnaraya
committed
responses:
201:
Shall be returned when the subscription has been
created successfully.
The response body shall contain a representation
of the created "Individual subscription" resource.
The HTTP response shall include a "Location"
HTTP header that points to the created 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.
maximum: 1
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
rameshnaraya
committed
303:
$ref: "../responses/SOL005_resp.yaml#/responses/303"
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"
422:
$ref: "../responses/SOL005_resp.yaml#/responses/422"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
summary: Query multiple subscriptions.
The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used
e.g. for resynchronization after error situations.
This method shall follow the provisions specified in the Tables 9.4.8.3.2-1 and 9.4.8.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 filter 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.
All attribute names that appear in the PkgmSubscription and in data types referenced from it
shall be supported by the NFVO in the filter expression
- 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 the list of subscriptions has been queried successfully.
The response body shall contain in an array the representations of all active subscriptions of the
functional block that invokes the method, i.e. zero or more representations of VNF package management
subscriptions, as defined in clause 9.5.2.7.
If the "filter" URI parameter was supplied in the request, the data in the response body shall have been
transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
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
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.
maximum: 1
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
type: array
items:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
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"
###############################################################################
# Individual subscription #
###############################################################################
rameshnaraya
committed
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.9
rameshnaraya
committed
parameters:
- name: subscriptionId
description: >
Identifier of this subscription.
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 subscription" resource. It can also be retrieved from
rameshnaraya
committed
the "id" attribute in the payload body of that response.
in: path
type: string
required: true
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
get:
summary: Read an individual subscription resource.
rameshnaraya
committed
description: >
Query Subscription Information
The GET method reads an individual subscription.
parameters:
- 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 an
individual subscription has been read successfully.
The response body shall contain a representation of
the "Individual subscription" 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.
maximum: 1
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
schema:
$ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
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
delete:
rameshnaraya
committed
The DELETE method terminates an individual subscription.
This method shall follow the provisions specified in the Tables 9.4.9.3.5-1 and 9.4.9.3.5-2 for
URI query parameters, request and response data structures, and response codes.
As the result of successfully executing this method, the "Individual subscription" resource shall
not exist any longer. This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer.
NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion.
rameshnaraya
committed
responses:
204:
rameshnaraya
committed
Shall be returned when information about an
individual subscription has been read successfully.
The response body shall contain a representation of
the "Individual subscription" resource.
rameshnaraya
committed
headers:
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
416:
$ref: "../responses/SOL005_resp.yaml#/responses/416"
$ref: "../responses/SOL005_resp.yaml#/responses/500"
rameshnaraya
committed
503: