PolicyManagementNotification.yaml 13.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
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
148
149
150
151
152
153
154
155
156
157
158
159
160
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  title: SOL012 - Policy Management Notification Interface
  description: >
    SOL012 - Policy Management 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 discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
  description: ETSI GS NFV-SOL 012 V3.3.1
  url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL012ed331_Protocol_Spec_for_Policy_Mgmt_Intface/NFV-SOL012ed331v010.zip

security:
  - OauthSecurity:
      - all
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1

paths:
  /URI_is_provided_by_the_API_consumer_when_creating_the_subscription_PolicyManagementNotification::
    description: >-
      TThis resource represents a notification endpoint for policy management. 
      The API producer can use this resource to send notifications related to policy management events to 
      a subscribed API consumer, which has provided the URI of this resource during the subscription process.
    parameters:
      - $ref: "../components/SOL012_params.yaml#/components/parameters/Version"
      - $ref: "../components/SOL012_params.yaml#/components/parameters/Accept"
      - $ref: "../components/SOL012_params.yaml#/components/parameters/Authorization"
    post:
      description: >-
        The POST method delivers a notification regarding a policy management event from the API producer 
        to an API consumer. The API consumer shall have previously created an "Individual subscription" 
        resource with a matching filter.
        This method shall follow the provisions specified in the tables 5.5.9.3.1-1 and 5.5.9.3.1-2 for 
        URI query parameters, request and response data structures, and response codes.
        Each notification request body shall include exactly one of the alternatives defined 
        in table 5.5.9.3.1-2.
      parameters:
        - $ref: "../components/SOL012_params.yaml#/components/parameters/ContentType"
      requestBody:
        $ref: "#/components/requestBodies/NotificationCreateRequest"
      responses:
        "204":
          $ref: '#/components/responses/Notification.post.204'
        "400":
          $ref: ../components/SOL012_resp.yaml#/components/responses/400
        "401":
          $ref: ../components/SOL012_resp.yaml#/components/responses/401
        "403":
          $ref: ../components/SOL012_resp.yaml#/components/responses/403
        "405":
          $ref: ../components/SOL012_resp.yaml#/components/responses/405
        "406":
          $ref: ../components/SOL012_resp.yaml#/components/responses/406
        "500":
          $ref: ../components/SOL012_resp.yaml#/components/responses/500
        "503":
          $ref: ../components/SOL012_resp.yaml#/components/responses/503
    get:
      description: >-
        The GET method allows the API producer to test the notification endpoint that is provided by the 
        API consumer, e.g. during subscription.
        This method shall follow the provisions specified in the tables 5.5.9.3.2-1 and 5.5.9.3.2-2 for 
        URI query parameters, request and response data structures, and response codes.
      responses:
        "204":
          $ref: '#/components/responses/Notification.get.204'
        "400":
          $ref: ../components/SOL012_resp.yaml#/components/responses/400
        "401":
          $ref: ../components/SOL012_resp.yaml#/components/responses/401
        "403":
          $ref: ../components/SOL012_resp.yaml#/components/responses/403
        "405":
          $ref: ../components/SOL012_resp.yaml#/components/responses/405
        "406":
          $ref: ../components/SOL012_resp.yaml#/components/responses/406
        "500":
          $ref: ../components/SOL012_resp.yaml#/components/responses/500
        "503":
          $ref: ../components/SOL012_resp.yaml#/components/responses/503

