SOL005_68 to SOL005_82 (84c36b79) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml

+21 −21

Original line number	Diff line number	Diff line
		@@ -16,7 +16,7 @@ info:
		license:
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
		version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 005 V4.3.1
		@@ -808,7 +808,7 @@ components:

		VnfPackageExtArtifactsRequest:
		description: \|
		The payload body contains the access configuration information based on which the NFVO can obtain the
		The message content contains the access configuration information based on which the NFVO can obtain the
		external VNF package artifact files.
		content:
		application/json:
		@@ -824,18 +824,18 @@ components:
		file:
		type: string
		description: \|
		The payload body contains a ZIP file that represents the VNF package. The "Content-Type" HTTP header shall
		The message content 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.
		format: binary
		required: true

		VnfPackageUploadFromUriRequest:
		description: \|
		The payload body contains the address information based on which the NFVO can obtain the content of the VNF package.
		The message content contains the address information based on which the NFVO can obtain the content of the VNF package.
		content:
		application/json:
		schema:
		$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest
		$ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPackageFromUriRequest
		required: true

		VnfPkgSubscriptionRequest:
		@@ -1107,7 +1107,7 @@ components:
		IndividualVnfPackageVnfd.Get.200:
		description: \|
		200 OK
		Shall be returned when the content of the VNFD has been read successfully. The payload body shall contain a
		Shall be returned when the content of the VNFD has been read successfully. The message content 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.
		@@ -1345,11 +1345,11 @@ components:
		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
		(i.e. there is no separate certificate file), the message content 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
		"application/zip and the message content 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:
		Version:
		@@ -1479,7 +1479,7 @@ components:
		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 [10].
		The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
		The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
		headers:
		Version:
		@@ -1633,7 +1633,7 @@ components:
		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
		The message content 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".
		@@ -1670,7 +1670,7 @@ components:
		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].
		The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
		headers:
		Version:
		description: \|
		@@ -1821,14 +1821,14 @@ components:
		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 [5], and the
		"include_signatures" request URI parameter was not provided in the related request, the message content 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 [17]). If the content
		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 "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];
		HTTP header shall be set to "application/zip" and the message content 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:
		Version:
		@@ -1861,10 +1861,10 @@ components:
		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].
		requested part of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004.
		The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the
		content type cannot be determined, the header shall be set to the value "application/octet-stream".
		The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10].
		The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.

		headers:
		Version:
		@@ -2106,10 +2106,10 @@ components:

		VnfPkgSubscriptions.Post.422:
		description: \|
		422 Unprocessable Entity
		422 Unprocessable Content

		Shall be returned upon the following error: The content type of the payload body is supported and the payload
		body of a request contains syntactically correct data but the data cannot be processed.
		Shall be returned upon the following error: The content type of the message content is supported and the
		message content of a request contains syntactically correct data but the data cannot be processed.
		The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
		including rules for the presence of the response body.
		Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested

src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml

+24 −24

Original line number	Diff line number	Diff line
		@@ -16,7 +16,6 @@ definitions:
		- onboardingState
		- operationalState
		- usageState
		- vnfmInfo
		- _links
		properties:
		id:
		@@ -139,8 +138,11 @@ definitions:
		vnfmInfo:
		description: >
		Specifies VNFMs compatible with the VNF.
		This information is copied from the VNFD.
		See note 4.
		This information is copied from the VNFD of
		the on-boarded VNF package. See note 4.
		It shall be present after the VNF package
		content has been on-boarded and absent
		otherwise.
		type: array
		items:
		type: string
		@@ -185,8 +187,14 @@ definitions:

		VnfPackageArtifactInfo:
		description: >
		This type represents an artifact other than a software image which is contained in or external to a VNF package.
		It shall comply with provisions defined in Table 9.5.3.3-1.
		This type represents an artifact other than a software image which is contained
		in or external to a VNF package. It shall comply with provisions defined in
		Table 9.5.3.3-1.

		NOTE: The attribute name "artifactURI" does not comply with the naming convention
		defined in clause 4.3 of ETSI GS NFV-SOL 015. This is to maintain the backward
		compatibility.

		required:
		- isEncrypted
		- checksum
		@@ -218,7 +226,10 @@ definitions:
		URI of the artifact as defined in the VNF package
		manifest. Shall be present if the artifact is external to the
		package and shall be absent otherwise.

		EXAMPLE: https://example.com/m%40ster.sh

		See note.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
		checksum:
		description: >
		@@ -507,7 +518,7 @@ definitions:
		User defined data to be updated. For existing keys, the value is replaced. See note.
		$ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

		UploadVnfPkgFromUriRequest:
		UploadVnfPackageFromUriRequest:
		description: >
		This type represents the request parameters for uploading the content of a VNF package. The NFVO can obtain the
		VNF package content through the information provided in the request parameters. It shall comply with the provisions
		@@ -528,18 +539,13 @@ definitions:
		authorization for downloading the VNF
		package.
		Permitted values:
		- BASIC: Only the "username" and
		"password" attributes shall be
		present.
		- OAUTH2_CLIENT_CREDENTIAL
		S: Only the
		"paramsOauth2ClientCredentials"
		- OAUTH2_CLIENT_CREDENTIALS:
		Only the "paramsOauth2ClientCredentials"
		attribute shall be present.
		This attribute shall not be present if no
		credentials are provided for the artifact.
		This attribute shall not be present if the
		credentials were provisioned out of band.
		type: string
		enum:
		- BASIC
		- OAUTH2_CLIENT_CREDENTIALS
		username:
		description: >
		@@ -834,18 +840,12 @@ definitions:
		authorization for downloading the VNF
		package.
		Permitted values:
		- BASIC: Only the "username" and
		"password" attributes shall be
		present.
		- OAUTH2_CLIENT_CREDENTIAL
		S: Only the
		"paramsOauth2ClientCredentials"
		- OAUTH2_CLIENT_CREDENTIALS:
		Only the "paramsOauth2ClientCredentials"
		attribute shall be present.
		This attribute shall not be present if no
		credentials are provided for the artifact.
		This attribute shall not be present if no credentials are provided for the artifact.
		type: string
		enum:
		- BASIC
		- OAUTH2_CLIENT_CREDENTIALS
		username:
		description: >

src/SOL005/components/SOL005_params.yaml

+3 −3

Original line number	Diff line number	Diff line
		@@ -105,7 +105,7 @@ components:
		in: query
		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.
		(i.e. those that are not images) from the response message content. The NFVO shall support this parameter.
		The OSS/BSS may supply this parameter.
		required: false
		style: form
		@@ -118,7 +118,7 @@ components:
		in: query
		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.
		response message content. The NFVO shall support this parameter. The OSS/BSS may supply this parameter.
		required: false
		style: form
		explode: true
		@@ -143,7 +143,7 @@ components:
		in: query
		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
		message content. 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.
		required: false