SOL005_87 to SOL005_123 (c89bca81) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSFaultManagement/NSFaultManagement.yaml

+8 −8

Original line number	Original line	Diff line number	Diff line
	@@ -85,8 +85,8 @@ paths:
	/alarms/{alarmId}:		/alarms/{alarmId}:
	parameters:		parameters:
	- $ref: '#/components/parameters/AlarmId'		- $ref: '#/components/parameters/AlarmId'
	- $ref: ../components/SOL005_params.yaml#/components/parameters/Version		- $ref: '../components/SOL005_params.yaml#/components/parameters/Version'
	- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization		- $ref: '../components/SOL005_params.yaml#/components/parameters/Authorization'
	get:		get:
	description: \|		description: \|
	The API consumer can use this method to read an individual alarm. See clause 8.4.3.3.2.		The API consumer can use this method to read an individual alarm. See clause 8.4.3.3.2.
	@@ -296,7 +296,7 @@ components:
	description: \|		description: \|
	Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute		Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute
	in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of		in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of
	the applicable array element in the payload body of the response to a GET request to the "Alarms" resource.		the applicable array element in the message content of the response to a GET request to the "Alarms" resource.
	required: true		required: true
	style: simple		style: simple
	explode: false		explode: false
	@@ -309,7 +309,7 @@ components:
	description: \|		description: \|
	Identifier of this subscription. This identifier can be retrieved from the resource referenced by the		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 subscription resource. It can also		"Location" HTTP header in the response to a POST request creating a new subscription resource. It can also
	be retrieved from the "id" attribute in the payload body of that response.		be retrieved from the "id" attribute in the message content of that response.
	required: true		required: true
	style: simple		style: simple
	explode: false		explode: false
	@@ -627,11 +627,11 @@ components:

	FmSubscriptions.Post.422:		FmSubscriptions.Post.422:
	description: \|		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		Shall be returned upon the following error: The content type of the message content is supported and the
	body of a request contains syntactically correct data but the data cannot be processed.		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],		The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
	including rules for the presence of the response body.		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		Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
	the Notification endpoint as described in clause 8.4.6.3.2 and the test has failed.		the Notification endpoint as described in clause 8.4.6.3.2 and the test has failed.

src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -20,7 +20,7 @@ definitions:
	properties:		properties:
	id:		id:
	description: >		description: >
	Identifier of this Alarm information element.		Identifier of this Alarm structure.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
	managedObjectId:		managedObjectId:
	description: >		description: >

src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml

+27 −24

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

	externalDocs:		externalDocs:
	description: ETSI GS NFV-SOL 005 V3.6.1		description: ETSI GS NFV-SOL 005 V3.6.1
	@@ -756,7 +756,7 @@ components:
	description: \|		description: \|
	Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"		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		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.		from the "id" attribute in the message content of that response.
	required: true		required: true
	style: simple		style: simple
	explode: false		explode: false
	@@ -784,7 +784,7 @@ components:

	VnfPackageExtArtifactsRequest:		VnfPackageExtArtifactsRequest:
	description: \|		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.		external VNF package artifact files.
	content:		content:
	application/json:		application/json:
	@@ -800,18 +800,19 @@ components:
	file:		file:
	type: string		type: string
	description: \|		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.		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		format: binary
	required: true		required: true

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

	VnfPkgSubscriptionRequest:		VnfPkgSubscriptionRequest:
	@@ -1059,7 +1060,7 @@ components:
	IndividualVnfPackageVnfd.Get.200:		IndividualVnfPackageVnfd.Get.200:
	description: \|		description: \|
	200 OK		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		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		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.		returned file, i.e. to "text/plain" for a YAML file or to "application/zip" for a ZIP file.
	@@ -1270,14 +1271,16 @@ components:
	IndividualVnfPackageManifest.Get.200:		IndividualVnfPackageManifest.Get.200:
	description: \|		description: \|
	200 OK		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		Shall be returned when the content of the manifest has been read successfully. If the "include_signatures" URI query
	(i.e. there is no separate certificate file), the payload body shall contain a copy of the manifest file of the		parameter was absent in the request, or if the manifest file has all security-related information embedded (i.e.
	VNF package, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI		there is no separate certificate file), the message content shall contain a copy of the manifest file of the VNF
	query parameter was present in the related request and the manifest file does not have all the security-related		package, and the "Content-Type" HTTP header shall be set to "text/plain".
	information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to		If the "include_signatures" URI query parameter was present in the related request and the manifest file does
	"application/zip and the payload body shall contain a ZIP archive which includes: - a copy of the manifest file		not have all the security-related information embedded (i.e. there is a separate certificate file), the
	of the VNF package - a copy of the related individual certificate file.		"Content-Type" HTTP header shall be set to "application/zip" and the message content shall contain a ZIP
			archive which includes:
			- a copy of the manifest file of the VNF package
	headers:		headers:
	Version:		Version:
	description: \|		description: \|
	@@ -1406,7 +1409,7 @@ components:
	If the NFVO supports range requests, this response shall be returned when a single consecutive byte range		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.		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 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.		The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
	headers:		headers:
	Version:		Version:
	@@ -1560,7 +1563,7 @@ components:
	description: \|		description: \|
	200 OK		200 OK
	Shall be returned when the whole content of the archive containing the artifact files has been read successfully.		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		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.		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".		The "Content-Type" HTTP header shall be set to "application/zip".
	@@ -1597,7 +1600,7 @@ components:
	read successfully according to the request.		read successfully according to the request.
	The response body shall contain the requested part of the archive.		The response body shall contain the requested part of the archive.
	The "Content-Type" HTTP header shall be set to "application/zip".		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:		headers:
	Version:		Version:
	description: \|		description: \|
	@@ -1748,13 +1751,13 @@ components:
	IndividualVnfPackageArtifact.Get.200:		IndividualVnfPackageArtifact.Get.200:
	description: \|		description: \|
	200 OK Shall be returned when the whole content of the artifact file has been read successfully. If the		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		"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 [5], and the		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		"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 [17]). If the content
	type cannot be determined, the header shall be set to the value "application/octet-stream".		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"		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:		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 [5];		- 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).		- the related security information (individual signature file and optional related individual certificate file).
	headers:		headers:
	@@ -1791,7 +1794,7 @@ components:
	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 [5].
	The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the		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".		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:		headers:
	Version:		Version:
	@@ -2033,10 +2036,10 @@ components:

	VnfPkgSubscriptions.Post.422:		VnfPkgSubscriptions.Post.422:
	description: \|		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		Shall be returned upon the following error: The content type of the message content is supported and the message
	body of a request contains syntactically correct data but the data cannot be processed.		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],		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.		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		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

