From fd20736cff832f627b23abbb16504fe1a6aa5932 Mon Sep 17 00:00:00 2001 From: Jonas Franz Date: Wed, 2 Mar 2022 16:21:53 +0100 Subject: [PATCH] Add documentation --- .gitignore | 2 ++ README.md | 7 +++++++ openapi.yaml | 4 ++-- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f8f7a55 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +gen +.idea \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe5a6e8 --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file diff --git a/openapi.yaml b/openapi.yaml index ac12bbd..922b12b 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -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: