Merge "Fixing usage of query and read operations for Indicator API" (e5dcec48) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFIndicator/VNFIndicator.yaml

+17 −12

Original line number	Original line	Diff line number	Diff line
	swagger: "2.0"		swagger: "2.0"

	info:		info:
	version: "2.3.1"		version: "1.1.1"
	title: "DRAFT VNF Indicator interface"		title: "DRAFT VNF Indicator interface"
	description: >		description: >
	DRAFT VNF Indicator interface of ETSI NFV SOL002		DRAFT VNF Indicator interface of ETSI NFV SOL002.

			This API allows the EM/VNF to provide information on value changes of VNF related indicators.
			VNF related indicators are declared in the VNFD.

	IMPORTANT: Please note that this file might be not aligned to the current		IMPORTANT: Please note that this file might be not aligned to the current
	version of the ETSI Group Specification it refers to and has not been		version of the ETSI Group Specification it refers to and has not been
	approved by the ETSI NFV ISG. In case of discrepancies the published ETSI		approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
	Group Specification takes precedence.		Group Specification takes precedence.
	Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---		Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
	termsOfService: "http://etsi.org"		termsOfService: "http://etsi.org"
	contact:		contact:
	name: "NFV-SOL WG"		name: "NFV-SOL WG"
	license:		license:
	name: "ETSI Forge copyright notice"		name: "ETSI Forge copyright notice"
	url: https://forge.etsi.org/etsi-forge-copyright-notice.txt		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
			externalDocs:
			description: ETSI GS NFV-SOL 002 V2.3.3
			url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL002ed241_Ve-Vnfm_RESTful_protocols_spec/NFV-SOL002ed241v233.zip

	basePath: /vnfind/v1		basePath: /vnfind/v1

	@@ -221,18 +227,17 @@ paths:
	type: string		type: string
	required: true		required: true
	get:		get:
	summary: Query multiple indicators related to a VNF instance.		summary: Read an inidividual VNF indicator related to a VNF instance.
	description: >		description: >
	Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.		Read an individual VNF indicator related to a specific VNF instance.
	NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a		NOTE: 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" attribute in the payload body		POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body
	of that response.		of that response.
	responses:		responses:
	200:		200:
	description: >		description: >
	The list of VNF indicators was queried successfully.		The VNF indicator was read successfully.
	The response body shall contain the representations of all VNF indicators that match		The response body shall contain the representation of the VNF indicator.
	the attribute-based filtering parameters.
	schema:		schema:
	$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'		$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator'
	400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }		400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
	@@ -250,7 +255,7 @@ paths:

	/subscriptions:		/subscriptions:
	post:		post:
	summary: Create a new subscription		summary: Create a new subscription to VNF indicator change notifications
	description: Create a new subscription		description: Create a new subscription
	parameters:		parameters:
	- name: subscription		- name: subscription
	@@ -284,7 +289,7 @@ paths:
	500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }		500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
	503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }		503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
	get:		get:
	summary: Query subscriptions.		summary: Query multiple subscriptions.
	description: >		description: >
	The GET method queries the list of active subscriptions of the functional block		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.		that invokes the method. It can be used e.g. for resynchronization after error situations.
	@@ -384,7 +389,7 @@ paths:

	/subscriptions/{subscriptionId}:		/subscriptions/{subscriptionId}:
	get:		get:
	summary: Query subscriptions.		summary: Read an individual subscription.
	description: >		description: >
	This resource represents an individual subscription. The client can use this resource to		This resource represents an individual subscription. The client can use this resource to
	read and to terminate a subscription to notifications related to VNF indicator value changes.		read and to terminate a subscription to notifications related to VNF indicator value changes.

Admin message