SOL003_152 -> SOL003_156: Individual alarm and Subscriptions methods updated (7c33978d) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

+68 −37

Original line number	Original line	Diff line number	Diff line
	@@ -166,6 +166,8 @@ paths:
	get:		get:
	description: >		description: >
	The client can use this method to read an individual alarm.		The client can use this method to read an individual alarm.
			This method shall follow the provisions specified in the tables 7.4.3.3.2-1 and 7.4.3.3.2-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: Accept		- name: Accept
	description: >		description: >
	@@ -199,9 +201,8 @@ paths:
	description: >		description: >
	200 OK		200 OK

	Information about an individual alarm was read successfully.		Shall be returned when information about an individual alarm has been read successfully.
	The response body shall contain a representation of the individual		The response body shall contain a representation of the individual alarm
	alarm.
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -218,20 +219,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"

	patch:		patch:
	description: >		description: >
	Acknowledge Alarm		Acknowledge Alarm.


	This method modifies an individual alarm resource.		This method modifies an individual alarm resource.
			This method shall follow the provisions specified in the tables 7.4.3.3.4-1 and 7.4.3.3.4-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: AlarmModifications		- name: AlarmModifications
	description: The VNF creation parameters		description: The VNF creation parameters
	@@ -273,9 +281,9 @@ paths:
	description: >		description: >
	200 OK		200 OK

	The request was accepted and completed. The response body shall		Shall be returned when the request has been accepted and completed.
	contain attribute modifications for an ‘Individual alarm’		The response body shall contain attribute modifications for an "Individual alarm"
	resource.		resource (see clause 7.5.2.4).
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -300,18 +308,30 @@ 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"
	409:		409:
	$ref: "responses/VNFFaultManagement_resp.yaml#/responses/409-alarm-state-conflict"		description: >
			Shall be returned upon the following error: The operation cannot be executed currently,
			due to a conflict with the state of the "Individual alarm" resource.
			Typically, this is due to the fact that the alarm is already in the state that is
			requested to be set (such as trying to acknowledge an already-acknowledged alarm).
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
	412:		412:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
			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"

	###############################################################################		###############################################################################
	# Subscriptions #		# Subscriptions #
	###############################################################################		###############################################################################
	@@ -319,20 +339,20 @@ paths:
	#SOL003 location: 7.4.4		#SOL003 location: 7.4.4
	post:		post:
	description: >		description: >
	Subscribe		Subscribe.


	The POST method creates a new subscription.		The POST method creates a new subscription.
	Creation of two subscription resources with the same callbackURI and		This method shall follow the provisions specified in the tables 7.4.4.3.1-1 and 7.4.4.3.1-2
	the same filter can result in performance degradation and will		for URI query parameters, request and response data structures, and response codes.
	provide duplicates of notifications to the NFVO, and might make sense		As the result of successfully executing this method, a new "Individual subscription" resource
	only in very rare use cases. Consequently, the VNFM may either allow		as defined in clause 7.4.5 shall have been created. This method shall not trigger any notification.
	creating a subscription resource if another subscription resource with		Creation of two "Individual subscription" resources with the same callbackURI and the same filter
	the same filter and callbackUri already exists (in which case it shall		can result in performance degradation and will provide duplicates of notifications to the NFVO,
	return the “201 Created” response code), or may decide to not create a		and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
	duplicate subscription resource (in which case it shall return a		a new "Individual subscription" resource if another "Individual subscription" resource with the
	“303 See Other” response code referencing the existing subscription		same filter and callbackUri already exists (in which case it shall return the "201 Created" response code),
	resource with the same filter and callbackUri).		or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return
			a "303 See Other" response code referencing the existing "Individual subscription" resource with the
			same filter and callbackUri).
	parameters:		parameters:
	- name: FmSubscriptionRequest		- name: FmSubscriptionRequest
	description: The VNF creation parameters		description: The VNF creation parameters
	@@ -372,10 +392,10 @@ paths:
	description: >		description: >
	201 CREATED		201 CREATED

	The subscription was created successfully. The response body shall		Shall be returned when the subscription has been created successfully.
	contain a representation of the created subscription resource.		The response body shall contain a representation of the created "Individual subscription" resource.
	The HTTP response shall include a "Location:" HTTP header that		The HTTP response shall include a "Location:"" HTTP header that points to the created
	points to the created subscription resource.		"Individual subscription" resource.
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -389,6 +409,8 @@ paths:
	The resource URI of the created subscription resource.		The resource URI of the created subscription resource.
	type: string		type: string
	format: url		format: url
			maximum: 1
			minimum: 1
	WWW-Authenticate:		WWW-Authenticate:
	description: >		description: >
	Challenge if the corresponding HTTP request has not provided		Challenge if the corresponding HTTP request has not provided
	@@ -407,14 +429,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"

	get:		get:
	description: >		description: >
	Query Subscription Information		Query Subscription Information
	@@ -447,7 +476,8 @@ 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. The NFVO may supply this parameter.		URI query string. The NFVO may supply this parameter.
	All attribute names that appear in the FmSubscription and in		All attribute names that appear in the FmSubscription and in
	@@ -460,7 +490,7 @@ paths:
	description: >		description: >
	Marker to obtain the next page of a paged response. Shall be		Marker to obtain the next page of a paged response. Shall be
	supported by the VNFM if the VNFM supports alternative 2 (paging)		supported by the VNFM if the VNFM supports alternative 2 (paging)
	according to clause 4.7.2.1 for this resource.		according to clause 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
	@@ -475,14 +505,15 @@ paths:
	description: >		description: >
	200 OK		200 OK

	The list of subscriptions was queried successfully. The response		The list of subscriptions has been queried successfully.
	body shall contain in an array the representations of all active		The response body shall contain in an array the representations of all active subscriptions
	subscriptions of the functional block that invokes the method,		of the functional block that invokes the method, i.e. zero or more representations of
	i.e. zero or more representations of FM subscriptions as defined		FM subscriptions as defined in clause 7.5.2.3.
	in clause 7.5.2.3.		If the "filter" URI parameter was supplied in the request, the data in the response body shall
	If the VNFM supports alternative 2 (paging) according to clause		have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
	4.7.2.1 for this resource, inclusion of the Link HTTP header in		If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
	this response shall follow the provisions in clause 4.7.2.3.		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:		headers:
	Content-Type:		Content-Type:
	description: >		description: >