SOL003_173/SOL003_174/SOL003_176: VNF Indicators methods updated (87f6d267) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL003/VNFIndicator/VNFIndicator.yaml

+38 −33

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

		externalDocs:
		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
		description: ETSI GS NFV-SOL 003 V2.6.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf

		basePath: "/vnfind/v1"

		@@ -41,10 +41,10 @@ paths:
		#SOL003 location: 8.4.2
		get:
		description: >
		Get Indicator Value


		Get Indicator Value.
		The GET method queries multiple VNF indicators.
		This method shall follow the provisions specified in the tables 8.4.2.3.2-1 and 8.4.2.3.2-2
		for URI query parameters, request and response data structures, and response codes.
		parameters:
		- name: Accept
		description: >
		@@ -62,7 +62,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 VnfIndicator and in
		@@ -75,7 +75,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
		@@ -90,15 +90,14 @@ paths:
		description: >
		200 OK

		Information about zero or more VNF indicators was queried
		successfully.
		The response body shall contain in an array the representations
		of all VNF indicators that match the attribute filter, i.e.
		zero or more representations of VNF indicators as defined in
		clause 8.5.2.2.
		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 information about zero or more VNF indicators has been queried successfully.
		The response body shall contain in an array the representations of all VNF indicators that match
		the attribute filter, i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2.
		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: >
		@@ -137,14 +136,21 @@ 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"

		###############################################################################
		# VNF indicators related to a VNF instance #
		###############################################################################
		@@ -156,18 +162,17 @@ paths:
		Identifier of the VNF instance to which the VNF indicator applies.
		This identifier can be retrieved from the resource referenced by the
		"Location" HTTP header in the response to a POST request creating a
		new VNF instance resource. It can also be retrieved from the "id"
		new "Individual VNF instance" resource. It can also be retrieved from the "id"
		attribute in the payload body of that response.
		in: path
		type: string
		required: true
		get:
		description: >
		Get Indicator Value


		The GET method queries multiple VNF indicators related to a VNF
		instance.
		Get Indicator Value.
		The GET method queries multiple VNF indicators related to a VNF instance.
		This method shall follow the provisions specified in the tables 8.4.3.3.2-1 and 8.4.3.3.2-2
		for URI query parameters, request and response data structures, and response codes.
		parameters:
		- name: Accept
		description: >
		@@ -192,7 +197,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 VnfIndicator and in
		@@ -205,7 +210,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
		@@ -220,15 +225,15 @@ paths:
		description: >
		200 OK

		Information about zero or more VNF indicators was queried
		successfully.
		The response body shall contain in an array the representations
		of all VNF indicators that are related to the particular VNF
		instance and that match the attribute filter, i.e. zero or more
		representations of VNF indicators as defined in clause 8.5.2.2.
		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 information about zero or more VNF indicators has been queried successfully.
		The response body shall contain in an array the representations of all VNF indicators that are related
		to the particular VNF instance and that match the attribute filter, i.e. zero or more representations
		of VNF indicators as defined in clause 8.5.2.2.
		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: >