NFVManoConfigurationAndInformationManagementNotification.yaml 12.8 KB
Newer Older
1
2
openapi: 3.0.2
info:
Giacomo Bernini's avatar
Giacomo Bernini committed
3
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
4
  title: SOL009 - NFV-MANO Configuration and Information Management Notification Operation
5
  description: >
6
    SOL009 - NFV-MANO Configuration and Information Management Notification Operation
7
8
9
10
11
12
13
14
15
16
17
18

    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
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    name: NFV-SOL WG
externalDocs:
19
20
  description: ETSI GS NFV-SOL 009 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
21
22

servers:
Giacomo Bernini's avatar
Giacomo Bernini committed
23
  - url: http://0.0.0.0/callback/v2
24
25
    description: >
      API HTTP Server
Giacomo Bernini's avatar
Giacomo Bernini committed
26
  - url: https://0.0.0.0/callback/v2
27
28
29
30
    description: >
      API HTTPS Server

paths:
31
  /URI_is_provided_by_the_client_when_creating_the_subscription-ConfigurationAndInformationNotification:
32
33
34
35
36
37
38
    description: >
      This resource represents a notification endpoint. The API producer can use this 
      resource to send notifications related to NFV-MANO configuration and information 
      management to a subscribed API consumer, which has provided the URI of this 
      resource during the subscription process.
    post:
      description: >
39
40
41
        The POST method delivers a notification from the API producer to an API consumer.
        The API consumer shall have previously created an "Individual subscription" resource
        with a matching filter. See clause 5.5.6.3.1.
42
43
44
45
46
      parameters:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      requestBody:
47
        $ref: "#/components/requestBodies/ConfigurationAnfInformationNotification"
48
49
50
51
      responses:
        "204": 
          $ref: "#/components/responses/notification.post.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
52
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
53
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
54
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
55
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
56
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
57
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
58
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
59
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
60
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
61
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
62
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
63
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
64
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
65
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
66
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
67
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
68
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
69
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
70
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
71
72
73
74

    get:
      description: >
        TThe GET method allows the API producer to test the notification endpoint that 
75
        is provided by the API consumer, e.g., during the subscription process. See clause 5.5.6.3.2.
76
77
78
79
80
81
82
83
      parameters:
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
      responses:
        "204": 
          $ref: "#/components/responses/notification.get.204"
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
84
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
85
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
86
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
87
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
88
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
89
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
90
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
91
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
92
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
93
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
94
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
95
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
96
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
97
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
98
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
99
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
100
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
101
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
102
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

components:
  responses:
    notification.post.204:
      description: >
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully.
      headers:
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the corresponding HTTP
            request has provided an invalid authorization token.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

    notification.get.204:
      description: >
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been 
        tested successfully.

        The response body shall be empty.
      headers:
        WWW-Authenticate:
          description: >
            Challenge if the corresponding HTTP request has not provided
            authorization, or error details if the corresponding HTTP
            request has provided an invalid authorization token.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

  requestBodies:
148
    ConfigurationAnfInformationNotification:
149
150
151
152
153
154
155
156
      description: >
        A notification about configuration and information data changes of the 
        NFV-MANO functional entity, or state changes of the NFV-MANO functional 
        entity and its managed objects.
      content:
        application/json:
          schema: 
            oneOf:
157
158
              - $ref: "#/components/schemas/InformationChangedNotification"
              - $ref: "#/components/schemas/ChangeStateNotification"
159
160
      required: true

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
  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".
Giacomo Bernini's avatar
Fix  
Giacomo Bernini committed
262
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/ChangeStateOpOccStateEnumType"
263
264
265
266
267
268
269
270
271
        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.
Giacomo Bernini's avatar
Fix  
Giacomo Bernini committed
272
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/OperationalStateEnumType"
273
274
275
276
        administrativeState:
          description: >
            New administrative state of the managed object. Shall only be present
            when there is a change in the administrative state.
Giacomo Bernini's avatar
Fix  
Giacomo Bernini committed
277
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/AdministrativeStateEnumType"
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
        _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