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

src/SOL003/VNFIndicator/VNFIndicator.yaml

+40 −36

Original line number	Diff line number	Diff line
		@@ -403,20 +403,20 @@ paths:
		'/subscriptions':
		post:
		description: >
		Subscribe


		Subscribe.
		The POST method creates a new subscription.
		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 NFVO, and might make sense only in
		very rare use cases. Consequently, the VNFM may either allow creating
		a subscription resource if another subscription resource with the same
		filter and callbackUri already exists (in which case it shall return
		the “201 Created” response code), or may decide to not create a
		duplicate subscription resource (in which case it shall return a
		“303 See Other” response code referencing the existing subscription
		resource with the same filter and callbackUri).
		As the result of successfully executing this method, a new "Individual subscription" resource
		as defined in clause 8.4.6 shall have been created. This method shall not trigger any notification.
		Creation of two "Individual subscription" resources with the same callbackURI and the same filter
		can result in performance degradation and will provide duplicates of notifications to the NFVO,
		and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating
		a new "Individual subscription" resource if another "Individual subscription" resource with the
		same filter and callbackUri already exists (in which case it shall return the "201 Created" response code),
		or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return
		a "303 See Other" response code referencing the existing "Individual subscription" resource with the same
		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:
		- name: VnfIndicatorSubscriptionRequest
		description: Details of the subscription to be created.
		@@ -456,11 +456,9 @@ paths:
		description: >
		201 CREATED

		The subscription was created successfully.
		The response body shall contain a representation of the created
		subscription resource.
		The HTTP response shall include a "Location" HTTP header that
		points to the created subscription resource.
		Shall be returned when the subscription has been created successfully.
		The response body shall contain a representation of the created "Individual subscription" resource.
		The HTTP response shall include a "Location" HTTP header that points to the created resource.
		headers:
		Content-Type:
		description: >
		@@ -499,22 +497,28 @@ paths:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
		404:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
		422:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
		504:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

		get:
		description: >
		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.
		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.
		This method shall follow the provisions specified in the tables 8.4.5.3.2-1 and 8.4.5.3.2-2
		for URI query parameters, request and response data structures, and response codes.
		parameters:
		- name: Accept
		description: >
		@@ -539,7 +543,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 NFVO may supply this parameter.
		All attribute names that appear in the VnfIndicatorSubscription
		@@ -552,7 +556,7 @@ 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.
		according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
		in: query
		required: false
		type: string
		@@ -567,15 +571,15 @@ paths:
		description: >
		200 OK

		The list of subscriptions was queried successfully.
		The response body shall contain in an array the representations
		of all active subscriptions of the functional block that invokes
		the method which match the attribute filter, i.e. zero or more
		representations of VNF indicator subscriptions as defined in
		clause 8.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.
		Shall be returned when the list of subscriptions has been queried successfully.
		The response body shall contain in an array the representations of all active
		subscriptions of the functional block that invokes the method which match the attribute filter,
		i.e. zero or more representations of VNF indicator subscriptions as defined in clause 8.5.2.4.
		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 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: >