diff --git a/openapi.yaml b/openapi.yaml index 922b12b..50e7ace 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -36,6 +36,7 @@ paths: - $ref: '#/components/parameters/language' - in: query name: lat + required: true description: Latitude schema: type: number @@ -43,6 +44,7 @@ paths: example: 41.392710 - in: query name: lon + required: true description: Longitude schema: type: number @@ -55,6 +57,81 @@ paths: application/json: schema: $ref: '#/components/schemas/GetStationsResponse' + /trains: + get: + tags: + - train + summary: Find train connections for a specific route + parameters: + - $ref: '#/components/parameters/app' + - $ref: '#/components/parameters/appVersion' + - $ref: '#/components/parameters/osName' + - $ref: '#/components/parameters/osVersion' + - $ref: '#/components/parameters/language' + - in: query + name: outwardStation + required: true + description: Code of outward station + schema: + type: string + example: 60000 + - in: query + name: returnStation + required: true + description: Code of return station + schema: + type: string + example: 71801 + - in: query + name: outwardDate + required: true + description: Date for outward journey (DD-MM-YYYY) + schema: + type: string + format: date + pattern: /([0-9]{2}-[0-9]{2}-[0-9]{4}/ + example: 01-05-2022 + - in: query + name: returnDate + description: Date for return journey (DD-MM-YYYY) + schema: + type: string + format: date + pattern: /([0-9]{2}-[0-9]{2}-[0-9]{4}/ + example: 02-05-2022 + - in: query + name: adult + description: Number of adult passengers + schema: + type: number + format: int + example: 1 + - in: query + name: child + description: Number of children + schema: + type: number + format: int + - in: query + name: babyUnderFour + description: Number of babies under 4 years + schema: + type: number + format: int + - in: query + name: senior + description: Number of senior passengers + schema: + type: number + format: int + - in: query + name: promoCode + description: Promo Code + schema: + type: string + responses: + '200': + description: OK components: parameters: app: @@ -105,6 +182,7 @@ components: lastUpdateStations: type: string format: 'date-time' + pattern: /([0-9]{4})-(?:[0-9]{2})-([0-9]{2}) ([0-9]{2}):([0-9]{2}):([0-9]{2}).([0-9]{3})/ example: "2022-03-01 01:06:25.034" Station: type: object