SOL003: migrating VNFIND Notification API to OAS3 (0770a721) · Commits · Miguel Angel Reina Ortega / SOL002-SOL003

src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml

+90 −103

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

		info:
		version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		title: SOL003 - VNF Indicator interface
		description: >
		description: \|
		SOL003 - VNF Indicator interface


		@@ -20,147 +19,135 @@ info:
		design.

		Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
		contact:
		name: NFV-SOL WG
		license:
		name: "ETSI Forge copyright notice"
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"

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

		basePath: "/callback/v1"

		schemes:
		- https

		consumes:
		- "application/json"
		produces:
		- "application/json"
		servers:
		- url: http://127.0.0.1/callback/v1
		- url: https://127.0.0.1/callback/v1

		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:
		#SOL003 location: 8.4.7
		post:
		description: >
		description: \|
		Notify.
		The POST method delivers a notification from the API producer to an API consumer.
		The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
		This method shall follow the provisions specified in the tables 8.4.7.3.1-1 and 8.4.7.3.1-2
		for URI query parameters, request and response data structures, and response codes.
		parameters:
		- name: AlarmListRebuiltNotification
		description: >
		Information that the alarm list has been rebuilt by the VNFM
		in: body
		required: true
		schema:
		$ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification"
		- name: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: false
		type: string
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		type: string
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
		requestBody:
		$ref: '#/components/requestBodies/AlarmListRebuiltNotification'
		responses:
		204:
		description: >
		204 NO CONTENT

		Shall be returned when the notification has been delivered successfully.
		The response body shall be empty.
		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:
		description: >
		Version of the API used in the response.
		type: string
		maximum: 1
		minimum: 1
		$ref: '#/components/responses/VNFINDNotification.Post.204'
		400:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
		401:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
		403:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
		405:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
		406:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
		500:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
		503:
		$ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
		$ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

		get:
		description: >
		description: \|
		The GET method allows the API producer to test the notification endpoint that is provided by
		the API consumer, e.g. during subscription.
		This method shall follow the provisions specified in the tables 8.4.7.3.2-1 and 8.4.7.3.2-2
		for URI query parameters, request and response data structures, and response codes.
		parameters:
		- name: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: false
		type: string
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		type: string
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
		- $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
		responses:
		204:
		description: >
		$ref: '#/components/responses/VNFINDNotification.Get.204'
		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:
		AlarmListRebuiltNotification:
		description: Information that the alarm list has been rebuilt by the VNFM.
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification
		required: true

		responses:
		VNFINDNotification.Post.204:
		description: \|
		204 NO CONTENT

		Shall be returned when the notification has been delivered successfully.
		The response body shall be empty.
		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.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string

		VNFINDNotification.Get.204:
		description: \|
		204 NO CONTENT
		Shall be returned to indicate that the notification endpoint has been tested successfully.
		The response body shall be empty.
		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.
		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
		maximum: 1
		minimum: 0
		Version:
		description: >
		Version of the API used in the response.
		description: The used API version.
		style: simple
		explode: false
		schema:
		type: string
		maximum: 1
		minimum: 1
		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