Merge branch '2.6.1-dev' into 'master' (7ee66cc8) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

+20 −7

Original line number	Diff line number	Diff line
		@@ -17,8 +17,8 @@ info:
		name: NFV-SOL WG

		externalDocs:
		description: ETSI GS NFV-SOL 002 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
		description: ETSI GS NFV-SOL 002 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf

		basePath: /vnfconfig/v1

		@@ -65,7 +65,9 @@ paths:
		200:
		description: >
		200 OK
		Configuration information about a VNF instance was read successfully.

		Shall be returned when configuration information about a VNF instance
		has been read successfully.
		The response body shall contain a representation of the configuration resource.
		schema:
		$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration'
		@@ -123,16 +125,17 @@ paths:
		required: true
		in: body
		schema:
		$ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
		$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications'
		responses:
		200:
		description: >
		200 OK

		The request was accepted and completed. The response body shall contain the parameters
		of the configuration modification that was applied to the configuration resource.
		Shall be returned when the request has been accepted and completed.
		The response body shall contain the parameters of the configuration
		modification that was applied to the configuration resource.
		schema:
		$ref: 'definitions/SOL002VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
		$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications'
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		@@ -157,6 +160,16 @@ paths:
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		412:
		description: >
		412 PRECONDITION FAILED

		Shall be returned upon the following error: A precondition given
		in an HTTP request header is not fulfilled.
		Typically, this is due to an ETag mismatch, indicating that the resource
		was modified by another entity. The response body should contain a
		ProblemDetails structure, in which the "detail" attribute should convey
		more information about the error.

		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
		416:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

+61 −28

