Commit 65d4fab4 authored by bernini's avatar bernini

merge

parents ac73107c 0b9d6e09
......@@ -126,6 +126,60 @@ definitions:
instance information is accessible as a resource.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/NotificationLink"
PerceivedSeverityRequest:
description: >
This type represents the escalated value of the perceived severity for an alarm.
......
......@@ -190,7 +190,7 @@ components:
content:
application/json:
schema:
$ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification
$ref: ../VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmNotification
required: true
AlarmClearedNotification:
......
......@@ -3,7 +3,13 @@ openapi: 3.0.2
info:
title: SOL002 - VNF Indicator interface
description: |
SOL002 - VNF Indicator interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. 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
SOL002 - VNF Indicator interface
IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it
refers to and has not been approved by the ETSI NFV ISG. 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
contact:
name: NFV-SOL WG
license:
......
openapi: 3.0.2
info:
title: SOL002 - VNF Indicator Notification Endpoint interface
title: SOL002 - VNF Indicator Notification interface
description: |
SOL002 - VNF Indicator Notification Endpoint interface IMPORTANT: Please note that this file might be not aligned to
SOL002 - VNF Indicator Notification interface
IMPORTANT: Please note that this file might be not aligned to
the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
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
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
contact:
name: NFV-SOL WG
license:
......
......@@ -1925,7 +1925,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc
IndividualVnfLcmOpOcc.Get:
description: |
......@@ -1956,7 +1956,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc
VnfLcmOpOccRetry.Post:
description: |
......@@ -2031,7 +2031,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc
VnfLcmOpOccCancel.Post:
description: |
......
......@@ -148,7 +148,7 @@ definitions:
operation occurrence and by any of the error handling procedures for that operation occurrence.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedExtLinkPort"
$ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedExtLinkPort"
affectedVirtualStorages:
description: >
Information about virtualised storage instances that were affected
......@@ -170,7 +170,7 @@ definitions:
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"
$ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications"
changedExtConnectivity:
description: >
Information about changed external connectivity, if this
......
......@@ -419,7 +419,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
$ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
IndividualAlarm.Get.200:
description: |
......@@ -451,7 +451,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
$ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm"
IndividualAlarm.Patch.200:
description: |
......
definitions:
Alarm:
description: >
The alarm data type encapsulates information about an alarm.
type: object
required:
- id
- managedObjectId
- alarmRaisedTime
- ackState
- perceivedSeverity
- eventTime
- eventType
- probableCause
- isRootCause
- _links
properties:
id:
description: >
Identifier of this Alarm information element.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
managedObjectId:
description: >
Identifier of the affected VNF instance.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
rootCauseFaultyResource:
description: >
The virtualised resources that are causing the VNF fault.
Shall be present if the alarm affects virtualised resources.
$ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo"
alarmRaisedTime:
description: >
Time stamp indicating when the alarm is raised by the managed
object.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/DateTime"
alarmClearedTime:
description: >
Time stamp indicating when the alarm was cleared. It shall be
present if the alarm has been cleared.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
alarmAcknowledgedTime:
description: >
Time stamp indicating when the alarm was acknowledged.
It shall be present if the alarm has been acknowledged.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType"
eventTime:
description: >
Time stamp indicating when the fault was observed.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
eventType:
description: >
Type of event.
$ref: "../../../definitions/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
"correlatedAlarmIds" are caused by this fault.
type: boolean
correlatedAlarmIds:
description: >
List of identifiers of other alarms correlated to this fault.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/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/SOL002SOL003_def.yaml#/definitions/NotificationLink"
\ No newline at end of file
......@@ -216,7 +216,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
$ref: "../VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
required: true
AlarmClearedNotification:
......
openapi: 3.0.2
info:
title: SOL003 - VNF Indicator interface
title: SOL003 - VNF Indicator Notification interface
description: |
SOL003 - VNF Indicator interface
SOL003 - VNF Indicator 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
......
......@@ -1836,7 +1836,7 @@ components:
type: string
VnfSnapshotInfoId:
name: VnfSnapshotInfoId
name: vnfSnapshotInfoId
in: path
description: |
Identifier of the "Individual VNF snapshot" resource. This identifier can be retrieved
......@@ -2043,7 +2043,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
VNFInstances.Get.200:
description: |
......@@ -2093,7 +2093,7 @@ components:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
IndividualVnfInstance.Get.200:
description: |
......@@ -2126,7 +2126,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
IndividualVnfInstance.Patch.202:
description: |
......@@ -2170,7 +2170,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
IndividualVnfInstance.Delete.204:
description: |
......@@ -2538,7 +2538,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
IndividualVnfLcmOpOcc.Get.200:
description: |
......@@ -2572,7 +2572,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
RollbackVnfLcmOpOcc.Post.202:
description: |
......@@ -2651,7 +2651,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
CancelVnfLcmOpOcc.Post.202:
description: |
......@@ -2929,7 +2929,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
VnfSnapshots.Get.200:
description: |
......@@ -2975,7 +2975,7 @@ components:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
IndividualVnfSnapshot.Get.200:
description: |
......@@ -3011,7 +3011,7 @@ components:
schema:
type: array
items:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
$ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
IndividualVnfSnapshot.Patch.200:
description: |
......
......@@ -209,7 +209,7 @@ components:
content:
application/json:
schema:
$ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification"
$ref: "../VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification"
required: true
VnfIdentifierCreationNotification:
......
......@@ -219,8 +219,8 @@ definitions:
release, it is recommended in the present document that the number
of entries in the "vims" attribute in the Grant is not greater than
1.
type: array
items:
type: object
additionalProperties:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo"
zones:
description: >
......@@ -376,7 +376,7 @@ definitions:
information about externally-managed virtual links.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData"
$ref: "../../VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkData"
additionalParams:
description: >
Additional parameters passed by the NFVO, specific to the VNF and
......
openapi: 3.0.2
info:
title: SSOL003 - VNF Package Management interface
title: SOL003 - VNF Package Management interface
description: |
SOL003 - VNF Package Management interface
......
......@@ -3,9 +3,12 @@ openapi: 3.0.2
info:
title: SOL003 - VNF Snapshot Package Management interface
description: |
SOL002 - VNF Fault Management interface IMPORTANT: Please note that this file might be not aligned to the current
SOL003 - VNF Snapshot Package Management interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG.
In case of discrepancies the published ETSI Group Specification takes precedence.
Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
contact:
name: NFV-SOL WG
......
......@@ -65,181 +65,6 @@ definitions:
URI of this resource.
$ref: "SOL002SOL003_def.yaml#/definitions/Link"
Alarm:
description: >
The alarm data type encapsulates information about an alarm.
type: object
required:
- id
- managedObjectId
- alarmRaisedTime
- ackState
- perceivedSeverity
- eventTime
- eventType
- probableCause
- isRootCause
- _links
properties:
id:
description: >
Identifier of this Alarm information element.
$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
managedObjectId:
description: >
Identifier of the affected VNF instance.
$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
vnfcInstanceIds:
description: >
Identifiers of the affected VNFC instances.
type: array
items:
$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
rootCauseFaultyResource:
description: >
The virtualised resources that are causing the VNF fault.
Shall be present if the alarm affects virtualised resources.
$ref: "#/definitions/FaultyResourceInfo"
alarmRaisedTime:
description: >
Time stamp indicating when the alarm is raised by the managed
object.
$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
alarmChangedTime:
description: >
Time stamp indicating when the alarm was last changed. It shall be
present if the alarm has been updated.
$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
alarmClearedTime:
description: >
Time stamp indicating when the alarm was cleared. It shall be
present if the alarm has been cleared.
$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
alarmAcknowledgedTime:
description: >
Time stamp indicating when the alarm was acknowledged.
It shall be present if the alarm has been acknowledged.
$ref: "SOL002SOL003_def.yaml#/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: "#/definitions/PerceivedSeverityType"
eventTime:
description: >
Time stamp indicating when the fault was observed.
$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
eventType:
description: >
Type of event.
$ref: "#/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
"correlatedAlarmIds" are caused by this fault.
type: boolean
correlatedAlarmIds:
description: >
List of identifiers of other alarms correlated to this fault.
type: array
items:
$ref: "SOL002SOL003_def.yaml#/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: "SOL002SOL003_def.yaml#/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: "SOL002SOL003_def.yaml#/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: "SOL002SOL003_def.yaml#/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: "SOL002SOL003_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date-time of the generation of the notification.
$ref: "SOL002SOL003_def.yaml#/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: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
AlarmClearedNotification:
description: >
This type represents an alarm cleared notification about VNF faults.
......