NFVManoConfigurationAndInformationManagementNotification_def.yaml 6.56 KB
Newer Older
1
definitions:
Giacomo Bernini's avatar
Giacomo Bernini committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  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.
24
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
Giacomo Bernini's avatar
Giacomo Bernini committed
25
26
27
28
29
30
31
32
        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.
33
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
Giacomo Bernini's avatar
Giacomo Bernini committed
34
35
36
        timeStamp:
          description: >
            Date and time of the generation of the notification.
37
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime"
Giacomo Bernini's avatar
Giacomo Bernini committed
38
39
40
        informationChangedTime:
          description: >
            Timestamp indicating when the information was changed.
41
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime"
Giacomo Bernini's avatar
Giacomo Bernini committed
42
43
44
        manoEntityId:
          description: >
            Identifier of the MANO entity of which the information was changed.
45
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
Giacomo Bernini's avatar
Giacomo Bernini committed
46
47
48
49
        changedInfo:
          description: >
            Data about the changed configuration and information of the NFV-MANO
            functional entity.
50
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/KeyValuePairs"
Giacomo Bernini's avatar
Giacomo Bernini committed
51
52
53
54
55
56
57
58
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            self:
              description: >
                Link to the related subscription.
59
              $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink"
Giacomo Bernini's avatar
Giacomo Bernini committed
60
61
62
            subscription:
              description: >
                Link to the related subscription.
63
              $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink"
Giacomo Bernini's avatar
Giacomo Bernini committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
          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.
87
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
Giacomo Bernini's avatar
Giacomo Bernini committed
88
89
90
91
92
93
94
95
        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.
96
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
Giacomo Bernini's avatar
Giacomo Bernini committed
97
98
99
        timestamp:
          description: >
            Date-time of the generation of the notification.
100
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime"
Giacomo Bernini's avatar
Giacomo Bernini committed
101
102
103
104
        changeStateOpOccId:
          description: >
            Identifier of the change state operation occurrence associated to the
            notification.
105
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/Identifier"
Giacomo Bernini's avatar
Giacomo Bernini committed
106
107
108
        stateChangedTime:
          description: >
            Timestamp indicating when the state on the managed object was changed.
109
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/DateTime"
Giacomo Bernini's avatar
Giacomo Bernini committed
110
111
112
        changeStateOperationState:
          description: >
            The state of the "change state operation occurrence".
113
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ChangeStateOpOccStateEnumType"
Giacomo Bernini's avatar
Giacomo Bernini committed
114
115
116
117
        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".
118
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/ManoManagedObjectReference"
Giacomo Bernini's avatar
Giacomo Bernini committed
119
120
121
122
        operationalState:
          description: >
            New operational state of the managed object. Shall only be present when
            there is a change in the operational state.
123
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/OperationalStateEnumType"
Giacomo Bernini's avatar
Giacomo Bernini committed
124
125
126
127
        administrativeState:
          description: >
            New administrative state of the managed object. Shall only be present
            when there is a change in the administrative state.
128
          $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/AdministrativeStateEnumType"
Giacomo Bernini's avatar
Giacomo Bernini committed
129
130
131
132
133
134
135
136
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            subscription:
              description: >
                Link to the related subscription.
137
              $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink"
Giacomo Bernini's avatar
Giacomo Bernini committed
138
139
140
141
142
            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.
143
              $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink"
Giacomo Bernini's avatar
Giacomo Bernini committed
144
145
146
147
            changeStateOpOcc:
              description: >
                Link to the change state operation occurrence that this notification
                is related to.
148
              $ref: "../../definitions/SOL009_def.yaml#/definitions/schemas/NotificationLink"
Giacomo Bernini's avatar
Giacomo Bernini committed
149
150
151
152
          required:
            - subscription
            - objectInstance
            - changeStateOpOcc