api

README

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 to generate a docker image with your changes
   1. Verify your changes by running locally with make serve
      • 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

channel	info
Google Group moov-users	The Moov users Google group is for contributors other people contributing to the Moov project. You can join them without a google account by sending an email to moov-users+subscribe@googlegroups.com. After receiving the join-request message, you can simply reply to that to confirm the subscription.
Twitter @moov_io	You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories.
GitHub Issue	If you are able to reproduce an problem please open a GitHub Issue under the specific project that caused the error.
moov-io slack	Join our slack channel to have an interactive discussion about the development of the project. Request an invite to the slack channel

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.