VNFPerformanceManagementNotification.yaml 11.4 KB
Newer Older
1
2
3
swagger: "2.0"

info:
Giacomo Bernini's avatar
Giacomo Bernini committed
4
  version: "2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL003 - VNF Performance Management Notification interface
6
  description: >
7
8
    SOL003 - VNF Performance Management Notification interface

9
    IMPORTANT: Please note that this file might be not aligned to the current
10
11
12
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

13
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
17
18

externalDocs:
19
20
  description: ETSI GS NFV-SOL 003 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_NFV-SOL003v020801p.pdf
21

22
basePath: "/callback/v2"
23
24
25
26
27
28
29
30
31
32

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
33
34
35
  ###############################################################################
  # Notification endpoint PerformanceInformationAvailableNotification           #
  ###############################################################################
36
  '/URI_is_provided_by_the_client_when_creating_the_subscription-PerformanceInformationAvailableNotification':
37
38
39
    #SOL003 location: 6.4.9
    post:
      description: >
40
41
        Notify.
        The POST method delivers a notification regarding a performance management
42
43
        event from the API producer to an API consumer.
        The API consumer shall have previously created an "Individual PM Job" or "Individual threshold" resource.
44
45
        This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2
        for URI query parameters, request and response data structures, and response codes.
46
47
48
49
50
51
52
53
      parameters:
        - name: PerformanceInformationAvailableNotification
          description: >
            Notification about performance information availability.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification"
Gergely Csatari's avatar
Gergely Csatari committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
68
69
70
71
72
73
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
74
75
      responses:
        204:
76
          description: >
77
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
78

79
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
80
81
82
83
84
85
86
87
88
          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.
              type: string
              maximum: 1
              minimum: 0
89
90
91
92
93
94
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
95
96
97
98
99
100
101
102
103
104
105
106
107
108
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
moscatelli's avatar
moscatelli committed
109

110
111
    get:
      description: >
112
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
113
        e.g. during the creation of the PM job or threshold resource.
114
115
        This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
116
117
118
119
120
121
122
123
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
124
125
126
127
128
129
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
130
131
      responses:
        204:
132
          description: >
133
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
134

135
136
            Shall be returned to indicate that the notification endpoint has been tested successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
137
138
139
140
141
142
143
144
145
          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.
              type: string
              maximum: 1
              minimum: 0
146
147
148
149
150
151
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
166

167
168
169
  ###############################################################################
  # Notification endpoint ThresholdCrossedNotification                          #
  ###############################################################################
170
  '/URI_is_provided_by_the_client_when_creating_the_subscription-ThresholdCrossedNotification':
171
172
173
    #SOL003 location: 6.4.9
    post:
      description: >
174
175
        Notify.
        The POST method delivers a notification regarding a performance management
176
        event from the API producer to an API consumer.
177
178
179
        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 6.4.9.3.1-1 and 6.4.9.3.1-2
        for URI query parameters, request and response data structures, and response codes.
180
181
182
183
184
185
186
187
      parameters:
        - name: ThresholdCrossedNotification
          description: >
            Notification about performance information availability.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification"
Gergely Csatari's avatar
Gergely Csatari committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          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
202
203
204
205
206
207
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
208
209
      responses:
        204:
210
          description: >
211
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
212

213
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
214
215
216
217
218
219
220
221
222
          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.
              type: string
              maximum: 1
              minimum: 0
223
224
225
226
227
228
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
229
230
231
232
233
234
235
236
237
238
239
240
241
242
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
moscatelli's avatar
moscatelli committed
243

244
245
    get:
      description: >
246
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer
247
248
249
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
250
251
252
253
254
255
256
257
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
258
259
260
261
262
263
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
264
265
      responses:
        204:
266
          description: >
267
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
268

269
270
            Shall be returned to indicate that the notification endpoint has been tested successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
271
272
273
274
275
276
277
278
279
          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.
              type: string
              maximum: 1
              minimum: 0
280
281
282
283
284
285
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
286
287
288
289
290
291
292
293
294
295
296
297
298
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
299
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"