update to SOL005 NS FM (728f153c) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/NSFaultManagement/NSFaultManagement.yaml

+42 −36

Original line number	Original line	Diff line number	Diff line
	@@ -64,7 +64,7 @@ paths:
	required: false		required: false
	type: string		type: string
	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 NFVO shall support receiving this parameter as part of the URI query string.		The NFVO shall support receiving this parameter as part of the URI query string.
	The OSS/BSS may supply this parameter.		The OSS/BSS may supply this parameter.
	The following attribute names shall be supported by the NFVO in the filter		The following attribute names shall be supported by the NFVO in the filter
	@@ -82,7 +82,7 @@ paths:
	in: query		in: query
	description: >		description: >
	Marker to obtain the next page of a paged response. Shall be supported by the NFVO		Marker to obtain the next page of a paged response. Shall be supported by the NFVO
	if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.		if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013.
	required: false		required: false
	type: string		type: string
	- name: Accept		- name: Accept
	@@ -97,11 +97,13 @@ paths:
	description: >		description: >
	200 OK		200 OK

	Information about zero or more alarms was queried successfully.		Shall be returned when information about zero or more alarms has been queried successfully.
	The response body shall contain the list of related alarms.		The response body shall contain the list of related alarms.
	If the NFVO supports alternative 2 (paging) according to		If the "filter" URI parameter was supplied in the request, the data in the response body shall
	clause 4.7.2.1 for this resource, inclusion of the Link HTTP header		have been transformed according to the rules specified in clauses 5.2.2 of ETSI GS NFV-SOL 013.
	in this response shall follow the provisions in clause 4.7.2.3.		If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
			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: The MIME type of the body of the response.		description: The MIME type of the body of the response.
	@@ -202,9 +204,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		The response body shall contain a representation of the individual alarm.
	individual alarm.
	headers:		headers:
	Content-Type:		Content-Type:
	description: The MIME type of the body of the response.		description: The MIME type of the body of the response.
	@@ -279,9 +280,9 @@ paths:
	description: >		description: >
	200 OK		200 OK

	The request was accepted and completed.		Shall be returned when the request has been accepted and completed.
	The response body shall contain attribute modifications		The response body shall contain attribute modifications for an 'Individual alarm'
	for an 'Individual alarm' resource (see clause 8.5.2.4).		resource (see clause 8.5.2.4).
	headers:		headers:
	Content-Type:		Content-Type:
	description: The MIME type of the body of the response.		description: The MIME type of the body of the response.
	@@ -350,6 +351,8 @@ paths:
	The POST method creates a new subscription.		The POST method creates a new subscription.
	This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query		This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query
	parameters, request and response data structures, and response codes.		parameters, request and response data structures, and response codes.
			As the result of successfully executing this method, a new "Individual subscription" resource shall exist
			as defined in clause 8.4.5. This method shall not trigger any notification.
	Creation of two subscription resources with the same callbackURI and the same filter can result in performance		Creation of two subscription resources with the same callbackURI and the same filter can result in performance
	degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare		degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare
	use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription		use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription
	@@ -383,11 +386,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		The response body shall contain a representation of the created subscription resource.
	created subscription resource.		The HTTP response shall include a "Location:" HTTP header that points to the created subscription resource.
	The HTTP response shall include a "Location:" HTTP
	header that points to the created subscription resource.
	schema:		schema:
	$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"		$ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
	headers:		headers:
	@@ -445,16 +446,16 @@ paths:
	required: false		required: false
	type: string		type: string
	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 NFVO shall support receiving this parameter as part of the URI		The NFVO shall support receiving this parameter as part of the URI query string. The
	query string. The OSS/BSS may supply this parameter.		OSS/BSS may supply this parameter.
	All attribute names that appear in the FmSubscription and in data types		All attribute names that appear in the FmSubscription and in data types referenced from it
	referenced from it shall be supported by the NFVO in the filter expression.		shall be supported by the NFVO in the filter expression.
	- name: nextpage_opaque_marker		- name: nextpage_opaque_marker
	in: query		in: query
	description: >		description: >
	Marker to obtain the next page of a paged response. Shall be supported by the NFVO		Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO
	if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.		supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
	required: false		required: false
	type: string		type: string
	- name: Accept		- name: Accept
	@@ -476,14 +477,15 @@ paths:
	description: >		description: >
	200 OK		200 OK

	The list of subscriptions was queried successfully.		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 subscriptions of the
	of all active subscriptions of the functional block that invokes		functional block that invokes the method, i.e. zero or more representations of FM subscriptions, as
	the method, i.e. zero or more representations of FM subscriptions,		defined in clause 8.5.2.3.
	as defined in clause 8.5.2.3.		If the "filter" URI parameter was supplied in the request, the data in the response body shall have
	If the NFVO supports alternative 2 (paging) according to		been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013.
	clause 4.7.2.1 for this resource, inclusion of the Link HTTP header		If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for
	in this response shall follow the provisions in clause 4.7.2.3.		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: The MIME type of the body of the response.		description: The MIME type of the body of the response.
	@@ -588,9 +590,8 @@ paths:
	description: >		description: >
	200 OK		200 OK

	The operation has completed successfully.		Shall be returned when information about an individual subscription has been read successfully.
	The response body shall contain a representation of the		The response body shall contain a representation of the subscription resource.
	subscription resource.
	headers:		headers:
	Content-Type:		Content-Type:
	description: >		description: >
	@@ -635,12 +636,17 @@ paths:
	Terminate Subscription		Terminate Subscription

	This method terminates an individual subscription.		This method terminates an individual subscription.
			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.
	responses:		responses:
	204:		204:
	description: >		description: >
	204 - No Content		204 - No Content

	The subscription resource was deleted successfully.		Shall be returned when the subscription resource has been deleted successfully.
	The response body shall be empty.		The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:

