NSPerformanceManagementNotification.yaml 11.7 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
6
7
8
9
10
  title: "SOL005 - NS Performance Management Notification interface"
  description: >
    SOL005 - NS Performance 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.
11
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
12
13
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

externalDocs:
17
18
  description: ETSI GS NFV-SOL 005 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
19

20
basePath: /callback/v2
21
22
23
24
25
26
27

schemes:
  - http
  - https

consumes:
  - application/json
moscatelli's avatar
moscatelli committed
28

29
30
produces:
  - application/json
moscatelli's avatar
moscatelli committed
31

32
33
paths:
  ##################################################################################
34
  # Notification endpoint PerformanceInformationAvailableNotification              #
35
  ##################################################################################
36
  '/URI_is_provided_by_the_client_when_creating_the_subscription_PerformanceInformationAvailableNotificatio':
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string

    post:
      summary: Notify about PM related events
      description: >
55
56
        The POST method delivers a notification regarding a performance management event 
        from the API producer to an API consumer. The API consumer shall have previously 
57
        created an "Individual PM job resource" or "Individual threshold resource".
58
        This method shall follow the provisions specified in the
59
60
        Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, request and response
        data strctures, and response codes.
61
62
63
64
65
      parameters:
        - name: PerformanceInformationAvailableNotification
          description: >
            Notification about performance information availability.
          in: body
66
          required: true
67
68
          schema:
            $ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/PerformanceInformationAvailableNotification"
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

88
            Shall be returned when the notification was delivered successfully.
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
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

    get:
      summary: Test the notification endpoint
      description: >
124
125
126
        The GET method allows the API producer to test the notification
        endpoint that is provided by the API consumer, e.g. during
        creation of the PM job or threshold resource.
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
        This method shall follow the provisions specified in the
        Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

143
144
            Shall be returned to indicate that the notification endpoint has been 
            tested successfully.
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
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ##################################################################################
  # Notification endpoint ThresholdCrossedNotification                             #
  ##################################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription_ThresholdCrossedNotification':
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string

    post:
      summary: Notify about PM related events
      description: >
200
201
        The POST method delivers a notification regarding a performance management event 
        from the API producer to an API consumer. The API consumer shall have previously 
202
        created an "Individual PM job resource" or "Individual threshold resource".
203
        This method shall follow the provisions specified in the
204
205
        Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, request and response
        data strctures, and response codes.
206
      parameters:
207
208
209
210
        - name: ThresholdCrossedNotification
          description: >
            Notification about threshold crossing.
          in: body
211
          required: true
212
213
214
215
216
217
218
219
220
221
222
223
          schema:
            $ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/ThresholdCrossedNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
moscatelli's avatar
moscatelli committed
224
            Reference: IETF RFC 7231
225
226
227
228
229
230
231
232
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 NO CONTENT

233
            Shall be returned when the notification was delivered successfully.
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
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

    get:
      summary: Test the notification endpoint
      description: >
269
270
271
        The GET method allows the API producer to test the notification
        endpoint that is provided by the API consumer, e.g. during
        creation of the PM job or threshold resource.
272
273
274
275
276
277
278
279
280
281
282
283
284
285
        This method shall follow the provisions specified in the
        Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
moscatelli's avatar
moscatelli committed
286
            204 NO CONTENT
287

288
289
            Shall be returned to indicate that the notification endpoint has been 
            tested successfully.
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"