Original line number	Diff line number	Diff line
		@@ -17,8 +17,8 @@ info:
		name: NFV-SOL WG

		externalDocs:
		description: ETSI GS NFV-SOL 002 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
		description: ETSI GS NFV-SOL 002 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf

		basePath: /vnffm/v1

		@@ -79,7 +79,7 @@ paths:
		type: string
		- name: filter
		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 URI query string.
		The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter.
		The following attribute names shall be supported in the filter expression: id, managedObjectId,
		@@ -116,7 +116,8 @@ paths:
		description: >
		Marker to obtain the next page of a paged response.
		Shall be supported by the VNFM if the VNFM supports alternative 2
		(paging) according to clause 4.7.2.1 for this resource.
		(paging) according to clause 5.4.2.1 5.2 of ETSI GS NFV-SOL 013
		for this resource.
		in: query
		required: false
		type: string
		@@ -125,11 +126,15 @@ paths:
		description: >
		200 OK

		Information about zero or more alarms was queried successfully.
		Shall be returned when information about zero or more alarms was queried successfully.
		The response body shall contain in an array the representations of zero or more alarms
		as defined in clause 7.5.2.4.
		If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
		inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
		If the "filter" URI parameter was supplied in the request, the data in the response body
		shall 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 5.4.2.1 of
		ETSI GS NFV-SOL 013for 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:
		Content-Type:
		description: The MIME type of the body of the response.
		@@ -235,7 +240,8 @@ paths:
		description: >
		200 OK

		Information about an individual alarm was read successfully.
		Shall be returned when information about an individual alarm read
		successfully.
		The response body shall contain a representation of the individual
		alarm.
		headers:
		@@ -312,9 +318,9 @@ paths:
		description: >
		200 OK

		The request was accepted and completed. The response body shall
		contain attribute modifications for an ‘Individual alarm’
		resource.
		Shall be returned when the request was accepted and completed.
		The response body shall contain attribute modifications for
		an "Individual alarm" resource.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		@@ -352,14 +358,24 @@ paths:
		description: >
		409 CONFLICT

		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).
		The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
		convey more information about the error.
		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).
		The response body shall contain a ProblemDetails structure, in which the
		"detail" attribute shall convey more information about the error.
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
		412:
		description: >
		412 PRECONDITION FAILED

		ErrorShall be returned upon the following error: A precondition given in an
		HTTP request header is not fulfilled.
		Typically, this is due to an ETag mismatch, indicating that the resource was
		modified by another entity.
		The response body should contain a ProblemDetails structure, in which the
		"detail" attribute should convey more information about the error.
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
		416:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
		@@ -397,6 +413,9 @@ paths:
		description: >
		The POST method enables the consumer to escalate the perceived severity
		of an alarm that is represented by an ndividual alarm resource.
		As the result of successfully executing this method, a new "Individual
		subscription" resource as defined in clause 7.4.5 shall have been created.
		This method shall not trigger any notification.
		parameters:
		- name: alarmId
		description: >
		@@ -419,8 +438,8 @@ paths:
		description: >
		200 OK

		The VNFM has received the proposed "escalated perceived severity" value
		successfully. The response body shall be empty.
		Shall be returned when the VNFM has received the proposed "escalated
		perceived severity" value successfully. The response body shall be empty.
		headers:
		Version:
		description: The used API version.
		@@ -586,7 +605,7 @@ paths:
		type: string
		- name: filter
		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 URI query string.
		The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter.
		All attribute names that appear in the FmSubscription and in data types referenced from it
		@@ -621,7 +640,8 @@ paths:
		description: >
		Marker to obtain the next page of a paged response.
		Shall be supported by the VNFM if the VNFM supports alternative 2
		(paging) according to clause 4.7.2.1 for this resource.
		(paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for
		this resource.
		in: query
		required: false
		type: string
		@@ -630,12 +650,16 @@ paths:
		description: >
		200 OK

		The list of subscriptions was queried successfully. The response
		The list of subscriptions has been queried successfully. The response
		body shall contain the representations of all active
		subscriptions of the functional block that invokes the method.
		If the "filter" URI parameter was supplied in the request, the data
		in the response body shall 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
		4.7.2.1 for this resource, inclusion of the Link HTTP header in this
		response shall follow the provisions in clause 4.7.2.3.
		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:
		Content-Type:
		description: The MIME type of the body of the response.
		@@ -741,9 +765,10 @@ paths:
		description: >
		200 OK

		The operation has completed successfully.
		The response body shall contain a representation of the
		subscription resource.
		Shall be returned when information about an individual subscription
		has been read successfully.
		The response body shall contain a representation of the "Individual
		subscription" resource.
		headers:
		Content-Type:
		description: The MIME type of the body of the response.
		@@ -792,12 +817,20 @@ paths:
		delete:
		description: >
		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:
		204:
		description: >
		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.
		headers:
		Version:

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+17 −11

Original line number	Diff line number	Diff line
		@@ -17,8 +17,8 @@ info:
		name: NFV-SOL WG

		externalDocs:
		description: ETSI GS NFV-SOL 002 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
		description: ETSI GS NFV-SOL 002 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf

		basePath: /callback/v1

		@@ -56,7 +56,8 @@ paths:
		Notify

		The POST method notifies a VNF alarm or that the alarm list has been
		rebuilt.
		rebuilt. The API consumer shall have previously created an "Individual
		subscription" resource with a matching filter.
		parameters:
		- name: AlarmNotification
		description: >
		@@ -78,7 +79,7 @@ paths:
		description: >
		204 NO CONTENT

		The notification was delivered successfully.
		Shall be returned when the notification has been delivered successfully.
		The response body shall be empty.
		headers:
		WWW-Authenticate:
		@@ -118,7 +119,8 @@ paths:
		description: >
		201 NO CONTENT

		The notification endpoint was tested successfully.
		Shall be returned to indicate the notification endpoint has been
		tested successfully.
		The response body shall be empty.
		headers:
		WWW-Authenticate:
		@@ -173,7 +175,8 @@ paths:
		Notify

		The POST method notifies a VNF alarm or that the alarm list has been
		rebuilt.
		rebuilt. The API consumer shall have previously created an "Individual
		subscription" resource with a matching filter.
		parameters:
		- name: AlarmClearedNotification
		description: >
		@@ -195,7 +198,7 @@ paths:
		description: >
		204 NO CONTENT

		The notification was delivered successfully.
		Shall be returned when the notification has been delivered successfully.
		The response body shall be empty.
		headers:
		WWW-Authenticate:
		@@ -235,7 +238,8 @@ paths:
		description: >
		201 NO CONTENT

		The notification endpoint was tested successfully.
		Shall be returned to indicate the notification endpoint has been
		tested successfully.
		The response body shall be empty.
		headers:
		WWW-Authenticate:
		@@ -290,7 +294,8 @@ paths:
		Notify

		The POST method notifies a VNF alarm or that the alarm list has been
		rebuilt.
		rebuilt. The API consumer shall have previously created an "Individual
		subscription" resource with a matching filter.
		parameters:
		- name: AlarmListRebuiltNotification
		description: >
		@@ -312,7 +317,7 @@ paths:
		description: >
		204 NO CONTENT

		The notification was delivered successfully.
		Shall be returned when the notification has been delivered successfully.
		The response body shall be empty.
		headers:
		WWW-Authenticate:
		@@ -352,7 +357,8 @@ paths:
		description: >
		204 NO CONTENT

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

src/SOL002/VNFIndicator/VNFIndicator.yaml

+79 −44

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+9 −5

Original line number	Diff line number	Diff line
		@@ -17,8 +17,8 @@ info:
		name: NFV-SOL WG

		externalDocs:
		description: ETSI GS NFV-SOL 002 V2.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
		description: ETSI GS NFV-SOL 002 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf

		schemes:
		- http
		@@ -55,7 +55,9 @@ paths:
		The API producer can use this resource to send notifications related to VNF indicator
		value changes to a subscribed API consumer, which has provided the URI of this resource
		during the subscription process.
		The POST method delivers a notification from the server to the client.
		The POST method delivers a notification from API producer to an API consumer. The API
		consumer shall have previously created an "Individual subscription" resource with a
		matching filter.
		parameters:
		- name: vnfIndicatorValueChangeNotification
		in: body
		@@ -69,7 +71,8 @@ paths:
		description: >
		204 NO CONTENT

		The notification was delivered successfully. The response body shall be empty.
		Shall be returned when the notification has been delivered successfully.
		The response body shall be empty.
		headers:
		Version:
		description: The used API version.
		@@ -102,7 +105,8 @@ paths:
		description: >
		204 NO CONTENT

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