src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml

+3 −4

Original line number	Original line	Diff line number	Diff line
	@@ -304,10 +304,9 @@ definitions:
	format: url		format: url
	authentication:		authentication:
	description: >		description: >
	Authentication parameters to configure the use of Authorization when		Authentication parameters to configure the use of Authorization when sending notifications
	sending notifications corresponding to this subscription.		corresponding to this subscription, as defined in clause 4.5.3.4.8.3.4 of ETSI GS NFV SOL 013.
	This attribute shall only be present if the subscriber requires		This attribute shall only be present if the subscriber requires authorization of notifications.
	authorization of notifications.
	$ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"		$ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"

	PerceivedSeverityType:		PerceivedSeverityType:

src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml

+85 −9

Original line number	Original line	Diff line number	Diff line
	@@ -14,8 +14,8 @@ info:
	url: https://forge.etsi.org/etsi-forge-copyright-notice.txt		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

	externalDocs:		externalDocs:
	description: ETSI GS NFV-SOL 005 V2.5.1		description: ETSI GS NFV-SOL 005 V2.6.1
	url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf

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

	@@ -36,7 +36,7 @@ paths:
	summary: Notify about NS alarms		summary: Notify about NS alarms
	description: >		description: >
	The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.		The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
			The API consumer shall have previously created an "individual subscription resource" with a matching filter.
	parameters:		parameters:
	- name: alarmNotification		- name: alarmNotification
	description: >		description: >
	@@ -77,7 +77,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.
	The response body shall be empty.		The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	@@ -106,7 +106,7 @@ paths:
	$ref: "../responses/SOL005_resp.yaml#/responses/503"		$ref: "../responses/SOL005_resp.yaml#/responses/503"

	'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':		'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
	#ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6		#ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.6
	post:		post:
	summary: Notify about NS alarms		summary: Notify about NS alarms
	description: >		description: >
	@@ -178,6 +178,70 @@ paths:
	$ref: "../responses/SOL005_resp.yaml#/responses/500"		$ref: "../responses/SOL005_resp.yaml#/responses/500"
	503:		503:
	$ref: "../responses/SOL005_resp.yaml#/responses/503"		$ref: "../responses/SOL005_resp.yaml#/responses/503"
			get:
			summary: Test the notification endpoint.
			description: >
			The GET method allows the server to test the notification endpoint that is provided by
			the client, e.g. during subscription.
			parameters:
			- name: Accept
			description: >
			Content-Types that are acceptable for the response.
			Reference: IETF RFC 7231
			in: header
			required: true
			type: string
			- 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: >
			204 No Content

			Shall be returned when the notification endpoint has been tested successfully.
			The response body shall be empty.
			headers:
			WWW-Authenticate:
			type: string
			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.
			maximum: 1
			minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
			400:
			$ref: "../responses/SOL005_resp.yaml#/responses/400"
			401:
			$ref: "../responses/SOL005_resp.yaml#/responses/401"
			403:
			$ref: "../responses/SOL005_resp.yaml#/responses/403"
			404:
			$ref: "../responses/SOL005_resp.yaml#/responses/404"
			405:
			$ref: "../responses/SOL005_resp.yaml#/responses/405"
			406:
			$ref: "../responses/SOL005_resp.yaml#/responses/406"
			500:
			$ref: "../responses/SOL005_resp.yaml#/responses/500"
			503:
			$ref: "../responses/SOL005_resp.yaml#/responses/503"

	'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':		'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
	post:		post:
	@@ -253,10 +317,10 @@ paths:
	$ref: "../responses/SOL005_resp.yaml#/responses/503"		$ref: "../responses/SOL005_resp.yaml#/responses/503"

	get:		get:
	summary: Test the notification endpoint		summary: Test the notification endpoint.
	description: >		description: >
	The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during		The GET method allows the server to test the notification endpoint that is provided by
	subscription.		the client, e.g. during subscription.
	parameters:		parameters:
	- name: Accept		- name: Accept
	description: >		description: >
	@@ -283,7 +347,7 @@ paths:
	description: >		description: >
	204 No Content		204 No Content

	The notification endpoint was tested successfully.		Shall be returned when the notification endpoint has been tested successfully.
	The response body shall be empty.		The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:		WWW-Authenticate:
	@@ -294,12 +358,24 @@ paths:
	has provided an invalid authorization token.		has provided an invalid authorization token.
	maximum: 1		maximum: 1
	minimum: 0		minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
	400:		400:
	$ref: "../responses/SOL005_resp.yaml#/responses/400"		$ref: "../responses/SOL005_resp.yaml#/responses/400"
	401:		401:
	$ref: "../responses/SOL005_resp.yaml#/responses/401"		$ref: "../responses/SOL005_resp.yaml#/responses/401"
	403:		403:
	$ref: "../responses/SOL005_resp.yaml#/responses/403"		$ref: "../responses/SOL005_resp.yaml#/responses/403"
			404:
			$ref: "../responses/SOL005_resp.yaml#/responses/404"
			405:
			$ref: "../responses/SOL005_resp.yaml#/responses/405"
			406:
			$ref: "../responses/SOL005_resp.yaml#/responses/406"
	500:		500:
	$ref: "../responses/SOL005_resp.yaml#/responses/500"		$ref: "../responses/SOL005_resp.yaml#/responses/500"
	503:		503:

Admin message