Newer
Older
title: SOL003 - VNF Package Management interface
SOL003 - 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. In case of
discrepancies the published ETSI Group Specification takes precedence.
Giacomo Bernini
committed
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
version: "2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Michele Carignani
committed
externalDocs:
description: ETSI GS NFV-SOL 003 V3.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf
servers:
- url: http://127.0.0.1/vnfpkgm/v2
- url: https://127.0.0.1/vnfpkgm/v2
Giacomo Bernini
committed
###############################################################################
# API Versions #
###############################################################################
Giacomo Bernini
committed
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
###############################################################################
# VNF packages #
###############################################################################
The GET method queries the information of the VNF packages matching the filter. See clause 10.4.2.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/OnboardedVnfPackages.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
$ref: '#/paths/~1onboarded_vnf_packages'
###############################################################################
# Individual VNF package #
###############################################################################
- $ref: '#/components/parameters/VnfPkgId'
The GET method reads the information of an individual VNF package. Clause 10.4.3.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
$ref: '#/components/responses/IndividualVnfPackage.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
/onboarded_vnf_packages/{vnfdId}:
- $ref: '#/components/parameters/VnfdId'
The GET method reads the information of an individual VNF package. Clause 10.4.3.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/IndividualOnboardedVnfPackage.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# VNFD in an individual VNF package #
###############################################################################
/vnf_packages/{vnfPkgId}/vnfd:
- $ref: '#/components/parameters/VnfPkgId'
The GET method reads the content of the VNFD within a VNF package. See clause 10.4.4.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
$ref: '#/components/responses/VnfdInIndividualVnfPackage.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
# 409 CONFLICT
#
# Shall be returned upon the following error: The operation cannot
# be executed currently, due to a conflict with the state of the resource.
# Typically, this is due to the fact that "onboardingState" of the
# VNF package has a value different from "ONBOARDED".
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
/onboarded_vnf_packages/{vnfdId}/vnfd:
- $ref: '#/components/parameters/VnfdId'
The GET method reads the content of the VNFD within a VNF package. See clause 10.4.4.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
responses:
200:
$ref: '#/components/responses/VnfdInIndividualOnboardedVnfPackage.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
# 409 CONFLICT
#
# Shall be returned upon the following error: The operation cannot
# be executed currently, due to a conflict with the state of the resource.
# Typically, this is due to the fact that "onboardingState" of the
# VNF package has a value different from "ONBOARDED".
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
Giacomo Bernini
committed
# Manifest in an individual VNF package #
###############################################################################
/vnf_packages/{vnfPkgId}/manifest:
- $ref: '#/components/parameters/VnfPkgId'
The GET method reads the content of the manifest within a VNF package. See clause 10.4.4a.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
$ref: '#/components/responses/ManifestInIndividualVnfPackage.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
/onboarded_vnf_packages/{vnfdId}/manifest:
- $ref: '#/components/parameters/VnfdId'
The GET method reads the content of the manifest within a VNF package. See clause 10.4.4a.3.1.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
$ref: '#/components/responses/ManifestInIndividualOnboardedVnfPackage.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
Giacomo Bernini
committed
# VNF package content #
###############################################################################
/vnf_packages/{vnfPkgId}/package_content:
- $ref: '#/components/parameters/VnfPkgId'
The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
See clause 10.4.5.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/Range'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
$ref: '#/components/responses/IndividualVnfPackageContent.Get.200'
$ref: '#/components/responses/IndividualVnfPackageContent.Get.206'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
# description: |
# 409 CONFLICT
# Shall be returned upon the following error: The operation cannot be executed currently,
# due to a conflict with the state of the resource.
# Typically, this is due to the fact that "onboardingState" of the VNF package has
# a value different from "ONBOARDED".
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the "Range" header
# did not match any available byte range in the VNF package file (e.g. "access after end of file").
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
/onboarded_vnf_packages/{vnfdId}/package_content:
parameters:
- $ref: '#/components/parameters/VnfdId'
The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
See clause 10.4.5.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/Range'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Giacomo Bernini
committed
responses:
200:
$ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.200'
Giacomo Bernini
committed
206:
$ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.206'
Giacomo Bernini
committed
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
409:
# description: |
# 409 CONFLICT
# Shall be returned upon the following error: The operation cannot be executed currently,
# due to a conflict with the state of the resource.
# Typically, this is due to the fact that "onboardingState" of the VNF package has
# a value different from "ONBOARDED".
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
Giacomo Bernini
committed
416:
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the "Range" header
# did not match any available byte range in the VNF package file (e.g. "access after end of file").
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
Giacomo Bernini
committed
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
###############################################################################
# VNF package artifacts #
###############################################################################
/vnf_packages/{vnfPkgId}/artifacts:
Giacomo Bernini
committed
parameters:
- $ref: '#/components/parameters/VnfPkgId'
Giacomo Bernini
committed
get:
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.
See clause 10.4.5a.3.2.
Giacomo Bernini
committed
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/Range'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Giacomo Bernini
committed
responses:
200:
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.200'
Giacomo Bernini
committed
206:
$ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.206'
Giacomo Bernini
committed
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
Giacomo Bernini
committed
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
Giacomo Bernini
committed
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
/onboarded_vnf_packages/{vnfdId}/artifacts:
Giacomo Bernini
committed
parameters:
- $ref: '#/components/parameters/VnfdId'
Giacomo Bernini
committed
get:
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.
See clause 10.4.5a.3.2.
Giacomo Bernini
committed
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/Range'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Giacomo Bernini
committed
responses:
200:
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.200'
Giacomo Bernini
committed
206:
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.206'
Giacomo Bernini
committed
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
409:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
Giacomo Bernini
committed
416:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
Giacomo Bernini
committed
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
###############################################################################
# Individual VNF package artifact #
###############################################################################
/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
Giacomo Bernini
committed
parameters:
- $ref: '#/components/parameters/ArtifactPath'
- $ref: '#/components/parameters/VnfPkgId'
Giacomo Bernini
committed
get:
The GET method fetches the content of an artifact within a VNF package. See clause 10.4.6.3.2.
Giacomo Bernini
committed
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/Range'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.200'
$ref: '#/components/responses/IndividualVnfPackageArtifact.Get.206'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
# description: |
# 409 CONFLICT
# Shall be returned upon the following error: The operation cannot
# be executed currently, due to a conflict with the state of the resource.
# Typically, this is due to the fact that "onboardingState" of the
# VNF package has a value different from "ONBOARDED".
# The response body shall contain a ProblemDetails structure,
# in which the "detail" attribute shall convey more information
# about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the
# "Range" header did not match any available byte range in the artifact file
# (e.g. "access after end of file").
# The response body may contain a ProblemDetails structure.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
Giacomo Bernini
committed
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini
committed
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini
committed
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
Giacomo Bernini
committed
/onboarded_vnf_packages/{vnfdId}/artifacts/{artifactPath}:
Giacomo Bernini
committed
parameters:
- $ref: '#/components/parameters/ArtifactPath'
- $ref: '#/components/parameters/VnfdId'
Giacomo Bernini
committed
get:
The GET method fetches the content of an artifact within a VNF package. See clause 10.4.6.3.2.
Giacomo Bernini
committed
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: '#/components/parameters/Range'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
- $ref: '#/components/parameters/include_signature'
Giacomo Bernini
committed
responses:
200:
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.200'
Giacomo Bernini
committed
206:
$ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.206'
Giacomo Bernini
committed
400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini
committed
401:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini
committed
403:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini
committed
404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini
committed
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini
committed
406:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini
committed
409:
# description: |
# 409 CONFLICT
# Shall be returned upon the following error: The operation cannot
# be executed currently, due to a conflict with the state of the resource.
# Typically, this is due to the fact that "onboardingState" of the
# VNF package has a value different from "ONBOARDED".
# The response body shall contain a ProblemDetails structure,
# in which the "detail" attribute shall convey more information
# about the error.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409"
Giacomo Bernini
committed
416:
# description: |
# 416 RANGE NOT SATISFIABLE
# Shall be returned upon the following error: The byte range passed in the
# "Range" header did not match any available byte range in the artifact file
# (e.g. "access after end of file").
# The response body may contain a ProblemDetails structure.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Subscriptions #
###############################################################################
/subscriptions:
parameters:
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The POST method creates a new subscription. See clause 10.4.7.3.1.
requestBody:
$ref: '#/components/requestBodies/PkgmSubscriptionRequest'
$ref: '#/components/responses/Subscriptions.Post.201'
# description: |
# 303 SEE OTHER
# Shall be returned when a subscription with the same callback URI and the same filter
# already exists and the policy of the NFVO is to not create redundant subscriptions.
# The HTTP response shall include a "Location" HTTP header that contains the resource
# URI of the existing "Individual subscription" resource.
# The response body shall be empty.
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
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. See clause 10.4.7.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
$ref: '#/components/responses/Subscriptions.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
###############################################################################
# Individual subscription #
###############################################################################
/subscriptions/{subscriptionId}:
#SOL003 location: 10.4.8
parameters:
- $ref: '#/components/parameters/SubscriptionId'
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
The GET method reads an individual subscription. See clause 10.4.8.3.2.
- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
$ref: '#/components/responses/IndividualSubscription.Get.200'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
The DELETE method terminates an individual subscription. See clause 10.4.8.3.5.
$ref: '#/components/responses/IndividualSubscription.Delete.204'
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
422:
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
504:
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
components:
parameters:
VnfPkgId:
name: vnfPkgId
in: path
description: |
Identifier of the VNF package. The identifier is allocated by the
NFVO.
This identifier can be retrieved from the "vnfPkgId" attribute in
the VnfPackageOnboardingNotification or
VnfPackageChangeNotification.
required: true
style: simple
explode: false
schema:
type: string
VnfdId:
name: vnfdId
in: path
description: |
Identifier of the VNFD and the VNF package.
The identifier is allocated by the VNF provider.
This identifier can be retrieved from the "vnfdId" attribute
in the VnfPackageOnboardingNotification or VnfPackageChangeNotification.
This identifier can be retrieved from the "vnfdId" attribute in the
VnfPackageOnboardingNotification or VnfPackageChangeNotification.
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
required: true
style: simple
explode: false
schema:
type: string
ArtifactPath:
name: artifactPath
in: path
description: |
SequenceFor 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.
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 10.5.3.3),
representing this artifact.
Since multiple path segments are allowed to be contained in this variable,
the "/" character that separates these segments is not percent-encoded.
Each individual segment is percent-encoded if necessary as defined in clause
4.1 of ETSI GS NFV-SOL 013.
required: true
style: simple
explode: false
schema:
type: string
SubscriptionId:
name: subscriptionId
in: path
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
the "id" attribute in the payload body of that response.
required: true
style: simple
explode: false
schema:
type: string
include_signature:
name: include_signature
in: query
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.
required: false
schema:
type: string
Range:
name: Range
in: header
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 "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.
required: false
schema:
type: string
requestBodies:
PkgmSubscriptionRequest:
description: |
Representation of the created subscription resource.
The HTTP response shall include a "Location" HTTP header that
points to the created subscription resource.
content:
application/json:
schema:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
required: true
responses:
OnboardedVnfPackages.Get.200:
description: |
200 OK
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 10.5.2.2.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
(if supported) or "exclude_default" URI parameters was supplied in the request, 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 VNFM 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.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
IndividualVnfPackage.Get.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 10.5.2.2.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
IndividualOnboardedVnfPackage.Get.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 10.5.2.2.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
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
1171
1172
1173
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
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
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
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
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
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
VnfdInIndividualVnfPackage.Get.200:
description: |
200 OK
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
required: true
schema:
type: string
enum:
- text/plain
- application/zip
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
VnfdInIndividualOnboardedVnfPackage.Get.200:
description: |
200 OK
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
required: true
schema:
type: string
enum:
- text/plain
- application/zip
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ManifestInIndividualVnfPackage.Get.200:
description: |
200 OK
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
required: true
schema:
type: string
enum:
- text/plain
- application/zip
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
ManifestInIndividualOnboardedVnfPackage.Get.200:
description: |
200 OK
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
required: true
schema:
type: string
enum:
- text/plain
- application/zip
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageContent.Get.200:
description: |
200 OK
Shall be returned when the whole content of the VNF package file has been read successfully.
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageContent.Get.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 VNF package file
has been read successfully according to the request.
The response body shall contain the requested part of the VNF package file.
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
headers:
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageContent.Get.200:
description: |
200 OK
Shall be returned when the whole content of the VNF package file has been read successfully.
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifact.Get.200:
description: |
200 OK
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 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). 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 "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 artifact file from the VNF package, as defined by ETSI GS NFV SOL 004;
• 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.
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".
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageContent.Get.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 VNF package file
has been read successfully according to the request.
The response body shall contain the requested part of the VNF package file.
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
headers:
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
required: true
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifacts.Get.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.
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".
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifact.Get.206:
description: |
206 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, if the NFVO supports range requests has been read successfully
according to the request.
The response body shall contain the requested part of the VNF
package file.
The "Content-Range" HTTP header shall be provided according to
IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for
the "200 OK" response.
headers:
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
required: true
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualVnfPackageArtifacts.Get.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.
headers:
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response.
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".
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageArtifacts.Get.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.
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".
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageArtifacts.Get.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.
headers:
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
Content-Type:
description: |
The MIME type of the body of the response.
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".
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageArtifact.Get.200:
description: |
200 OK
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 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). 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 "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 artifact file from the VNF package, as defined by ETSI GS NFV SOL 004;
• 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.
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".
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
IndividualOnboardedVnfPackageArtifact.Get.206:
description: |
206 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, if the NFVO supports range requests has been read successfully
according to the request.
The response body shall contain the requested part of the VNF
package file.
The "Content-Range" HTTP header shall be provided according to
IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for
the "200 OK" response.
headers:
Content-Range:
required : true
style: simple
explode: false
schema:
type: string
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Subscriptions.Post.201:
description: |
201 CREATED
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
Location:
description: The resource URI of the created PM Job
style: simple
explode: false
schema:
type: string
format: url
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
Subscriptions.Get.200:
description: |
200 OK
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 10.5.2.4.
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 VNFM 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.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
Link:
description: |
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
type: array
items:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
IndividualSubscription.Get.200:
description: |
200 OK
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.
headers:
Content-Type:
description: The MIME type of the body of the response.
style: simple
explode: false
schema:
type: string
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema:
type: string
content:
application/json:
schema:
$ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
IndividualSubscription.Delete.204:
description: |
204 NO CONTENT
Shall be returned when the "Individual subscription" resource has been deleted successfully.
headers:
WWW-Authenticate:
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.
style: simple
explode: false
schema:
type: string
Version:
description: The used API version.
style: simple
explode: false
schema: