VNF Pkg Mgmt Notification interface migrated to OpenAPI 3.0.2 (069c48af) · Commits · NFV - Network Functions Virtualisation / SOL005

src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml

+221 −260

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

	info:		info:
	version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"		title: SOL005 - VNF Package Management Notification interface
	title: "SOL005 - VNF Package Management Notification interface"		description: \|
	description: >		SOL005 - VNF Package Management Notification interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
	SOL005 - VNF Package Management Notification interface
	IMPORTANT: Please note that this file might be not aligned to the current
	version of the ETSI Group Specification it refers to. In case of
	discrepancies the published ETSI Group Specification takes precedence.
	Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
	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
			version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

	externalDocs:		externalDocs:
	description: ETSI GS NFV-SOL 005 V2.7.1		description: ETSI GS NFV-SOL 005 V3.3.1
	url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
	basePath: /callback/v1
	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 NS Performance Management #
	##################################################################################
	'/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':		'/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':
	post:		parameters:
			- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
			- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
			get:
	summary: Notify about VNF package onboarding or change		summary: Notify about VNF package onboarding or change
	description: >		description: \|
	The POST method delivers a notification from the API producer to an API consumer.		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.		The API consumer shall have previously created an "individual subscription resource" with a matching filter.
	parameters:		parameters:
	- name: VnfPackageOnboardingNotification		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
	description: >
	A notification about on-boarding of a VNF package.
	in: body
	required: true
	schema:
	$ref: "definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification"
	- name: Accept
	description: >
	Content-Types that are acceptable for the response.
	Reference: IETF RFC 7231
	in: header
	required: true
	type: string
	- name: Authorization
	description: >
	The authorization token for the request.
	Reference: IETF RFC 7235
	in: header
	required: false
	type: string
	- name: Content-Type
	description: >
	The MIME type of the body of the request.
	Reference: IETF RFC 7231
	in: header
	required: true
	type: string
	- name: Version
	description: >
	Version of the API requested to use when responding to this request.
	in: header
	required: true
	type: string
	responses:		responses:
	204:		"204":
	description: >		$ref: '#/components/responses/VnfPackageOnboardingNotification.Get'
	204 No Content		"400":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/400
			"401":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/401
			"403":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/403
			"405":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/405
			"406":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/406
			"500":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/500
			"503":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/503

	Shall be returned when the notification has been delivered successfully.		post:
	headers:		summary: Notify about VNF package onboarding or change
	WWW-Authenticate:		description: \|
	type: string		The POST method delivers a notification from the API producer to an API consumer.
	description: >		The API consumer shall have previously created an "individual subscription resource" with a matching filter.
	Challenge if the corresponding HTTP request has not provided		parameters:
	authorization, or error details if the corresponding HTTP request		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
	has provided an invalid authorization token.		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
	maximum: 1		requestBody:
	minimum: 0		$ref: '#/components/requestBodies/VnfPackageOnboardingNotificationRequest'
	Version:		responses:
	description: >		"204":
	Version of the API used in the response.		$ref: '#/components/responses/VnfPackageOnboardingNotification.Post'
	type: string		"400":
	maximum: 1		$ref: ../responses/SOL005_resp.yaml#/components/responses/400
	minimum: 1		"401":
	400:		$ref: ../responses/SOL005_resp.yaml#/components/responses/401
	$ref: "../responses/SOL005_resp.yaml#/components/responses/400"		"403":
	401:		$ref: ../responses/SOL005_resp.yaml#/components/responses/403
	$ref: "../responses/SOL005_resp.yaml#/components/responses/401"		"405":
	403:		$ref: ../responses/SOL005_resp.yaml#/components/responses/405
	$ref: "../responses/SOL005_resp.yaml#/components/responses/403"		"406":
	500:		$ref: ../responses/SOL005_resp.yaml#/components/responses/406
	$ref: "../responses/SOL005_resp.yaml#/components/responses/500"		"500":
	503:		$ref: ../responses/SOL005_resp.yaml#/components/responses/500
	$ref: "../responses/SOL005_resp.yaml#/components/responses/503"		"503":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/503

			/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification:
			parameters:
			- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
			- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
	get:		get:
	summary: Test the notification endpoint.		summary: Test the notification endpoint
	description: >		description: \|
	The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g.		The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
	during subscription.		e.g. during subscription.
			parameters:
			- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
			responses:
			"204":
			$ref: '#/components/responses/VnfPackageChangeNotification.Get'
			"400":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/400
			"401":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/401
			"403":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/403
			"405":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/405
			"406":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/406
			"500":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/500
			"503":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/503

			post:
			summary: Notify about VNF package onboarding or change
			description: \|
			The POST method delivers a notification from the server to the client. This method shall follow the provisions
			specified in the Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters, request and response data
			structures, and response codes.
	parameters:		parameters:
	- name: Accept		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
	description: >		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
	Content-Types that are acceptable for the response.		requestBody:
	Reference: IETF RFC 7231		$ref: '#/components/requestBodies/VnfPackageChangeNotificationRequest'
	in: header		responses:
			"204":
			$ref: '#/components/responses/VnfPackageChangeNotification.Post'
			"400":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/400
			"401":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/401
			"403":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/403
			"405":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/405
			"406":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/406
			"500":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/500
			"503":
			$ref: ../responses/SOL005_resp.yaml#/components/responses/503

			components:
			requestBodies:
			VnfPackageOnboardingNotificationRequest:
			description: \|
			A notification about on-boarding of a VNF package.
			content:
			application/json:
			schema:
			$ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification
	required: true		required: true
	type: string
	- name: Authorization		VnfPackageChangeNotificationRequest:
	description: >		description: \|
	The authorization token for the request.		A notification about changes of status in a VNF package.
	Reference: IETF RFC 7235		content:
	in: header		application/json:
	required: false		schema:
	type: string		$ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification
	- name: Version
	description: >
	Version of the API requested to use when responding to this request.
	in: header
	required: true		required: true
	type: string
	responses:		responses:
	204:		VnfPackageOnboardingNotification.Get:
	description: >		description: \|
	204 No Content		204 No Content

	Shall be returned to indicate that the notification endpoint has been tested successfully.		Shall be returned to indicate that the notification endpoint has been tested successfully.
	The response body shall be empty.		The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:
	type: string
	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.
	maximum: 1
	minimum: 0
	Version:		Version:
	description: >		description: \|
	Version of the API used in the response.		Version of the API used in the response.
	type: string		style: simple
	maximum: 1		explode: false
	minimum: 1
	400:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
	401:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
	403:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
	404:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
	405:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
	406:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
	500:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
	503:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/503"

	'/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification':
	post:
	summary: Notify about VNF package onboarding or change
	description: >
	The POST method delivers a notification from the server to the client.
	This method shall follow the provisions specified in the
	Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
	request and response data structures, and response codes.
	parameters:
	- name: VnfPackageChangeNotification
	description: >
	A notification about changes of status in a VNF package.
	in: body
	required: true
	schema:		schema:
	$ref: "definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification"
	- name: Accept
	description: >
	Content-Types that are acceptable for the response.
	Reference: IETF RFC 7231
	in: header
	required: true
	type: string		type: string
	- name: Authorization		WWW-Authenticate:
	description: >		description: \|
	The authorization token for the request.		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
	Reference: IETF RFC 7235		corresponding HTTP request has provided an invalid authorization token.
	in: header		style: simple
	required: false		explode: false
			schema:
	type: string		type: string
	- name: Content-Type		content: {}
	description: >
	The MIME type of the body of the request.		VnfPackageOnboardingNotification.Post:
	Reference: IETF RFC 7231		description: \|
	in: header		204 No Content
	required: true		Shall be returned when the notification has been delivered successfully.
			headers:
			Version:
			description: \|
			Version of the API used in the response.
			style: simple
			explode: false
			schema:
	type: string		type: string
	- name: Version		WWW-Authenticate:
	description: >		description: \|
	Version of the API requested to use when responding to this request.		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
	in: header		corresponding HTTP request has provided an invalid authorization token.
	required: true		style: simple
			explode: false
			schema:
	type: string		type: string
	responses:		content: {}
	204:
	description: >
	204 No Content

			VnfPackageChangeNotification.Get:
			description: \|
			204 No Content
	Shall be returned to indicate that the notification endpoint has been tested successfully.		Shall be returned to indicate that the notification endpoint has been tested successfully.
	The response body shall be empty.		The response body shall be empty.
	headers:		headers:
	WWW-Authenticate:
	type: string
	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.
	maximum: 1
	minimum: 0
	Version:		Version:
	description: >		description: \|
	Version of the API used in the response.		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/SOL005_resp.yaml#/components/responses/400"		corresponding HTTP request has provided an invalid authorization token.
	401:		style: simple
	$ref: "../responses/SOL005_resp.yaml#/components/responses/401"		explode: false
	403:		schema:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
	500:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
	503:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/503"

	get:
	summary: Test the notification endpoint
	description: >
	The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g.
	during subscription.
	parameters:
	- name: Accept
	description: >
	Content-Types that are acceptable for the response.
	Reference: IETF RFC 7231
	in: header
	required: true
	type: string		type: string
	- name: Authorization		content: {}
	description: >
	The authorization token for the request.		VnfPackageChangeNotification.Post:
	Reference: IETF RFC 7235		description: \|
	in: header		204 No Content
	required: false		Shall be returned when the notification has been delivered successfully.
			headers:
			Version:
			description: \|
			Version of the API used in the response.
			style: simple
			explode: false
			schema:
	type: string		type: string
	- name: Version		WWW-Authenticate:
	description: >		description: \|
	Version of the API requested to use when responding to this request.		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
	in: header		corresponding HTTP request has provided an invalid authorization token.
	required: true		style: simple
			explode: false
			schema:
	type: string		type: string
	responses:		content: {}
	204:		No newline at end of file
	description: >
	204 No Content

	The notification endpoint was tested successfully.
	The response body shall be empty.
	400:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
	401:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
	403:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
	500:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
	503:
	$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
	No newline at end of file

Admin message