Browse Source

Add documentation

main
Jonas Franz 4 months ago
parent
commit
fd20736cff
  1. 2
      .gitignore
  2. 7
      README.md
  3. 4
      openapi.yaml

2
.gitignore vendored

@ -0,0 +1,2 @@ @@ -0,0 +1,2 @@
gen
.idea

7
README.md

@ -0,0 +1,7 @@ @@ -0,0 +1,7 @@
# RENFE WSMR API
This documentation contains the API documentation of the RENFE WSMR API used to get details for stations, routes, prices and user accounts.
[openapi.yaml](openapi.yaml) contains the currently reverse engineered API routes and declarations.
Please feel free to extend this documentation.

4
openapi.yaml

@ -95,15 +95,15 @@ components: @@ -95,15 +95,15 @@ components:
schemas:
GetStationsResponse:
type: object
required:
- station
properties:
station:
required: true
type: array
items:
$ref: '#/components/schemas/Station'
lastUpdateStations:
type: string
required: false
format: 'date-time'
example: "2022-03-01 01:06:25.034"
Station:

Loading…
Cancel
Save