SOL003_122/SOL003_123/SOL003_124/SOL003_125: Thresholds POST and GET description fields updated (f50e77f3) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml

+51 −38

Original line number	Original line	Diff line number	Diff line
	@@ -471,8 +471,9 @@ paths:
	required: true		required: true
	get:		get:
	description: >		description: >
	The client can use this method for reading an individual performance		The client can use this method for reading an individual performance report.
	report.		This method shall follow the provisions specified in the tables 6.4.4.3.2-1 and 6.4.4.3.2-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: Accept		- name: Accept
	description: >		description: >
	@@ -499,10 +500,9 @@ paths:
	description: >		description: >
	200 OK		200 OK

	Information of an individual performance report was read		Shall be returned when information of an individual performance report has been read successfully.
	successfully.		The response body shall contain a representation of the "Individual performance report" resource,
	The response body shall contain a representation of the		as defined in clause 6.5.2.10.
	performance report resource.
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -533,14 +533,21 @@ paths:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
	403:		403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			404:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
	405:		405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
	406:		406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			422:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
	500:		500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
	503:		503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			504:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

	###############################################################################		###############################################################################
	# Thresholds #		# Thresholds #
	###############################################################################		###############################################################################
	@@ -548,10 +555,12 @@ paths:
	#SOL003 location: 6.4.5		#SOL003 location: 6.4.5
	post:		post:
	description: >		description: >
	Create Threshold		Create Threshold.


	The POST method can be used by the client to create a threshold.		The POST method can be used by the client to create a threshold.
			This method shall follow the provisions specified in the tables 6.4.5.3.1-1 and 6.4.5.3.1-2
			for URI query parameters, request and response data structures, and response codes.
			As the result of successfully executing this method, a new "Individual threshold" resource
			as defined in clause 6.4.6 shall have been created.
	parameters:		parameters:
	- name: CreateThresholdRequest		- name: CreateThresholdRequest
	description: >		description: >
	@@ -592,10 +601,11 @@ paths:
	description: >		description: >
	201 CREATED		201 CREATED

	A threshold was created successfully. The response body shall		Shall be returned when a threshold has been created successfully.
	contain a representation of the created threshold resource.		The response body shall contain a representation of the created "Individual threshold" resource,
	The HTTP response shall include a "Location" HTTP header that		as defined in clause 6.5.2.9.
	contains the resource URI of the created threshold resource.		The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
			created threshold resource.
	headers:		headers:
	Location:		Location:
	description: The resource URI of the created VNF instance		description: The resource URI of the created VNF instance
	@@ -630,20 +640,27 @@ paths:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
	403:		403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			404:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
	405:		405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
	406:		406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			422:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
	500:		500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
	503:		503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			504:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

	get:		get:
	description: >		description: >
	Query Threshold		Query Threshold.


	The client can use this method to query information about thresholds.		The client can use this method to query information about thresholds.
			This method shall follow the provisions specified in the tables 6.4.5.3.2-1 and 6.4.5.3.2-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: Accept		- name: Accept
	description: >		description: >
	@@ -661,24 +678,19 @@ paths:
	type: string		type: string
	- name: filter		- name: filter
	description: >		description: >
	Attribute-based filtering expression according to clause 4.3.2.		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
	The VNFM shall support receiving this parameter as part of the		The VNFM shall support receiving this parameter as part of the URI query string.
	URI query string. The NFVO may supply this parameter.		The NFVO may supply this parameter.
	All attribute names that appear in the Thresholds and in		All attribute names that appear in the Thresholds data type and in data types referenced
	data types referenced from it shall be supported by the VNFM		from it shall be supported by the VNFM in the filter expression.
	in the filter expression.

	NOTE: There are no attribute selectors defined for this resource as
	the threshold attributes with cardinality 0..1 or 0..N are not
	structurally complex in nature.
	in: query		in: query
	required: false		required: false
	type: string		type: string
	- name: nextpage_opaque_marker		- name: nextpage_opaque_marker
	description: >		description: >
	Marker to obtain the next page of a paged response. Shall be		Marker to obtain the next page of a paged response.
	supported by the VNFM if the VNFM supports alternative 2 (paging)		Shall be supported by the VNFM if the VNFM supports alternative 2 (paging) according to clause
	according to clause 4.7.2.1 for this resource.		5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
	in: query		in: query
	required: false		required: false
	type: string		type: string
	@@ -693,14 +705,15 @@ paths:
	description: >		description: >
	200 OK		200 OK

	Information about zero or more thresholds was queried		Shall be returned when information about zero or more thresholds has been queried successfully.
	successfully.		If the "filter" URI parameter was supplied in the request, the data in the response body shall have
	The response body shall contain in an array representations		been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
	of zero or more thresholds, as defined in 6.5.2.9.		The response body shall contain in an array the representations of zero or more thresholds,
	If the VNFM supports alternative 2 (paging) according to		as defined in clause 6.5.2.9.
	clause 4.7.2.1 for this resource, inclusion of the Link		If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
	HTTP header in this response shall follow the provisions		for this resource, inclusion of the Link HTTP header in this response shall follow the provisions
	in clause 4.7.2.3.		in clause 5.4.2.3 of ETSI GS NFV-SOL 013.

	headers:		headers:
	Location:		Location:
	description: The resource URI of the created VNF instance		description: The resource URI of the created VNF instance