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

info:
4
  version: "1.2.0"
5
  title: SOL003 - VNF Performance Management Notification interface
6
  description: >
7
8
    SOL003 - VNF Performance Management Notification interface

9

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

14
15
16
17
18
19
20
    
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
21

22
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
23
24
25
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
26
27

externalDocs:
28
29
  description: ETSI GS NFV-SOL 003 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

basePath: "/callback/v1"

schemes:
  - https

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

paths:
###############################################################################
# Notification endpoint PerformanceInformationAvailableNotification           #
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification':
    #SOL003 location: 6.4.9
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
49
50
51
        Notify


52
53
54
55
56
57
58
59
60
61
        The POST method delivers a notification regarding a performance
        management event from the server to the client.
      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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
        - 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
76
77
78
79
80
81
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
82
83
84
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
85
86
            No Content

87
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
88
89
90
91
92
93
94
95
96
          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
97
98
99
100
101
102
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
        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"
    get:
      description: >
        The GET method allows the server to test the notification endpoint
        that is provided by the client, e.g. during subscription.
Gergely Csatari's avatar
Gergely Csatari committed
121
122
123
124
125
126
127
128
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
129
130
131
132
133
134
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
135
136
137
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
138
139
            No Content

140
            The notification endpoint was tested successfully.
Gergely Csatari's avatar
Gergely Csatari committed
141
142
143
144
145
146
147
148
149
          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
150
151
152
153
154
155
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
        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"
###############################################################################
# Notification endpoint ThresholdCrossedNotification                          #
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification':
    #SOL003 location: 6.4.9
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
177
178
179
        Notify

        
180
181
182
183
184
185
186
187
188
189
        The POST method delivers a notification regarding a performance
        management event from the server to the client.
      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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
        - 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
204
205
206
207
208
209
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
210
211
212
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
213
214
            No Content

215
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
216
217
218
219
220
221
222
223
224
          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
225
226
227
228
229
230
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
        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"
    get:
      description: >
        The GET method allows the server to test the notification endpoint
        that is provided by the client, e.g. during subscription.
Gergely Csatari's avatar
Gergely Csatari committed
249
250
251
252
253
254
255
256
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
257
258
259
260
261
262
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
263
264
265
      responses:
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
266
267
            No Content

268
            The notification endpoint was tested successfully.
Gergely Csatari's avatar
Gergely Csatari committed
269
270
271
272
273
274
275
276
277
          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
278
279
280
281
282
283
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
284
285
286
287
288
289
290
291
292
293
294
295
296
297
        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"