SOL002: VNF Fault mgmt notification interface updated with multiple body types (3ffe4064) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+22 −281

Original line number	Original line	Diff line number	Diff line
	@@ -34,86 +34,16 @@ produces:

	paths:		paths:
	###############################################################################		###############################################################################
	# Notification endpoint AlarmNotification #		# Notification endpoint #
	###############################################################################		###############################################################################
	'/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification':		'/URI-is-provided-by-the-client-when-creating-the-subscription':
	post:
	description: >
	Notify


	The POST method notifies a VNF alarm or that the alarm list has been
	rebuilt.
	parameters:		parameters:
	- name: AlarmNotification
	description: >
	Information of a VNF alarm.
	in: body
	required: true
	schema:
	$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
	- name: Authorization
	description: >
	The authorization token for the request.
	Reference: IETF RFC 7235
	in: header
	required: false
	type: string
	- name: Content-Type
	description: >
	The Content-Type header shall be set to
	"application/merge-patch+json" according to
	IETF RFC 7396.
	in: header
	required: true
	type: string
	- name: Version		- name: Version
	description: >		description: >
	Version of the API requested to use when responding to this request.		Version of the API requested to use when responding to this request.
	in: header		in: header
	required: true		required: true
	type: string		type: string
	responses:
	204:
	description: >
	No Content

	The notification was delivered successfully.
	The response body shall be empty.
	headers:
	WWW-Authenticate:
	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.
	type: string
	maximum: 1
	minimum: 0
	Version:
	description: >
	Version of the API used in the response.
	type: string
	maximum: 1
	minimum: 1
	400:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
	401:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
	403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
	405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
	406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
	500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
	503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
	get:
	description: >
	The GET method allows the server to test the notification endpoint
	that is provided by the client, e.g. during subscription.
	parameters:
	- name: Authorization		- name: Authorization
	description: >		description: >
	The authorization token for the request.		The authorization token for the request.
	@@ -121,52 +51,6 @@ paths:
	in: header		in: header
	required: false		required: false
	type: string		type: string
	- name: Version
	description: >
	Version of the API requested to use when responding to this request.
	in: header
	required: true
	type: string
	responses:
	204:
	description: >
	No Content

	The notification endpoint was tested successfully.
	The response body shall be empty.
	headers:
	WWW-Authenticate:
	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.
	type: string
	maximum: 1
	minimum: 0
	Version:
	description: >
	Version of the API used in the response.
	type: string
	maximum: 1
	minimum: 1
	400:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
	401:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
	403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
	405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
	406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
	500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
	503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
	###############################################################################
	# Notification endpoint AlarmClearedNotification #
	###############################################################################
	'/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification':
	post:		post:
	description: >		description: >
	Notify		Notify
	@@ -175,150 +59,27 @@ paths:
	The POST method notifies a VNF alarm or that the alarm list has been		The POST method notifies a VNF alarm or that the alarm list has been
	rebuilt.		rebuilt.
	parameters:		parameters:
			- name: AlarmNotification
			description: >
			Information of a VNF alarm.
			in: body
			required: false
			schema:
			$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
	- name: AlarmClearedNotification		- name: AlarmClearedNotification
	description: >		description: >
	Information of the clearance of a VNF alarm		Information of the clearance of a VNF alarm
	in: body		in: body
	required: true		required: false
	schema:		schema:
	$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
	- name: Authorization
	description: >
	The authorization token for the request.
	Reference: IETF RFC 7235
	in: header
	required: false
	type: string
	- name: Content-Type
	description: >
	The Content-Type header shall be set to
	"application/merge-patch+json" according to
	IETF RFC 7396.
	in: header
	required: true
	type: string
	- name: Version
	description: >
	Version of the API requested to use when responding to this request.
	in: header
	required: true
	type: string
	responses:
	204:
	description: >
	No Content

	The notification was delivered successfully.
	The response body shall be empty.
	headers:
	WWW-Authenticate:
	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.
	type: string
	maximum: 1
	minimum: 0
	Version:
	description: >
	Version of the API used in the response.
	type: string
	maximum: 1
	minimum: 1
	400:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
	401:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
	403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
	405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
	406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
	500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
	503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
	get:
	description: >
	The GET method allows the server to test the notification endpoint
	that is provided by the client, e.g. during subscription.
	parameters:
	- 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
	responses:
	204:
	description: >
	No Content

	The notification endpoint was tested successfully.
	The response body shall be empty.
	headers:
	WWW-Authenticate:
	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.
	type: string
	maximum: 1
	minimum: 0
	Version:
	description: >
	Version of the API used in the response.
	type: string
	maximum: 1
	minimum: 1
	400:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
	401:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
	403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
	405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
	406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
	500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
	503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
	###############################################################################
	# Notification endpoint AlarmListRebuiltNotification #
	###############################################################################
	'/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification':
	post:
	description: >
	Notify


	The POST method notifies a VNF alarm or that the alarm list has been
	rebuilt.
	parameters:
	- name: AlarmListRebuiltNotification		- name: AlarmListRebuiltNotification
	description: >		description: >
	Information that the alarm list has been rebuilt by the VNFM		Information that the alarm list has been rebuilt by the VNFM
	in: body		in: body
	required: true		required: false
	schema:		schema:
	$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"		$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
	- name: Authorization
	description: >
	The authorization token for the request.
	Reference: IETF RFC 7235
	in: header
	required: false
	type: string
	- name: Content-Type		- name: Content-Type
	description: >		description: >
	The Content-Type header shall be set to		The Content-Type header shall be set to
	@@ -327,16 +88,10 @@ paths:
	in: header		in: header
	required: true		required: true
	type: string		type: string
	- name: Version
	description: >
	Version of the API requested to use when responding to this request.
	in: header
	required: true
	type: string
	responses:		responses:
	204:		204:
	description: >		description: >
	No Content		204 NO CONTENT

	The notification was delivered successfully.		The notification was delivered successfully.
	The response body shall be empty.		The response body shall be empty.
	@@ -373,24 +128,10 @@ paths:
	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, e.g. during subscription.		that is provided by the client, e.g. during subscription.
	parameters:
	- 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
	responses:		responses:
	204:		204:
	description: >		description: >
	No Content		201 NO CONTENT

	The notification endpoint was tested successfully.		The notification endpoint was tested successfully.
	The response body shall be empty.		The response body shall be empty.

Admin message