added notification endpoints for SOL002 FM, PM, LCM (ad8ea6b0) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

0 → 100644

+431 −0

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

			info:
			version: "1.2.0"
			title: SOL002 - VNF Fault Management Notification interface
			description: >
			SOL002 - VNF Fault 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.


			In clause 4.3.2 of ETSI GS NFV-SOL 002 v2.4.1, an attribute-based
			filtering mechanism is defined. This mechanism is currently not
			included in the corresponding OpenAPI design for this GS version. Changes
			to the attribute-based filtering mechanism are being considered in v2.5.1
			of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
			design.

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

			externalDocs:
			description: ETSI GS NFV-SOL 002 V2.4.1
			url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf

			basePath: "/callback/v1"

			schemes:
			- https

			consumes:
			- "application/json"
			produces:
			- "application/json"

			paths:
			###############################################################################
			# Notification endpoint AlarmNotification #
			###############################################################################
			'/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification':
			post:
			description: >
			Notify


			The POST method notifies a VNF alarm or that the alarm list has been
			rebuilt.
			parameters:
			- name: AlarmNotification
			description: >
			Information of a VNF alarm.
			in: body
			required: true
			schema:
			$ref: "../definitions/SOL003_def.yaml#/definitions/AlarmNotification"
			- name: Authorization
			description: >
			The authorization token for the request.
			Reference: IETF RFC 7235
			in: header
			required: false
			type: string
			- name: Content-Type
			description: >
			The Content-Type header shall be set to
			"application/merge-patch+json" according to
			IETF RFC 7396.
			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:
			204:
			description: >
			No Content

			The notification was 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
			400:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
			401:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
			403:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			405:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
			406:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			500:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
			503:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			get:
			description: >
			The GET method allows the server to test the notification endpoint
			that is provided by the client, e.g. during subscription.
			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
			responses:
			204:
			description: >
			No Content

			The notification endpoint was 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.
			type: string
			maximum: 1
			minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
			400:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
			401:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
			403:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			405:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
			406:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			500:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
			503:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			###############################################################################
			# Notification endpoint AlarmClearedNotification #
			###############################################################################
			'/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification':
			post:
			description: >
			Notify


			The POST method notifies a VNF alarm or that the alarm list has been
			rebuilt.
			parameters:
			- name: AlarmClearedNotification
			description: >
			Information of the clearance of a VNF alarm
			in: body
			required: true
			schema:
			$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
			- name: Authorization
			description: >
			The authorization token for the request.
			Reference: IETF RFC 7235
			in: header
			required: false
			type: string
			- name: Content-Type
			description: >
			The Content-Type header shall be set to
			"application/merge-patch+json" according to
			IETF RFC 7396.
			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:
			204:
			description: >
			No Content

			The notification was 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
			400:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
			401:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
			403:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			405:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
			406:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			500:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
			503:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			get:
			description: >
			The GET method allows the server to test the notification endpoint
			that is provided by the client, e.g. during subscription.
			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
			responses:
			204:
			description: >
			No Content

			The notification endpoint was 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.
			type: string
			maximum: 1
			minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
			400:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
			401:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
			403:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			405:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
			406:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			500:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
			503:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			###############################################################################
			# Notification endpoint AlarmListRebuiltNotification #
			###############################################################################
			'/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification':
			post:
			description: >
			Notify


			The POST method notifies a VNF alarm or that the alarm list has been
			rebuilt.
			parameters:
			- name: AlarmListRebuiltNotification
			description: >
			Information that the alarm list has been rebuilt by the VNFM
			in: body
			required: true
			schema:
			$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
			- name: Authorization
			description: >
			The authorization token for the request.
			Reference: IETF RFC 7235
			in: header
			required: false
			type: string
			- name: Content-Type
			description: >
			The Content-Type header shall be set to
			"application/merge-patch+json" according to
			IETF RFC 7396.
			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:
			204:
			description: >
			No Content

			The notification was 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
			400:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
			401:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
			403:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			405:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
			406:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			500:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
			503:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
			get:
			description: >
			The GET method allows the server to test the notification endpoint
			that is provided by the client, e.g. during subscription.
			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
			responses:
			204:
			description: >
			No Content

			The notification endpoint was 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.
			type: string
			maximum: 1
			minimum: 0
			Version:
			description: >
			Version of the API used in the response.
			type: string
			maximum: 1
			minimum: 1
			400:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
			401:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
			403:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
			405:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
			406:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
			500:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
			503:
			$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"

src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml

0 → 100644

+267 −0

File added.

Preview size limit exceeded, changes collapsed.

src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml

0 → 100644

+177 −0

