Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PPANTT-142] feat: New API getAllStationsMaintenances #325

Merged
merged 5 commits into from
Oct 17, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
175 changes: 169 additions & 6 deletions openapi/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,168 @@
}
]
},
"/brokers/station-maintenances": {
"get": {
"tags": [
"Creditor Institutions"
],
"summary": "Get a list of all stations' maintenance filtered by dates",
"operationId": "getAllStationsMaintenances",
"parameters": [
{
"name": "startDateTimeBefore",
"in": "query",
"description": "Start date of maintenance, used to retrieve all maintenance that start before the provided date (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2024-04-01T10:00:00.000Z"
},
{
"name": "startDateTimeAfter",
"in": "query",
"description": "Start date of maintenance, used to retrieve all maintenance that start after the provided date (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2024-04-01T10:00:00.000Z"
},
{
"name": "endDateTimeBefore",
"in": "query",
"description": "End date of maintenance, used to retrieve all maintenance that start before the provided date (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2024-04-01T13:00:00.000Z"
},
{
"name": "endDateTimeAfter",
"in": "query",
"description": "End date of maintenance, used to retrieve all maintenance that start after the provided date (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')",
"required": false,
"schema": {
"type": "string",
"format": "date-time"
},
"example": "2024-04-01T13:00:00.000Z"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"X-Request-Id": {
"description": "This header identifies the call",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StationMaintenanceListResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {
"X-Request-Id": {
"description": "This header identifies the call",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemJson"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {
"X-Request-Id": {
"description": "This header identifies the call",
"schema": {
"type": "string"
}
}
}
},
"403": {
"description": "Forbidden",
"headers": {
"X-Request-Id": {
"description": "This header identifies the call",
"schema": {
"type": "string"
}
}
}
},
"429": {
"description": "Too many requests",
"headers": {
"X-Request-Id": {
"description": "This header identifies the call",
"schema": {
"type": "string"
}
}
}
},
"500": {
"description": "Service unavailable",
"headers": {
"X-Request-Id": {
"description": "This header identifies the call",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemJson"
}
}
}
}
},
"security": [
{
"ApiKey": []
},
{
"Authorization": []
}
]
},
"parameters": [
{
"name": "X-Request-Id",
"in": "header",
"description": "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
"schema": {
"type": "string"
}
}
]
},
"/brokers/{brokercode}": {
"get": {
"tags": [
Expand Down Expand Up @@ -18718,15 +18880,15 @@
"description": "Primitive number version",
"format": "int32"
},
"flag_standin": {
"type": "boolean",
"description": "Represents the authorization to use the standin mode with this station"
},
"is_payment_options_enabled": {
"type": "boolean"
},
"rest_endpoint": {
"type": "string"
},
"flag_standin": {
"type": "boolean",
"description": "Represents the authorization to use the standin mode with this station"
}
}
},
Expand Down Expand Up @@ -19513,7 +19675,8 @@
"type": "string",
"description": "Code of the broker that owns the station"
}
}
},
"description": "List of station's maintenance"
},
"PspChannelCode": {
"required": [
Expand Down Expand Up @@ -20972,4 +21135,4 @@
}
}
}
}
}
Loading
Loading