Commit 1c278fb7 authored by moscatelli's avatar moscatelli

SOL002/SOL003: OpenAPI version updated to 1.1.0 + Notification interfaces added

parent 08b71bd0
Pipeline #762 passed with stage
in 0 seconds
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL002 - VNF Configuration interface
description: >
VNF Configuration interface of ETSI NFV SOL002
......
swagger: "2.0"
info:
version: "1.1.1"
title: DRAFT - SOL002 - VNF Fault Management interface
version: "1.1.0"
title: SOL002 - VNF Fault Management interface
description: >
DRAFT VNF Fault Management interface of ETSI NFV SOL002
......@@ -589,5 +589,4 @@ paths:
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
\ No newline at end of file
......@@ -2,8 +2,8 @@
swagger: "2.0"
info:
version: "1.1.1"
title: DRAFT - SOL002 - VNF Indicator interface
version: "1.1.0"
title: SOL002 - VNF Indicator interface
description: >
DRAFT VNF Indicator interface of ETSI NFV SOL002.
......@@ -480,6 +480,4 @@ paths:
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
\ No newline at end of file
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: "SOL002 - VNF Indicator Notification Endpoint interface"
description: >
VNF Indicator Notification Endpoint interface of ETSI NFV SOL002
......@@ -92,8 +92,4 @@ paths:
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
\ No newline at end of file
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: "SOL002 - VNF Configuration interface"
description: >
VNF Configuration interface of ETSI NFV SOL002
......@@ -1293,4 +1293,4 @@ paths:
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
\ No newline at end of file
# 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"
swagger: "2.0"
info:
version: "1.1.1"
title: "DRAFT - SOL002 - VNF Performance Management interface"
version: "1.1.0"
title: "SOL002 - VNF Performance Management interface"
description: >
DRAFT - SOL002 - VNF Performance Management interface
......@@ -831,4 +831,4 @@ paths:
500:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
503:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
\ No newline at end of file
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Fault Management interface
description: >
SOL003 - VNF Fault Management interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Fault Management Notification interface
description: >
SOL003 - VNF Fault Management Notification interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Indicator interface
description: >
SOL003 - VNF Indicator interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Indicator Notification interface
description: >
SOL003 - VNF Indicator Notification interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Lifecycle Management interface
description: >
SOL003 - VNF Lifecycle Management interface definition
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Lifecycle Management Notification interface
description: >
SOL003 - VNF Lifecycle Management Notification interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Lifecycle Operation Granting interface
description: >
SOL003 - VNF Lifecycle Operation Granting interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Package Management interface
description: >
SOL003 - VNF Package Management interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Package Management Notification interface
description: >
SOL003 - VNF Package Management Notification interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Performance Management interface
description: >
SOL003 - VNF Performance Management interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - VNF Performance Management Notification interface
description: >
SOL003 - VNF Performance Management Notification interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - Virtualised Resources Quota Available Notification interface
description: >
SOL003 - Virtualised Resources Quota Available Notification interface
......
swagger: "2.0"
info:
version: "1.1.1"
version: "1.1.0"
title: SOL003 - Virtualised Resources Quota Available Notification Notification interface
description: >
SOL003 - Virtualised Resources Quota Available Notification Notification interface
......
......@@ -805,4 +805,168 @@ definitions:
alternative should be chosen.
type: array
items:
type: string
type: string
Alarm:
description: >
The alarm data type encapsulates information about an alarm.
type: object
required:
- id
- managedObjectId
- rootCauseFaultyResource
- alarmRaisedTime
- ackState
- perceivedSeverity
- eventTime
- eventType
- probableCause
- isRootCause
- _links
properties:
id:
description: >
Identifier of this Alarm information element.
$ref: "#/definitions/Identifier"
managedObjectId:
description: >
Identifier of the affected VNF instance.
$ref: "#/definitions/Identifier"
rootCauseFaultyResource:
description: >
The virtualised resources that are causing the VNF fault.
$ref: "SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo"
alarmRaisedTime:
description: >
Time stamp indicating when the alarm is raised by the managed
object.
$ref: "#/definitions/DateTime"
alarmChangedTime:
description: >
Time stamp indicating when the alarm was last changed. It shall be
present if the alarm has been updated.
$ref: "#/definitions/DateTime"
alarmClearedTime:
description: >
Time stamp indicating when the alarm was cleared. It shall be
present if the alarm has been cleared.
$ref: "#/definitions/DateTime"
ackState:
description: >
Acknowledgement state of the alarm.
Permitted values:
* UNACKNOWLEDGED
* ACKNOWLEDGED.
type: string
enum:
- UNACKNOWLEDGED
- ACKNOWLEDGED
perceivedSeverity:
description: >
Perceived severity of the managed object failure.
$ref: "SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
eventTime:
description: >
Time stamp indicating when the fault was observed.
$ref: "#/definitions/DateTime"
eventType:
description: >
Type of event.
$ref: "SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType"
faultType:
description: >
Additional information to clarify the type of the fault.
type: string
probableCause:
description: >
Information about the probable cause of the fault.
type: string
isRootCause:
description: >
Attribute indicating if this fault is the root for other correlated
alarms. If TRUE, then the alarms listed in the attribute
CorrelatedAlarmId are caused by this fault.
type: boolean
correlatedAlarmIds:
description: >
List of identifiers of other alarms correlated to this fault.
type: array
items:
$ref: "#/definitions/Identifier"
faultDetails:
description: >
Provides additional information about the fault.
type: array
items:
type: string
_links:
description: >
Links for this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "#/definitions/Link"
objectInstance:
description: >
Link to the resource representing the VNF instance to which the
notified alarm is correlated. Shall be present if the VNF
instance information is accessible as a resource.
$ref: "#/definitions/Link"
AlarmNotification:
description: >
This type represents an alarm notification about VNF faults.
This notification shall be triggered by the VNFM when:
* An alarm has been created.
* An alarm has been updated, e.g. if the severity of the alarm has
changed.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- alarm
- _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/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"AlarmNotification" for this notification type.
type: string
enum:
- AlarmNotification
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "#/definitions/DateTime"
alarm:
description: >
Information about an alarm including AlarmId, affected VNF
identifier, and FaultDetails.
$ref: "#/definitions/Alarm"
_links:
description: >
Links to resources related to this notification.
type: object
required:
- subscription
properties:
subscription:
description: >
Link to the related subscription.
$ref: "#/definitions/Link"
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment