Skip to content
WhimApp TSP (Transport Service Provider) Open API
JavaScript
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Produce static documentation site and update OpenAPI specification li… Nov 19, 2019
docs Compile markdown files locally and produce overview file (#73) Mar 23, 2020
examples Added link to schemas doc, fixed webhook schema and added booking opt… Feb 19, 2020
specs Compile markdown files locally and produce overview file (#73) Mar 23, 2020
src Compile markdown files locally and produce overview file (#73) Mar 23, 2020
test Update to latest maas-schemas-ts Mar 23, 2020
utils Compile markdown files locally and produce overview file (#73) Mar 23, 2020
.editorconfig Produce static documentation site and update OpenAPI specification li… Nov 19, 2019
.eslintignore Produce static documentation site and update OpenAPI specification li… Nov 19, 2019
.eslintrc.js
.gitignore Upgrade packages and fix security issues Mar 23, 2020
.npmignore Produce static documentation site and update OpenAPI specification li… Nov 19, 2019
.prettierignore Produce static documentation site and update OpenAPI specification li… Nov 19, 2019
.prettierrc.js
.travis.yml
CONTRIBUTING.md
LICENSE Produce static documentation site and update OpenAPI specification li… Nov 19, 2019
README.md Change readme to state that it is a WhimAPI TSP API (#44) Nov 22, 2019
package-lock.json Compile markdown files locally and produce overview file (#73) Mar 23, 2020
package.json Compile markdown files locally and produce overview file (#73) Mar 23, 2020

README.md

WhimApp TSP (Transport Service Provider) API

This is the WhimApp TSP (Transport service provider) API repository, containing OpenAPI specification, JSON schema for data model and examples.

Using these documents, a third party transport service provider can implement a MaaS compatible API ready to be integrated into WhimApp

An interactive version of this documentation is published at maasglobal.github.io.

For a brief walk through of a booking process see here

Getting started

  • spec/booking.yml - OpenAPI Specification for TSP provider booking

Living documentation

To run it locally, execute

npm install
npm start

Open browser and navigate to documentation portal (http://localhost:3000)

  • Redoc UI for documentation
  • Examples

Build the static website with documentation

npm run build
npm run dist

Related projects

Data model are provided by maas-schemas which are used in API specification to declare and validate request and response payloads.

To create local, OpenAPI specification compatible copy of this schemas, execute npm run build. This will create local schemas folder which are referenced in specs/booking.yml

Links

You can’t perform that action at this time.