Commit 6001cd0c authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

Addressed comments from SOL008 Rapporteur for 3.3.1-dev-final-version review

parent e9770cd1
Pipeline #2095 running with stage
......@@ -330,7 +330,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateSubscriptionRequest"
$ref: "#/components/requestBodies/CimSubscriptionRequest"
responses:
"201":
$ref: "#/components/responses/subscriptions.post.201"
......@@ -1116,70 +1116,6 @@ components:
- callbackUri
- _links
InformationChangedNotification:
description: >
This type represents a notification that is sent when data about
configuration and information of the NFV-MANO functional entity
have been changed.
type: object
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: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"InformationChangedNotification" for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
informationChangedTime:
description: >
Timestamp indicating when the information was changed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
manoEntityId:
description: >
Identifier of the MANO entity of which the information was changed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
changedInfo:
description: >
Data about the changed configuration and information of the NFV-MANO
functional entity.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
self:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- self
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
ChangeStateRequest:
description: >
This type represents request parameters for changing the state of a managed entity.
......@@ -1300,94 +1236,6 @@ components:
- startTime
- managedObjectRef
ChangeStateNotification:
description: >
This type represents a Change state operation occurrence.
type: object
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: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ChangeStateNotification" for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timestamp:
description: >
Date-time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
changeStateOpOccId:
description: >
Identifier of the change state operation occurrence associated to the
notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
stateChangedTime:
description: >
Timestamp indicating when the state on the managed object was changed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
changeStateOperationState:
description: >
The state of the "change state operation occurrence".
$ref: "#/components/schemas/ChangeStateOpOccStateEnumType"
managedObjectRef:
description: >
Reference of the managed object to which the state change notification relates.
The value of the "type" attribute shall be "MANO_ENTITY" or "MANO_SERVICE_IF".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
operationalState:
description: >
New operational state of the managed object. Shall only be present when
there is a change in the operational state.
$ref: "#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
New administrative state of the managed object. Shall only be present
when there is a change in the administrative state.
$ref: "#/components/schemas/AdministrativeStateEnumType"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
objectInstance:
description: >
Link to the resource representing the object to which the change
state applies. Shall be present if the object instance is accessible
as a resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
changeStateOpOcc:
description: >
Link to the change state operation occurrence that this notification
is related to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- subscription
- objectInstance
- changeStateOpOcc
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
ManoServiceInterface:
description: >
This type represents an individual NFV-MANO service interface produced by
......@@ -2877,8 +2725,8 @@ components:
schema:
$ref: "#/components/schemas/ChangeStateRequest"
required: true
CreateSubscriptionRequest:
CimSubscriptionRequest:
description: >
Details of the subscription to be created, as defined in
clause 5.6.2.5-1.
......
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Configuration and Information Management Notification Interface
title: SOL009 - NFV-MANO Configuration and Information Management Notification Operation
description: >
SOL009 - NFV-MANO Configuration and Information Management Notification Interface
SOL009 - NFV-MANO Configuration and Information Management Notification Operation
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
......@@ -44,7 +44,7 @@ paths:
- $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
- $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
requestBody:
$ref: "#/components/requestBodies/CreateConfigurationAnfInformationNotificationRequest"
$ref: "#/components/requestBodies/ConfigurationAnfInformationNotification"
responses:
"204":
$ref: "#/components/responses/notification.post.204"
......@@ -145,7 +145,7 @@ components:
type: string
requestBodies:
CreateConfigurationAnfInformationNotificationRequest:
ConfigurationAnfInformationNotification:
description: >
A notification about configuration and information data changes of the
NFV-MANO functional entity, or state changes of the NFV-MANO functional
......@@ -154,8 +154,158 @@ components:
application/json:
schema:
oneOf:
- $ref: "../NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml#/components/schemas/InformationChangedNotification"
- $ref: "../NFVManoConfigurationAndInformationManagement/NFVManoConfigurationAndInformationManagement.yaml#/components/schemas/ChangeStateNotification"
- $ref: "#/components/schemas/InformationChangedNotification"
- $ref: "#/components/schemas/ChangeStateNotification"
required: true
schemas:
InformationChangedNotification:
description: >
This type represents a notification that is sent when data about
configuration and information of the NFV-MANO functional entity
have been changed.
type: object
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: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"InformationChangedNotification" for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
informationChangedTime:
description: >
Timestamp indicating when the information was changed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
manoEntityId:
description: >
Identifier of the MANO entity of which the information was changed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
changedInfo:
description: >
Data about the changed configuration and information of the NFV-MANO
functional entity.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
self:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- self
required:
- id
- notificationType
- subscriptionId
- timeStamp
- informationChangedTime
- manoEntityId
- changedInfo
- _links
ChangeStateNotification:
description: >
This type represents a Change state operation occurrence.
type: object
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: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ChangeStateNotification" for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timestamp:
description: >
Date-time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
changeStateOpOccId:
description: >
Identifier of the change state operation occurrence associated to the
notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
stateChangedTime:
description: >
Timestamp indicating when the state on the managed object was changed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
changeStateOperationState:
description: >
The state of the "change state operation occurrence".
$ref: "#/components/schemas/ChangeStateOpOccStateEnumType"
managedObjectRef:
description: >
Reference of the managed object to which the state change notification relates.
The value of the "type" attribute shall be "MANO_ENTITY" or "MANO_SERVICE_IF".
$ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
operationalState:
description: >
New operational state of the managed object. Shall only be present when
there is a change in the operational state.
$ref: "#/components/schemas/OperationalStateEnumType"
administrativeState:
description: >
New administrative state of the managed object. Shall only be present
when there is a change in the administrative state.
$ref: "#/components/schemas/AdministrativeStateEnumType"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
objectInstance:
description: >
Link to the resource representing the object to which the change
state applies. Shall be present if the object instance is accessible
as a resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
changeStateOpOcc:
description: >
Link to the change state operation occurrence that this notification
is related to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- subscription
- objectInstance
- changeStateOpOcc
required:
- id
- notificationType
- subscriptionId
- timestamp
- changeStateOpOccId
- stateChangedTime
- changeStateOperationState
- managedObjectRef
- _links
\ No newline at end of file
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Fault Management Notification interface
title: SOL009 - NFV-MANO Fault Management Notification Operation
description: >
SOL009 - NFV-MANO Fault Management Notification interface
SOL009 - NFV-MANO Fault Management Notification Operation
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.
......
openapi: 3.0.2
info:
version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
title: SOL009 - NFV-MANO Log Management Notification interface
title: SOL009 - NFV-MANO Log Management Notification Operation
description: >
SOL009 - NFV-MANO Log Management Notification interface
SOL009 - NFV-MANO Log Management Notification Operation
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.
......
......@@ -532,196 +532,6 @@ components:
- id
- callbackUri
ThresholdCrossedNotification:
description: >
This type represents a notification that is sent when a threshold has been crossed.
NOTE: The timing of sending this notification is determined by the capability of
the producing entity to evaluate the threshold crossing condition.
The notification shall be triggered by the NFV-MANO functional entity when
a threshold has been crossed.
type: object
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: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types. Shall be set to
"ThresholdCrossedNotification" for this notification type.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
thresholdId:
description: >
Identifier of the threshold which has been crossed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
crossingDirection:
description: >
An indication of whether the threshold was crossed in upward or downward direction.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/CrossingDirectionType"
objectType:
description: >
Type of measured object.The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
objectInstanceId:
description: >
Identifier of the measured object instance. This attribute shall contain the
identifier of the instance of the measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subObjectInstanceId:
description: >
Identifier of the sub-object of the measured object to which the measurement
applies. Shall be present if this is required in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type. Shall be absent otherwise.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
performanceMetric:
description: >
Performance metric associated with the threshold.
This attribute shall contain the related "Measurement Name" value as defined
in clause 8.4 of ETSI GS NFV-IFA 031
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
performanceValue:
description: >
Value of the metric that resulted in threshold crossing.
The type of this attribute shall correspond to the related "Measurement Unit"
as defined in clause 8.4 of ETSI GS NFV-IFA 031.
context:
description: >-
Measurement context information related to the measured value. The set of applicable keys is defined per
measurement in clause 8.4 of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
objectInstance:
description: >
Link to the resource representing the measured object instance to which
the notified change applies. Shall be present if the measured object
instance information is accessible as a resource.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
threshold:
description: >
Link to the resource that represents the threshold that was crossed.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
required:
- subscription
- objectInstance
required:
- id
- notificationType
- subscriptionId
- timeStamp
- thresholdId
- crossingDirection
- objectType
- objectInstanceId
- performanceMetric
- performanceValue
- _links
PerformanceInformationAvailableNotification:
description: >
This notification informs the receiver that performance information is available.
type: object
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: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
notificationType:
description: >
Discriminator for the different notification types.
Shall be set to "PerformanceInformationAvailableNotification" for this
notification type.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/DateTime"
objectType:
description: >
Type of measured object.
The applicable measured object type for a measurement is defined in clause 8.2
of ETSI GS NFV-IFA 031.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/String"
objectInstanceId:
description: >
Type of measured object.
The applicable measured object type for a measurement is defined in clause 8.2
of ETSI GS NFV-IFA 031
$ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subObjectInstanceId:
description: >
Identifier of the sub-object of the measured object instance for which the
measurements have been taken. Shall be present if the related PM job has been
set up to measure a sub-object instance of the measured object instance and a
sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031 for the related
measured object type. Shall be absent otherwise.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
_links:
description: >
Links to resources related to this notification.
type: object
properties:
subscription:
description: >
Link to the related subscription.
$ref: "../components/SOL009_schemas.yaml#/components/schemas/NotificationLink"
objectInstance: