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	Diff line number	Diff line
		swagger: "2.0"
		openapi: 3.0.2

		info:
		version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
		title: "SOL005 - VNF Package Management Notification interface"
		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
		title: SOL005 - VNF Package Management Notification interface
		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
		license:
		name: "ETSI Forge copyright notice"
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		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
		basePath: /callback/v1
		schemes:
		- http
		- 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 NS Performance Management #
		##################################################################################
		'/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
		description: >
		description: \|
		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.
		parameters:
		- name: VnfPackageOnboardingNotification
		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
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		204:
		description: >
		204 No Content
		"204":
		$ref: '#/components/responses/VnfPackageOnboardingNotification.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

		Shall be returned when the notification has been delivered successfully.
		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:
		description: >
		Version of the API used in the response.
		type: string
		maximum: 1
		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"
		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 API producer to an API consumer.
		The API consumer shall have previously created an "individual subscription resource" with a matching filter.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
		requestBody:
		$ref: '#/components/requestBodies/VnfPackageOnboardingNotificationRequest'
		responses:
		"204":
		$ref: '#/components/responses/VnfPackageOnboardingNotification.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

		/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:
		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.
		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:
		- $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:
		- name: Accept
		description: >
		Content-Types that are acceptable for the response.
		Reference: IETF RFC 7231
		in: header
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
		requestBody:
		$ref: '#/components/requestBodies/VnfPackageChangeNotificationRequest'
		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
		type: string
		- 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

		VnfPackageChangeNotificationRequest:
		description: \|
		A notification about changes of status in a VNF package.
		content:
		application/json:
		schema:
		$ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification
		required: true
		type: string

		responses:
		204:
		description: >
		VnfPackageOnboardingNotification.Get:
		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:
		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:
		description: >
		description: \|
		Version of the API used in the response.
		type: string
		maximum: 1
		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
		style: simple
		explode: false
		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
		- name: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: false
		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
		- name: Content-Type
		description: >
		The MIME type of the body of the request.
		Reference: IETF RFC 7231
		in: header
		required: true
		content: {}

		VnfPackageOnboardingNotification.Post:
		description: \|
		204 No Content
		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
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		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
		responses:
		204:
		description: >
		204 No Content
		content: {}

		VnfPackageChangeNotification.Get:
		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:
		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:
		description: >
		description: \|
		Version of the API used in the response.
		style: simple
		explode: false
		schema:
		type: string
		maximum: 1
		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"
		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
		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
		- name: Authorization
		description: >
		The authorization token for the request.
		Reference: IETF RFC 7235
		in: header
		required: false
		content: {}

		VnfPackageChangeNotification.Post:
		description: \|
		204 No Content
		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
		- name: Version
		description: >
		Version of the API requested to use when responding to this request.
		in: header
		required: true
		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
		responses:
		204:
		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
		content: {}
		No newline at end of file

Admin message