Skip to content

Commit 3000314

Browse files
aferracciaferracci
committed
DDay sync
1 parent d31bb46 commit 3000314

File tree

1 file changed

+152
-144
lines changed

1 file changed

+152
-144
lines changed

‎openapi/gpd_fdr.json‎

Lines changed: 152 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -1,164 +1,172 @@
11
{
2-
"openapi": "3.0.0",
3-
"info": {
4-
"title": "Reporting Analysis - GPD",
5-
"version": "0.1.8"
6-
},
7-
"servers": [
8-
{
9-
"url": "https://api.uat.platform.pagopa.it/gpd-reporting/api/v1"
10-
}
11-
],
12-
"paths": {
13-
"/organizations/{organizationId}/reportings": {
14-
"get": {
15-
"tags": [
16-
"Organization Requests"
17-
],
18-
"summary": "getFlowList",
19-
"parameters": [
20-
{
21-
"name": "organizationId",
22-
"in": "path",
23-
"schema": {
24-
"type": "string"
25-
},
26-
"required": true,
27-
"example": "90000000000"
28-
},
29-
{
30-
"name": "flowDate",
31-
"in": "query",
32-
"description": "Filter by flow date (use the format yyyy-MM-dd)",
33-
"schema": {
34-
"type": "string",
35-
"format": "date"
36-
},
37-
"required": false,
38-
"example": "2020-01-01"
39-
}
40-
],
41-
"responses": {
42-
"200": {
43-
"description": "Successful response",
44-
"content": {
45-
"application/json": {
46-
"schema": {
47-
"$ref": "#/components/schemas/FlowList"
48-
}
49-
}
50-
}
2+
"openapi": "3.0.1",
3+
"info": {
4+
"title": "Reporting Analysis - GPD",
5+
"version": "0.3.3"
6+
},
7+
"servers": [
8+
{
9+
"url": "https://api.platform.pagopa.it/gpd-reporting/api/v1"
10+
}
11+
],
12+
"paths": {
13+
"/organizations/{organizationId}/reportings": {
14+
"get": {
15+
"tags": [
16+
"Organization Requests"
17+
],
18+
"summary": "getFlowList",
19+
"description": "getFlowList",
20+
"operationId": "get-organizations-organizationid-reportings",
21+
"parameters": [
22+
{
23+
"name": "organizationId",
24+
"in": "path",
25+
"required": true,
26+
"schema": {
27+
"type": "string"
5128
},
52-
"400": {
53-
"description": "Error response",
54-
"content": {
55-
"application/json": {}
56-
}
29+
"example": 90000000000
30+
},
31+
{
32+
"name": "flowDate",
33+
"in": "query",
34+
"description": "Format - date (as full-date in RFC3339). Filter by flow date (use the format yyyy-MM-dd)",
35+
"schema": {
36+
"type": "string",
37+
"format": "date"
5738
},
58-
"403": {
59-
"description": "Forbidden",
60-
"content": {
61-
"application/json": {
62-
"example": {
63-
"statusCode": 403,
64-
"message": "You are not allowed to access this resource."
39+
"example": "2020-01-01"
40+
}
41+
],
42+
"responses": {
43+
"200": {
44+
"description": "Successful response",
45+
"content": {
46+
"application/json": {
47+
"schema": {
48+
"$ref": "#/components/schemas/FlowList"
49+
},
50+
"example": [
51+
{
52+
"flowId": "2022-01-12PPAYITR1XXX-S079177254",
53+
"flowDate": "2022-01-12T00:31:05.0000000+00:00"
6554
}
66-
}
55+
]
6756
}
6857
}
58+
},
59+
"400": {
60+
"description": "Error response",
61+
"content": {
62+
"application/json": {}
63+
}
6964
}
7065
}
71-
},
72-
"/organizations/{organizationId}/reportings/{flowId}/date/{date}": {
73-
"get": {
74-
"tags": [
75-
"Organization Requests"
76-
],
77-
"summary": "getFlow",
78-
"parameters": [
79-
{
80-
"name": "organizationId",
81-
"in": "path",
82-
"schema": {
83-
"type": "string"
84-
},
85-
"required": true,
86-
"example": "90000000000"
87-
},
88-
{
89-
"name": "flowId",
90-
"in": "path",
91-
"schema": {
92-
"type": "string"
93-
},
94-
"required": true,
95-
"example": "2022-01-12PPAYITR1XXX-S239349322"
66+
}
67+
},
68+
"/organizations/{organizationId}/reportings/{flowId}/date/{date}": {
69+
"get": {
70+
"tags": [
71+
"Organization Requests"
72+
],
73+
"summary": "getFlow",
74+
"description": "getFlow",
75+
"operationId": "get-organizations-organizationid-reportings-flowid-date-date",
76+
"parameters": [
77+
{
78+
"name": "organizationId",
79+
"in": "path",
80+
"required": true,
81+
"schema": {
82+
"type": "string"
9683
},
97-
{
98-
"name": "date",
99-
"in": "path",
100-
"schema": {
101-
"type": "string"
102-
},
103-
"required": true,
104-
"example": "2022-01-11T23:31:05"
105-
}
106-
],
107-
"responses": {
108-
"200": {
109-
"description": "Successful response",
110-
"content": {
111-
"application/xml": {
112-
"schema": {
113-
"format": "binary",
114-
"type": "string",
115-
"description": "Flow XML"
116-
}
117-
}
118-
}
84+
"example": 90000000000
85+
},
86+
{
87+
"name": "flowId",
88+
"in": "path",
89+
"required": true,
90+
"schema": {
91+
"type": "string"
11992
},
120-
"403": {
121-
"description": "Forbidden",
122-
"content": {
123-
"application/json": {
124-
"example": {
125-
"statusCode": 403,
126-
"message": "You are not allowed to access this resource."
127-
}
128-
}
129-
}
93+
"example": "2022-01-12PPAYITR1XXX-S239349322"
94+
},
95+
{
96+
"name": "date",
97+
"in": "path",
98+
"required": true,
99+
"schema": {
100+
"type": "string"
130101
},
131-
"404": {
132-
"description": "Not Found",
133-
"content": {
134-
"application/json": {}
102+
"example": "2022-01-11T23:31:05.0000000+00:00"
103+
}
104+
],
105+
"responses": {
106+
"200": {
107+
"description": "Successful response",
108+
"content": {
109+
"application/xml": {
110+
"schema": {
111+
"type": "string",
112+
"description": "Flow XML",
113+
"format": "binary"
114+
},
115+
"example": "<Organizations-organizationId-Reportings-flowId-Date-date-Get200ApplicationXmlResponse>string</Organizations-organizationId-Reportings-flowId-Date-date-Get200ApplicationXmlResponse>"
135116
}
136117
}
118+
},
119+
"404": {
120+
"description": "Not Found",
121+
"content": {
122+
"application/json": {}
123+
}
137124
}
138125
}
139126
}
140-
},
141-
"components": {
142-
"schemas": {
143-
"FlowList": {
144-
"type": "array",
145-
"items": {
146-
"$ref": "#/components/schemas/Flow"
147-
}
148-
},
149-
"Flow": {
150-
"type": "object",
151-
"properties": {
152-
"flowId": {
153-
"type": "string",
154-
"example": "2022-01-12PPAYITR1XXX-S079177254"
155-
},
156-
"flowDate": {
157-
"type": "string",
158-
"example": "2022-01-12T00:31:05"
159-
}
127+
}
128+
},
129+
"components": {
130+
"schemas": {
131+
"FlowList": {
132+
"type": "array",
133+
"items": {
134+
"$ref": "#/components/schemas/Flow"
135+
}
136+
},
137+
"Flow": {
138+
"type": "object",
139+
"properties": {
140+
"flowId": {
141+
"type": "string",
142+
"example": "2022-01-12PPAYITR1XXX-S079177254"
143+
},
144+
"flowDate": {
145+
"type": "string",
146+
"example": "2022-01-12T00:31:05"
160147
}
161148
}
162149
}
150+
},
151+
"securitySchemes": {
152+
"apiKeyHeader": {
153+
"type": "apiKey",
154+
"name": "Ocp-Apim-Subscription-Key",
155+
"in": "header"
156+
},
157+
"apiKeyQuery": {
158+
"type": "apiKey",
159+
"name": "subscription-key",
160+
"in": "query"
161+
}
162+
}
163+
},
164+
"security": [
165+
{
166+
"apiKeyHeader": []
167+
},
168+
{
169+
"apiKeyQuery": []
163170
}
164-
}
171+
]
172+
}

0 commit comments

Comments
 (0)