NFVManoConfigurationAndInformationManagementNotification_def.yaml 6.6 KB
Newer Older
Giacomo Bernini's avatar
Giacomo Bernini committed
components:
  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
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - informationChangedTime
        - manoEntityId
        - changedInfo
        - _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: "../../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

    ChangeStateNotification:
      description: >
        This type represents a Change state operation occurrence.
      type: object
      required:
        - id
        - notificationType
        - subscriptionId
        - timestamp
        - changeStateOpOccId
        - stateChangedTime
        - changeStateOperationState
        - managedObjectRef
        - _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: "../../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/SOL009_schemas.yaml#/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/SOL009_schemas.yaml#/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/SOL009_schemas.yaml#/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