WDT Hail OpenAPI Specification

Contributing

This is a spec for the API to be built by WDT for HAT. You can view the live documentation at http://www.ellym.co/hat-api-spec/

If you have thoughts, ideas, concerns, or other feedback please create an issue or pull request. You can also watch this repo to ensure that you stay in the loop.

Links

• Documentation(ReDoc): https://ellym.github.io/hat-api-spec/
• SwaggerUI: https://ellym.github.io/hat-api-spec/swagger-ui/
• Look full spec:
  • JSON https://ellym.github.io/hat-api-spec/swagger.json
  • YAML https://ellym.github.io/hat-api-spec/swagger.yaml
• Preview spec version for branch [branch]: https://ellym.github.io/hat-api-spec/preview/[branch]

Warning: All above links are updated only after Travis CI finishes deployment

Working on specification

Install

1. Install Node JS
2. Clone repo and cd
   • Run npm install

Usage

1. Run npm start
2. Checkout console output to see where local server is started. You can use all links (except preview) by replacing https://ellym.github.io/hat-api-spec/ with url from the message: Server started <url>
3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
4. All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change TIP: you can open swagger-editor, documentation and swagger-ui in parallel
5. Once you finish with the changes you can run tests using: npm test
6. Share you changes with the rest of the world by pushing to GitHub 😄