Notification interfaces migrated to OpenAPI 3.0.2 (0fd22956) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/APIVersion/APIVersion.yaml

+5 −5

Original line number	Original line	Diff line number	Diff line
	@@ -20,12 +20,12 @@ externalDocs:

	paths:		paths:
	/vnfconfig/api_versions:		/vnfconfig/api_versions:
	$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'		$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
	/vnffm/api_versions:		/vnffm/api_versions:
	$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'		$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
	/vnfind/api_versions:		/vnfind/api_versions:
	$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'		$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
	/vnflcm/api_versions:		/vnflcm/api_versions:
	$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'		$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
	/vnfpm/api_versions:		/vnfpm/api_versions:
	$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'		$ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
	No newline at end of file		No newline at end of file

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

+231 −362

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+117 −116

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

	info:		info:
	version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
	title: SOL002 - VNF Indicator Notification Endpoint interface		title: SOL002 - VNF Indicator Notification Endpoint interface
	description: >		description: \|
	SOL002 - VNF Indicator Notification Endpoint interface		SOL002 - VNF Indicator Notification Endpoint interface IMPORTANT: Please note that this file might be not aligned to
	IMPORTANT: Please note that this file might be not aligned to the current		the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
	version of the ETSI Group Specification it refers to and has not been		In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to
	approved by the ETSI NFV ISG. In case of discrepancies the published ETSI		https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
	Group Specification takes precedence.		contact:
	Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis		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
	contact:		version: 1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1
	name: NFV-SOL WG

	externalDocs:		externalDocs:
	description: ETSI GS NFV-SOL 002 V2.7.1		description: ETSI GS NFV-SOL 002 V3.3.1
	url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf

	schemes:		servers:
	- http		- url: http://127.0.0.1/callback/v1
	- https		- url: https://127.0.0.1/callback/v1

	consumes:
	- application/json

	produces:
	- application/json

	paths:		paths:
	###############################################################################
	# Notification endpoint VnfIndicatorValueChangeNotification #
	###############################################################################
	'/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':		'/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':
	parameters:		parameters:
	- name: Version		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
	description: >		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
	Version of the API requested to use when responding to this request.		get:
	in: header		summary: Test notification endpoint.
	required: true		description: \|
	type: string		Service Unavailable
	- name: Authorization		The GET method allows the server to test the notification endpoint that is provided by the client,
	description: >		e.g. during subscription.
	The authorization token for the request.		responses:
	Reference: IETF RFC 7235		"204":
	in: header		$ref: '#/components/responses/VNFInNotification.Get'
	required: false		"400":
	type: string		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
			"401":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
			"403":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
			"405":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
			"406":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
			"500":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
			"503":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

	post:		post:
	summary: Notification endpoint		summary: Notification endpoint
	description: >		description: \|
	The API producer can use this resource to send notifications related to VNF indicator		The API producer can use this resource to send notifications related to VNF indicator value changes to a
	value changes to a subscribed API consumer, which has provided the URI of this resource		subscribed API consumer, which has provided the URI of this resource during the subscription process.
	during the subscription process.		The POST method delivers a notification from API producer to an API consumer. The API consumer shall have
	The POST method delivers a notification from API producer to an API consumer. The API		previously created an "Individual subscription" resource with a matching filter.
	consumer shall have previously created an "Individual subscription" resource with a
	matching filter.
	parameters:		parameters:
	- name: vnfIndicatorValueChangeNotification		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
	in: body		requestBody:
	description: >		$ref: '#/components/requestBodies/VnfIndicatorValueChangeNotification'
			responses:
			"204":
			$ref: '#/components/responses/VNFInNotification.Post'
			"400":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
			"401":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
			"403":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
			"405":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
			"406":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
			"500":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
			"503":
			$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

			components:
			requestBodies:
			VnfIndicatorValueChangeNotification:
			description: \|
	A notification about VNF indicator value changes.		A notification about VNF indicator value changes.
	required: true		content:
			application/json:
	schema:		schema:
	$ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'		$ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification
	responses:		required: true
	204:
	description: >
	204 NO CONTENT

	Shall be returned when the notification has been delivered successfully.		responses:
	The response body shall be empty.		VNFInNotification.Get:
			description: \|
			201 NO CONTENT
			Shall be returned to indicate the notification endpoint has been tested successfully. The response body
			shall be empty.
	headers:		headers:
	Version:		Version:
	description: The used API version.		description: \|
			Version of the API used in the response.
			style: simple
			explode: false
			schema:
	type: string		type: string
	maximum: 1		WWW-Authenticate:
	minimum: 1		description: \|
	400:		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"		corresponding HTTP request has provided an invalid authorization token.
	401:		style: simple
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"		explode: false
	403:		schema:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"		type: string
	405:		content: {}
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
	406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
	500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
	503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
	get:
	summary: Test notification endpoint.
	description: >
	Service Unavailable

	The GET method allows the server to test the notification endpoint that is provided		VNFInNotification.Post:
	by the client, e.g. during subscription.		description: \|
	responses:
	204:
	description: >
	204 NO CONTENT		204 NO CONTENT
			Shall be returned when the notification has been delivered 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:		headers:
	WWW-Authenticate:
	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.
	type: string
	maximum: 1
	minimum: 0
	Version:		Version:
	description: The used API version.		description: \|
			Version of the API used in the response.
			style: simple
			explode: false
			schema:
			type: string
			WWW-Authenticate:
			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.
			style: simple
			explode: false
			schema:
	type: string		type: string
	maximum: 1		content: {}
	minimum: 1		No newline at end of file
	400:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
	401:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
	403:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
	405:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
	406:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
	500:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
	503:
	$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
	No newline at end of file

src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml

+215 −403

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml→src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml

+1 −1

File changed and moved.

Contains only whitespace changes.

Admin message