Original line number	Original line	Diff line number	Diff line
			# Copyright (c) ETSI 2017.
			# https://forge.etsi.org/etsi-forge-copyright-notice.txt

			definitions:
			VnfLcmOperationOccurrenceNotification:
			description: >
			This type represents a VNF lifecycle management operation occurrence
			notification, which informs the receiver of changes in the VNF
			lifecycle caused by a VNF LCM operation occurrence. The support of the
			notification is mandatory.
			This notification shall be triggered by the VNFM when there is a change
			in the VNF lifecycle caused by a VNF LCM operation occurrence,
			including:
			* Instantiation of the VNF
			* Scaling of the VNF instance (including auto-scaling)
			* Healing of the VNF instance (including auto-healing)
			* Change of the state of the VNF instance (i.e. Operate VNF)
			* Change of the deployment flavour of the VNF instance
			* Change of the external connectivity of the VNF instance
			* Termination of the VNF instance
			* Modification of VNF instance information and/or VNF configurable
			properties through the "PATCH" method on the "Individual VNF instance"
			resource.
			If this is the initial notification about the start of a VNF LCM
			operation occurrence, it is assumed that the notification is sent by the
			VNFM before any action (including sending the grant request) is taken as
			part of the LCM operation. Due to possible race conditions, the "start"
			notification, the grant request and the LCM operation acknowledgment can
			arrive in any order at the NFVO, and the NFVO shall be able to handle
			such a situation.
			If this is a notification about a final or intermediate result state of
			a VNF LCM operation occurrence, the notification shall be sent after
			all related actions of the LCM operation that led to this state have
			been executed. The new state shall be set in the VnfLcmOpOcc resource
			before the notification about the state change is sent.
			type: object
			required:
			- id
			- notificationType
			- subscriptionId
			- timeStamp
			- notificationStatus
			- operationState
			- vnfInstanceId
			- operation
			- isAutomaticInvocation
			- vnfLcmOpOccId
			- _links
			properties:
			id:
			description: >
			Identifier of this notification. If a notification is sent multiple
			times due to multiple subscriptions, the "id" attribute of all these
			notifications shall have the same value.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
			notificationType:
			description: >
			Discriminator for the different notification types. Shall be set to
			"VnfLcmOperationOccurrenceNotification" for this notification type.
			type: string
			enum:
			- VnfLcmOperationOccurrenceNotification
			subscriptionId:
			description: >
			Identifier of the subscription that this notification relates to.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
			timeStamp:
			description: >
			Date-time of the generation of the notification.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
			notificationStatus:
			description: >
			Indicates whether this notification reports about the start of a
			lifecycle operation or the result of a lifecycle operation.
			Permitted values:
			* START: Informs about the start of the VNF LCM operation
			occurrence.
			* RESULT: Informs about the final or intermediate result of the VNF
			LCM operation occurrence.
			type: string
			enum:
			- START
			- RESULT
			operationState:
			description: >
			The state of the VNF LCM operation occurrence.
			$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType"
			vnfInstanceId:
			description: >
			The identifier of the VNF instance affected.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
			operation:
			description: >
			The lifecycle management operation.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType"
			isAutomaticInvocation:
			description: >
			Set to true if this VNF LCM operation occurrence has been triggered
			by an automated procedure inside the VNFM
			(i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf
			triggered by auto-heal).
			Set to false otherwise.
			type: boolean
			vnfLcmOpOccId:
			description: >
			The identifier of the VNF lifecycle management operation occurrence
			associated to the notification.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
			affectedVnfcs:
			description: >
			Information about VNFC instances that were affected during the
			lifecycle operation.
			Shall be present if the "notificationStatus" is set to "RESULT" and
			the operation has performed any resource modification. Shall be
			absent otherwise. This attribute contains information about the
			cumulative changes to virtualised resources that were performed so
			far by the VNF LCM operation occurrence and by any of the error
			handling procedures for that operation occurrence.
			type: array
			items:
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/AffectedVnfc"
			affectedVirtualLinks:
			description: >
			Information about VL instances that were affected during the
			lifecycle operation.
			Shall be present if the "notificationStatus" is set to "RESULT" and
			the operation has performed any resource modification. Shall be
			absent otherwise. This attribute contains information about the
			cumulative changes to virtualised resources that were performed so
			far by the VNF LCM operation occurrence and by any of the error
			handling procedures for that operation occurrence.
			type: array
			items:
			$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualLink"
			affectedVirtualStorages:
			description: >
			Information about virtualised storage instances that were affected
			during the lifecycle operation.
			Shall be present if the "notificationStatus" is set to "RESULT" and
			the operation has performed any resource modification. Shall be
			absent otherwise. This attribute contains information about the
			cumulative changes to virtualised resources that were performed so
			far by the VNF LCM operation occurrence and by any of the error
			handling procedures for that operation occurrence.
			type: array
			items:
			$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualStorage"
			changedInfo:
			description: >
			Information about the changed VNF instance information, including
			changed VNF configurable properties.
			Shall be present if the "notificationStatus" is set to "RESULT" and
			the operation has performed any changes to VNF instance information,
			including VNF configurable properties.
			Shall be absent otherwise.
			$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications"
			changedExtConnectivity:
			description: >
			Information about changed external connectivity, if this
			notification represents the result of a lifecycle operation
			occurrence. Shall be present if the "notificationStatus" is set to
			"RESULT" and the "operation" is set to "CHANGE_EXT_CONN".
			Shall be absent otherwise.
			type: array
			items:
			$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo"
			error:
			description: >
			Details of the latest error, if one has occurred during executing
			the LCM operation. Shall be present if the "operationState"
			attribute is "FAILED_TEMP" or "FAILED", and shall be absent
			otherwise.
			$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
			_links:
			description: >
			Links to resources related to this notification.
			$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks"

src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml

0 → 100644

+295 −0

File added.

Preview size limit exceeded, changes collapsed.

Admin message