+15 −27

Original line number	Original line	Diff line number	Diff line
	@@ -203,13 +203,20 @@ definitions:
	synthesize this path in a manner that avoids any collision		synthesize this path in a manner that avoids any collision
	of the synthesized artifact path with the paths and names		of the synthesized artifact path with the paths and names
	of artifacts included in the package.		of artifacts included in the package.

			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.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/String"		$ref: "../../definitions/SOL005_def.yaml#/definitions/String"
	artifactURI:		artifactURI:
	description: >		description: >
	URI of the artifact as defined in the VNF package		URI of the artifact as defined in the VNF package
	manifest. Shall be present if the artifact is external to the		manifest. Shall be present if the artifact is external to the
	package and shall be absent otherwise.		package and shall be absent otherwise.

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

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

	UploadVnfPkgFromUriRequest:		UploadVnfPackageFromUriRequest:
	description: >		description: >
	This type represents the request parameters for uploading the content of a VNF package. The NFVO can obtain the		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		VNF package content through the information provided in the request parameters. It shall comply with the provisions
	@@ -515,19 +522,10 @@ definitions:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
	authType:		authType:
	description: >		description: >
	Defines the type of authentication /		Defines the type of authentication/authorization for downloading the VNF package.
	authorization for downloading the VNF
	package.
	Permitted values:		Permitted values:
	- BASIC: Only the "username" and		- OAUTH2_CLIENT_CREDENTIALS: Only the "paramsOauth2ClientCredentials" attribute shall be present.
	"password" attributes shall be		This attribute shall not be present if the credentials were provisioned out of band
	present.
	- OAUTH2_CLIENT_CREDENTIAL
	S: Only the
	"paramsOauth2ClientCredentials"
	attribute shall be present.
	This attribute shall not be present if no
	credentials are provided for the artifact.
	type: string		type: string
	enum:		enum:
	- BASIC		- BASIC
	@@ -821,20 +819,10 @@ definitions:
	$ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"		$ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
	authType:		authType:
	description: >		description: >
	Defines the type of authentication /		Defines the type of authentication/authorization for downloading the VNF package.
	authorization for downloading the VNF
	package.
	Permitted values:		Permitted values:
	- BASIC: Only the "username" and		- OAUTH2_CLIENT_CREDENTIALS: Only the "paramsOauth2ClientCredentials" attribute shall be present.
	"password" attributes shall be		This attribute shall not be present if no credentials are provided for the artifact.type: string
	present.
	- OAUTH2_CLIENT_CREDENTIAL
	S: Only the
	"paramsOauth2ClientCredentials"
	attribute shall be present.
	This attribute shall not be present if no
	credentials are provided for the artifact.
	type: string
	enum:		enum:
	- BASIC		- BASIC
	- OAUTH2_CLIENT_CREDENTIALS		- OAUTH2_CLIENT_CREDENTIALS

src/SOL005/components/SOL005_params.yaml

+3 −3

Original line number	Original line	Diff line number	Diff line
	@@ -105,7 +105,7 @@ components:
	in: query		in: query
	description: \|		description: \|
	Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of additional MANO artifacts		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.		The OSS/BSS may supply this parameter.
	required: false		required: false
	style: form		style: form
	@@ -118,7 +118,7 @@ components:
	in: query		in: query
	description: \|		description: \|
	Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of non-MANO artifacts from the		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		required: false
	style: form		style: form
	explode: true		explode: true
	@@ -143,7 +143,7 @@ components:
	in: query		in: query
	description: \|		description: \|
	Flag (i.e. parameter without value) that instructs the NFVO to include external artifacts in the response		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.		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.		The NFVO shall support this parameter. The OSS/BSS may supply this parameter.
	required: false		required: false

Admin message