api

api.moov.io

This repository holds our api.moov.io website, which is our API documentation.

Documentation is markdown generated by ReDoc. View source on the Swagger Editor.

Getting Started / Install

1. Clone the repository somewhere (git clone git@github.com:moov-io/api.git)
2. Edit the files to make your change (i.e. openpai.yaml)
3. Run make build to generate a docker image with your changes
   1. Verify your change looks ok by running the docker image
      • docker run -p 8080:8080 -it moov/api.moov.io:latest
      • Load localhost:8080 in a web browser
4. Commit your changes, push up a new branch, and create a Pull Request!

API Requirements

• Every endpoint MUST support X-Request-Id.
• Every POST, PUT, and PATCH endpoint MUST support X-Idempotency-Key.
• Authenticated requests (outside OAuth and Users) MUST accept both OAuth and User auth.
  • Some OAuth and User operations require their speciifc auth (or the other form to bootstrap).
• All 4xx errors MUST include an error message for the user.

Getting Help

Contributing

Yes please! Please start by reviewing our Code of Conduct.

You only have a fresh set of eyes once! The easiest way to contribute is to give feedback on the documentation that you are reading right now. This can be as simple as sending a message to our Google Group with your feedback or updating the markdown in this documentation and issuing a pull request.

• moov.io
• api.moov.io (This project)
• docs.moov.io

License

Apache License 2.0 See LICENSE for details.