Skip to content

Commit 8178898

Browse files
gioelemellaaomegax
gioelemella
and
aomegax
authored
chore: Update biz-service openapi (#3613)
update biz-service openapi Co-authored-by: Francesco Cesareo <cesareo.francesco@gmail.com>
1 parent 9108b5f commit 8178898

File tree

4 files changed

+438
-462
lines changed

4 files changed

+438
-462
lines changed

‎src/domains/bizevents-app/api/bizevents-helpdesk/v1/_openapi.json.tpl‎

Lines changed: 78 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"title": "Biz-Events Service - Biz-Events Helpdesk",
55
"description": "Microservice for exposing REST APIs for bizevent Helpdesk.",
66
"termsOfService": "https://www.pagopa.gov.it/",
7-
"version": "0.2.2"
7+
"version": "0.2.3"
88
},
99
"servers": [
1010
{
@@ -23,6 +23,17 @@
2323
"summary": "health check",
2424
"description": "Return OK if application is started",
2525
"operationId": "healthCheck",
26+
"parameters": [
27+
{
28+
"name": "X-Request-Id",
29+
"in": "header",
30+
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
31+
"required": false,
32+
"schema": {
33+
"type": "string"
34+
}
35+
}
36+
],
2637
"responses": {
2738
"401": {
2839
"description": "Unauthorized",
@@ -46,17 +57,6 @@
4657
}
4758
}
4859
},
49-
"429": {
50-
"description": "Too many requests",
51-
"headers": {
52-
"X-Request-Id": {
53-
"description": "This header identifies the call",
54-
"schema": {
55-
"type": "string"
56-
}
57-
}
58-
}
59-
},
6060
"400": {
6161
"description": "Bad Request",
6262
"headers": {
@@ -75,6 +75,17 @@
7575
}
7676
}
7777
},
78+
"429": {
79+
"description": "Too many requests",
80+
"headers": {
81+
"X-Request-Id": {
82+
"description": "This header identifies the call",
83+
"schema": {
84+
"type": "string"
85+
}
86+
}
87+
}
88+
},
7889
"200": {
7990
"description": "OK",
8091
"headers": {
@@ -117,18 +128,7 @@
117128
"ApiKey": []
118129
}
119130
]
120-
},
121-
"parameters": [
122-
{
123-
"name": "X-Request-Id",
124-
"in": "header",
125-
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
126-
"required": false,
127-
"schema": {
128-
"type": "string"
129-
}
130-
}
131-
]
131+
}
132132
},
133133
"/events/{biz-event-id}": {
134134
"get": {
@@ -146,6 +146,15 @@
146146
"schema": {
147147
"type": "string"
148148
}
149+
},
150+
{
151+
"name": "X-Request-Id",
152+
"in": "header",
153+
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
154+
"required": false,
155+
"schema": {
156+
"type": "string"
157+
}
149158
}
150159
],
151160
"responses": {
@@ -160,8 +169,19 @@
160169
}
161170
}
162171
},
163-
"422": {
164-
"description": "Unable to process the request.",
172+
"401": {
173+
"description": "Wrong or missing function key.",
174+
"headers": {
175+
"X-Request-Id": {
176+
"description": "This header identifies the call",
177+
"schema": {
178+
"type": "string"
179+
}
180+
}
181+
}
182+
},
183+
"200": {
184+
"description": "Obtained biz-event.",
165185
"headers": {
166186
"X-Request-Id": {
167187
"description": "This header identifies the call",
@@ -173,7 +193,7 @@
173193
"content": {
174194
"application/json": {
175195
"schema": {
176-
"$ref": "#/components/schemas/ProblemJson"
196+
"$ref": "#/components/schemas/BizEvent"
177197
}
178198
}
179199
}
@@ -196,8 +216,8 @@
196216
}
197217
}
198218
},
199-
"200": {
200-
"description": "Obtained biz-event.",
219+
"422": {
220+
"description": "Unable to process the request.",
201221
"headers": {
202222
"X-Request-Id": {
203223
"description": "This header identifies the call",
@@ -209,7 +229,7 @@
209229
"content": {
210230
"application/json": {
211231
"schema": {
212-
"$ref": "#/components/schemas/BizEvent"
232+
"$ref": "#/components/schemas/ProblemJson"
213233
}
214234
}
215235
}
@@ -231,36 +251,14 @@
231251
}
232252
}
233253
}
234-
},
235-
"401": {
236-
"description": "Wrong or missing function key.",
237-
"headers": {
238-
"X-Request-Id": {
239-
"description": "This header identifies the call",
240-
"schema": {
241-
"type": "string"
242-
}
243-
}
244-
}
245254
}
246255
},
247256
"security": [
248257
{
249258
"ApiKey": []
250259
}
251260
]
252-
},
253-
"parameters": [
254-
{
255-
"name": "X-Request-Id",
256-
"in": "header",
257-
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
258-
"required": false,
259-
"schema": {
260-
"type": "string"
261-
}
262-
}
263-
]
261+
}
264262
},
265263
"/events/organizations/{organization-fiscal-code}/iuvs/{iuv}": {
266264
"get": {
@@ -287,6 +285,15 @@
287285
"schema": {
288286
"type": "string"
289287
}
288+
},
289+
{
290+
"name": "X-Request-Id",
291+
"in": "header",
292+
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
293+
"required": false,
294+
"schema": {
295+
"type": "string"
296+
}
290297
}
291298
],
292299
"responses": {
@@ -301,8 +308,19 @@
301308
}
302309
}
303310
},
304-
"422": {
305-
"description": "Unable to process the request.",
311+
"401": {
312+
"description": "Wrong or missing function key.",
313+
"headers": {
314+
"X-Request-Id": {
315+
"description": "This header identifies the call",
316+
"schema": {
317+
"type": "string"
318+
}
319+
}
320+
}
321+
},
322+
"200": {
323+
"description": "Obtained biz-event.",
306324
"headers": {
307325
"X-Request-Id": {
308326
"description": "This header identifies the call",
@@ -314,7 +332,7 @@
314332
"content": {
315333
"application/json": {
316334
"schema": {
317-
"$ref": "#/components/schemas/ProblemJson"
335+
"$ref": "#/components/schemas/BizEvent"
318336
}
319337
}
320338
}
@@ -337,8 +355,8 @@
337355
}
338356
}
339357
},
340-
"200": {
341-
"description": "Obtained biz-event.",
358+
"422": {
359+
"description": "Unable to process the request.",
342360
"headers": {
343361
"X-Request-Id": {
344362
"description": "This header identifies the call",
@@ -350,7 +368,7 @@
350368
"content": {
351369
"application/json": {
352370
"schema": {
353-
"$ref": "#/components/schemas/BizEvent"
371+
"$ref": "#/components/schemas/ProblemJson"
354372
}
355373
}
356374
}
@@ -372,36 +390,14 @@
372390
}
373391
}
374392
}
375-
},
376-
"401": {
377-
"description": "Wrong or missing function key.",
378-
"headers": {
379-
"X-Request-Id": {
380-
"description": "This header identifies the call",
381-
"schema": {
382-
"type": "string"
383-
}
384-
}
385-
}
386393
}
387394
},
388395
"security": [
389396
{
390397
"ApiKey": []
391398
}
392399
]
393-
},
394-
"parameters": [
395-
{
396-
"name": "X-Request-Id",
397-
"in": "header",
398-
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
399-
"required": false,
400-
"schema": {
401-
"type": "string"
402-
}
403-
}
404-
]
400+
}
405401
}
406402
},
407403
"components": {

0 commit comments

Comments
 (0)