components:
  schemas:
    PolicyChangeNotification:
      description: >
        This type represents a notification about policy change. It shall comply with the provisions 
        defined in table 5.6.2.7-1.
        This notification shall be triggered by the API producer when a policy has been changed as 
        the result of an operation of creating, transferring, deleting or modifying a policy.
      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/SOL012_schemas.yaml#/components/schemas/Identifier"
        notificationType:
          description: >
            Discriminator for the different notification types. Shall be set to "PolicyChangeNotification" 
            for this notification type.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/String"
        subscriptionId:
          description: >
            Identifier of the subscription that this notification relates to.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/Identifier"
        timeStamp:
          description: >
            Date and time of the generation of the notification.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/DateTime"
        policyId:
          description: >
            Identifier of the policy.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/Identifier"
        affectedVersion:
          description: >
            Affected version of the policy. 
            The value is the version identifier in the URI when a particular version of the policy 
            is transferred or deleted, or the selected version of the policy when the policy is 
            activated/deactivated/modified.
            Shall be present when a particular version of the policy is impacted by the policy 
            management operation.
            Shall be absent otherwise.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/Version"
        previousSelectedVersion:
          description: >
            The previous selected version of the policy.
            Shall be present when another version of the policy has been selected.
            Shall be absent otherwise.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/Version"
        policyModifications:
          description: >
            Information about the modifications of the policy. Shall be present when the changeType 
            equals to "MODIFY_POLICY". Shall be absent otherwise.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/PolicyModifications"
        changeType:
          description: >
            Policy management operation that cause the change of the policy.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/PolicyOperationType"
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            subscription:
              description: >
                Link to the related subscription.
              $ref: "../components/SOL012_schemas.yaml#/components/schemas/NotificationLink"
            objectInstance:
              description: >
                Link to the resource representing the policies to which the notified change applies. 
                Shall be present if the policy is accessible as a resource.
              $ref: "../components/SOL012_schemas.yaml#/components/schemas/NotificationLink"
          required:
            - subscription
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - policyId
        - changeType
        - _links

    PolicyConflictNotification:
      description: >
        This type represents a notification about policy conflict. It shall comply with the provisions 
        defined in table 5.6.2.8-1.
        This notification shall be triggered by the API producer when a policy conflict is detected, 
        and any of the policies specified in an associated notification subscription is impacted 
        by the conflict.
      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/SOL012_schemas.yaml#/components/schemas/Identifier"
        notificationType:
          description: >
            Discriminator for the different notification types. Shall be set to "PolicyConflictNotification" 
            for this notification type.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/String"
        subscriptionId:
          description: >
            Identifier of the subscription that this notification relates to.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/Identifier"
        timeStamp:
          description: >
            Date and time of the generation of the notification.
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/DateTime"
        policyIds:
          description: >
            Identifiers of the conflicting policies. 
            The policy identifier and the corresponding selected version are mapped by the order 
            in the array.
          type: array
          items:
            $ref: "../components/SOL012_schemas.yaml#/components/schemas/Identifier"
          minItems: 2
        selectedVersions:
          description: >
            Selected versions of the conflicting policies. 
            The policy identifier and the corresponding selected version are mapped by the order 
            in the array.
          type: array
          items:
            $ref: "../components/SOL012_schemas.yaml#/components/schemas/Version"
          minItems: 2
        conflictDescription:
          description: >
            Description of the detected policy conflicts, e.g. conflicting events, conditions 
            or actions among the policies
          $ref: "../components/SOL012_schemas.yaml#/components/schemas/String"
        _links:
          description: >
            Links to resources related to this notification.
          type: object
          properties:
            subscription:
              description: >
                Link to the related subscription.
              $ref: "../components/SOL012_schemas.yaml#/components/schemas/NotificationLink"
            objectInstances:
              description: >
                Link to the resources representing the policies to which the notified conflict applies.
              type: array
              items:
                $ref: "../components/SOL012_schemas.yaml#/components/schemas/NotificationLink"
              minItems: 2
          required:
            - subscription
            - objectInstances
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - policyIds
        - selectedVersions
        - conflictDescription
        - _links
      
  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:
    NotificationCreateRequest:
      description: >
        This type represents request parameters for creating a notification.
        Each notification request body shall include exactly one of the alternatives defined in table 5.5.9.3.1-2.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: "#/components/schemas/PolicyChangeNotification"
              - $ref: "#/components/schemas/PolicyConflictNotification"
      required: true