SOL003_136 -> SOL003_192: Individual subscription and Notification endpoints updated (bbfcb22a) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml

+45 −12

Original line number	Original line	Diff line number	Diff line
	@@ -1033,14 +1033,20 @@ 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: >
	@@ -1141,14 +1147,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"

	###############################################################################		###############################################################################
	# Individual subscription #		# Individual subscription #
	###############################################################################		###############################################################################
	@@ -1159,18 +1172,18 @@ paths:
	description: >		description: >
	This identifier can be retrieved from the resource referenced by the		This identifier can be retrieved from the resource referenced by the
	"Location" HTTP header in the response to a POST request creating a		"Location" HTTP header in the response to a POST request creating a
	new subscription resource. It can also be retrieved from the "id"		new "Individual subscription" resource. It can also be retrieved from the "id"
	attribute in the payload body of that response.		attribute in the payload body of that response.
	in: path		in: path
	type: string		type: string
	required: true		required: true
	get:		get:
	description: >		description: >
	Query Subscription Information		Query Subscription Information.
			The client can use this method for reading an individual subscription about
			Performance management notifications subscribed by the client.
	The client can use this method for reading an individual subscription		This method shall follow the provisions specified in the tables 6.4.8.3.2-1 and 6.4.8.3.2-2
	about Performance management notifications subscribed by the client.		for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: Accept		- name: Accept
	description: >		description: >
	@@ -1197,8 +1210,9 @@ paths:
	description: >		description: >
	200 OK		200 OK

	The subscription was read successfully. The response body shall		Shall be returned when the subscription has been read successfully.
	contain a representation of the subscription resource.		The response body shall contain a representation of the "Individual subscription" resource,
			as defined in clause 6.5.2.3.
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -1229,20 +1243,33 @@ 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"

	delete:		delete:
	description: >		description: >
	Terminate Subscription		Terminate Subscription.


	This method terminates an individual subscription.		This method terminates an individual subscription.
			This method shall follow the provisions specified in the tables 6.4.8.3.5-1 and 6.4.8.3.5-2
			for URI query parameters, request and response data structures, and response codes.
			As the result of successfully executing this method, the "Individual subscription" resource
			shall not exist any longer. This means that no notifications for that subscription shall
			be sent to the formerly-subscribed API consumer.

			NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
			API consumer for a certain time period after the deletion.
	parameters:		parameters:
	- name: Authorization		- name: Authorization
	description: >		description: >
	@@ -1262,7 +1289,7 @@ paths:
	description: >		description: >
	204 NO CONTENT		204 NO CONTENT

	The subscription resource was deleted successfully.		Shall be returned when the "Individual subscription" resource has been deleted successfully.
	The response body shall be empty.		The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	@@ -1285,11 +1312,17 @@ 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"
			No newline at end of file

src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml

+29 −20

Original line number	Original line	Diff line number	Diff line
	@@ -26,7 +26,7 @@ info:

	externalDocs:		externalDocs:
	description: ETSI GS NFV-SOL 003 V2.5.1		description: ETSI GS NFV-SOL 003 V2.5.1
	url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.05.01_60/gs_nfv-sol003v020501p.pdf		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf

	basePath: "/callback/v1"		basePath: "/callback/v1"

	@@ -46,11 +46,12 @@ paths:
	#SOL003 location: 6.4.9		#SOL003 location: 6.4.9
	post:		post:
	description: >		description: >
	Notify		Notify.
			The POST method delivers a notification regarding a performance management
			event from the server to the client.API producer to an API consumer.
	The POST method delivers a notification regarding a performance		The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
	management event from the server to the client.		This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: PerformanceInformationAvailableNotification		- name: PerformanceInformationAvailableNotification
	description: >		description: >
	@@ -84,7 +85,7 @@ paths:
	description: >		description: >
	204 NO CONTENT		204 NO CONTENT

	The notification was delivered successfully.		Shall be returned when the notification has been delivered successfully.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	description: >		description: >
	@@ -116,8 +117,10 @@ paths:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
	get:		get:
	description: >		description: >
	The GET method allows the server to test the notification endpoint		The GET method allows the server to test the notification endpoint that is provided by the client,
	that is provided by the client, e.g. during subscription.		e.g. during subscription.
			This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: Authorization		- name: Authorization
	description: >		description: >
	@@ -137,7 +140,8 @@ paths:
	description: >		description: >
	204 NO CONTENT		204 NO CONTENT

	The notification endpoint was tested successfully.		Shall be returned to indicate that the notification endpoint has been tested successfully.
			The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	description: >		description: >
	@@ -167,6 +171,7 @@ paths:
	$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"

	###############################################################################		###############################################################################
	# Notification endpoint ThresholdCrossedNotification #		# Notification endpoint ThresholdCrossedNotification #
	###############################################################################		###############################################################################
	@@ -174,11 +179,12 @@ paths:
	#SOL003 location: 6.4.9		#SOL003 location: 6.4.9
	post:		post:
	description: >		description: >
	Notify		Notify.
			The POST method delivers a notification regarding a performance management
			event from the server to the client.API producer to an API consumer.
	The POST method delivers a notification regarding a performance		The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
	management event from the server to the client.		This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: ThresholdCrossedNotification		- name: ThresholdCrossedNotification
	description: >		description: >
	@@ -212,7 +218,7 @@ paths:
	description: >		description: >
	204 NO CONTENT		204 NO CONTENT

	The notification was delivered successfully.		Shall be returned when the notification has been delivered successfully.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	description: >		description: >
	@@ -244,8 +250,10 @@ paths:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
	get:		get:
	description: >		description: >
	The GET method allows the server to test the notification endpoint		The GET method allows the server to test the notification endpoint that is provided by the client,
	that is provided by the client, e.g. during subscription.		e.g. during subscription.
			This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2
			for URI query parameters, request and response data structures, and response codes.
	parameters:		parameters:
	- name: Authorization		- name: Authorization
	description: >		description: >
	@@ -265,7 +273,8 @@ paths:
	description: >		description: >
	204 NO CONTENT		204 NO CONTENT

	The notification endpoint was tested successfully.		Shall be returned to indicate that the notification endpoint has been tested successfully.
			The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	description: >		description: >