SOL003_181/SOL003_182: Subscriptions methods updated (e4b4ec2d) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFIndicator/VNFIndicator.yaml

+39 −35

Changes for src/SOL003/VNFIndicator/VNFIndicator.yaml: 39 added lines, 35 removed lines.
Original line number	Original line	Diff line number	Diff line
	@@ -403,20 +403,20 @@ paths:
	'/subscriptions':		'/subscriptions':
	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		As the result of successfully executing this method, a new "Individual subscription" resource
	the same filter can result in performance degradation and will provide		as defined in clause 8.4.6 shall have been created. This method shall not trigger any notification.
	duplicates of notifications to the NFVO, and might make sense only in		Creation of two "Individual subscription" resources with the same callbackURI and the same filter
	very rare use cases. Consequently, the VNFM may either allow creating		can result in performance degradation and will provide duplicates of notifications to the NFVO,
	a subscription resource if another subscription resource with the same		and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
	filter and callbackUri already exists (in which case it shall return		a new "Individual subscription" resource if another "Individual subscription" resource with the
	the “201 Created” response code), or may decide to not create a		same filter and callbackUri already exists (in which case it shall return the "201 Created" response code),
	duplicate subscription resource (in which case it shall return a		or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return
	“303 See Other” response code referencing the existing subscription		a "303 See Other" response code referencing the existing "Individual subscription" resource with the same
	resource with the same filter and callbackUri).		filter and callbackUri).
			This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: VnfIndicatorSubscriptionRequest		- name: VnfIndicatorSubscriptionRequest
	description: Details of the subscription to be created.		description: Details of the subscription to be created.
	@@ -456,11 +456,9 @@ paths:
	description: >		description: >
	201 CREATED		201 CREATED

	The subscription was created successfully.		Shall be returned when the subscription has been created successfully.
	The response body shall contain a representation of the created		The response body shall contain a representation of the created "Individual subscription" resource.
	subscription resource.		The HTTP response shall include a "Location" HTTP header that points to the created resource.
	The HTTP response shall include a "Location" HTTP header that
	points to the created subscription resource.
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -499,22 +497,28 @@ 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.
			The GET method queries the list of active subscriptions of the functional block that
			invokes the method. It can be used e.g. for resynchronization after error situations.
	The GET method queries the list of active subscriptions of the		This method shall follow the provisions specified in the tables 8.4.5.3.2-1 and 8.4.5.3.2-2
	functional block that invokes the method. It can be used e.g. for		for URI query parameters, request and response data structures, and response codes.
	resynchronization after error situations.
	parameters:		parameters:
	- name: Accept		- name: Accept
	description: >		description: >
	@@ -539,7 +543,7 @@ 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 VnfIndicatorSubscription		All attribute names that appear in the VnfIndicatorSubscription
	@@ -552,7 +556,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
	@@ -567,15 +571,15 @@ paths:
	description: >		description: >
	200 OK		200 OK

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