SOL005_83: Added new endpoint in NSDMgmt API -> "Individual NSD archive artifact" (593cfce8) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSDManagement/NSDManagement.yaml

+321 −114

Original line number	Original line	Diff line number	Diff line
	@@ -428,7 +428,7 @@ paths:
	409:		409:
	# description: >		# description: >
	# 409 CONFLICT		# 409 CONFLICT
	#
	# Error: The operation cannot be executed currently,		# Error: The operation cannot be executed currently,
	# due to a conflict with the state of the resource.		# due to a conflict with the state of the resource.
	# Typically, this is due to an operational state		# Typically, this is due to an operational state
	@@ -507,7 +507,7 @@ paths:
	409:		409:
	# description: >		# description: >
	# 409 CONFLICT		# 409 CONFLICT
	#
	# Error: The operation cannot be executed currently,		# Error: The operation cannot be executed currently,
	# due to a conflict with the state of the resource.		# due to a conflict with the state of the resource.
	# Typically, this is due to the fact the NS descriptor		# Typically, this is due to the fact the NS descriptor
	@@ -620,7 +620,7 @@ paths:
	206:		206:
	# description: >		# description: >
	# 206 PARTIAL CONTENT		# 206 PARTIAL CONTENT
	#
	# On success, if the NFVO supports range requests,		# On success, if the NFVO supports range requests,
	# a single consecutive byte range from the content of		# a single consecutive byte range from the content of
	# the NSD file is returned.		# the NSD file is returned.
	@@ -644,7 +644,7 @@ paths:
	406:		406:
	# description: >		# description: >
	# 406 NOT ACCEPTABLE		# 406 NOT ACCEPTABLE
	#
	# If the "Accept" header does not contain at least one		# If the "Accept" header does not contain at least one
	# name of a content type for which the NFVO can		# name of a content type for which the NFVO can
	# provide a representation of the NSD, the NFVO		# provide a representation of the NSD, the NFVO
	@@ -656,7 +656,7 @@ paths:
	409:		409:
	# description: >		# description: >
	# 409 CONFLICT		# 409 CONFLICT
	#
	# Shall be returned upon the following error: The		# Shall be returned upon the following error: The
	# operation cannot be executed currently, due to a		# operation cannot be executed currently, due to a
	# conflict with the state of the resource.		# conflict with the state of the resource.
	@@ -670,7 +670,7 @@ paths:
	416:		416:
	# description: >		# description: >
	# 416 RANGE NOT SATISFIABLE		# 416 RANGE NOT SATISFIABLE
	#
	# The byte range passed in the "Range" header did		# The byte range passed in the "Range" header did
	# not match any available byte range in the NSD file		# not match any available byte range in the NSD file
	# (e.g. "access after end of file").		# (e.g. "access after end of file").
	@@ -1029,7 +1029,7 @@ paths:
	409:		409:
	# description: >		# description: >
	# 409 CONFLICT		# 409 CONFLICT
	#
	# Shall be returned upon the following error: The		# Shall be returned upon the following error: The
	# operation cannot be executed currently, due to a		# operation cannot be executed currently, due to a
	# conflict with the state of the resource.		# conflict with the state of the resource.
	@@ -1047,6 +1047,213 @@ paths:
	504:		504:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/504"		$ref: "../responses/SOL005_resp.yaml#/components/responses/504"

			###############################################################################
			# Individual NSD Archive Artifact #
			###############################################################################
			'/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
			#ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.4c
			parameters:
			- name: nsdInfoId
			description: >
			Identifier of the individual NS descriptor.
			This identifier can be retrieved from the resource referenced by
			the "Location" HTTP header in the response to a POST request creating
			a new NS descriptor resource. It can also be retrieved from the "id"
			attribute in the payload body of that response.
			in: path
			required: true
			type: string
			- name: artifactPath
			description: >
			For an artifact contained as a file in the NSD archive, this variable shall
			contain a sequence of one or path segments representing the path of the
			artifact within the NSD archive, relative to the root of the package.

			EXAMPLE: foo/bar/m%40ster.sh

			For an external artifact represented as a URI in the NSD archive manifest,
			this variable shall contain the URI as provided in the NS archive.

			This identifier can be retrieved from the "artifactPath" attribute of the
			applicable "artifacts" entry in the body of the response to a GET request
			querying the "Individual NSD" resource.

			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.
			in: path
			required: true
			type: string
			- name: Authorization
			description: >
			The authorization token for the request.
			Reference: IETF RFC 7235.
			in: header
			required: false
			type: string
			- name: Version
			description: >
			Version of the API requested to use when responding to this request.
			in: header
			required: true
			type: string
			get:
			description: >
			The GET method fetches the content of an individual artifact within
			a NSD archive.

			This method shall follow the provisions specified in the Tables 5.4.4c.3.2-1
			and 5.4.4c.3.2-2 for URI query parameters, request and response data structures,
			and response codes.
			parameters:
			- name : Range
			description: >
			The request may contain a "Range" HTTP header to obtain single
			range of bytes from an artifact 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.
			in: header
			required: false
			type: string
			- name : include_signatures
			description: >
			If this parameter is provided, the NFVO shall return the artifact
			and related security information (such as signature and optional
			certificate) in a ZIP archive.

			If this parameter is not given, the NFVO shall provide only a copy
			of the artifact file. This URI query parameter is a flag, i.e.
			it shall have no value.

			The NFVO shall support this parameter.
			in: query
			required: false
			type: string
			responses:
			200:
			description: >
			200 OK

			Shall be returned when the 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 NSD archive, as defined
			by ETSI GS NFV-SOL 007, 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 NFVSOL 007
			- the related security information (individual signature file and optional related individual
			certificate file).
			headers:
			Content-Type:
			description: The MIME type of the body of the response.
			type: string
			maximum: 1
			minimum: 1
			WWW-Authenticate:
			type: string
			description: >
			Challenge if the corresponding HTTP request has not provided
			authorization, or error details if the corresponding HTTP request
			has provided an invalid authorization token.
			maximum: 1
			minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
			206:
			description: >
			206 PARTIAL CONTENT

			If the NFVO supports range requests 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 NSD archive,
			as defined by ETSI GS NFV-SOL 007.

			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.
			headers:
			Content-Type:
			description: The MIME type of the body of the response.
			type: string
			maximum: 1
			minimum: 1
			WWW-Authenticate:
			type: string
			description: >
			Challenge if the corresponding HTTP request has not provided
			authorization, or error details if the corresponding HTTP request
			has provided an invalid authorization token.
			maximum: 1
			minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
			400:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
			401:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
			403:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
			404:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
			406:
			# description: >
			# If the related request contained an "Accept" header not compatible with the Content type
			# "application/zip" but the "include_signatures" flag was provided, the NFVO shall respond
			# with this response code.

			# The "ProblemDetails" structure may be included with the "detail" attribute providing more
			# information about the error.
			$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
			405:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
			409:
			# description: >
			# 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 "nsdOnboardingState" 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/SOL005_resp.yaml#/components/responses/409"
			416:
			# description: >
			# 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/SOL005_resp.yaml#/components/responses/416"
			500:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
			503:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
			504:
			$ref: "../responses/SOL005_resp.yaml#/components/responses/504"

	###############################################################################		###############################################################################
	# PNF Descriptors #		# PNF Descriptors #
	###############################################################################		###############################################################################
	@@ -1651,7 +1858,7 @@ paths:
	409:		409:
	# description: >		# description: >
	# 409 CONFLICT		# 409 CONFLICT
	#
	# Shall be returned upon the following error: The		# Shall be returned upon the following error: The
	# operation cannot be executed currently, due to a		# operation cannot be executed currently, due to a
	# conflict with the state of the resource.		# conflict with the state of the resource.
	@@ -1757,7 +1964,7 @@ paths:
	409:		409:
	# description: >		# description: >
	# 409 CONFLICT		# 409 CONFLICT
	#
	# Error: The operation cannot be executed currently,		# Error: The operation cannot be executed currently,
	# due to a conflict with the state of the resource.		# due to a conflict with the state of the resource.
	# Typically, this is due to the fact that the		# Typically, this is due to the fact that the
	@@ -2146,7 +2353,7 @@ paths:
	303:		303:
	# description: >		# description: >
	# 303 SEE OTHER		# 303 SEE OTHER
	#
	# Shall be returned when a subscription with the		# Shall be returned when a subscription with the
	# same callbackURI and the same filter already		# same callbackURI and the same filter already
	# exits and the policy of the NFVO is to not create		# exits and the policy of the NFVO is to not create

Admin message