Data Export OpenAPI Specification
Links
- Documentation(ReDoc): https://thunderheadone.github.io/one-dataexport-api/
- SwaggerUI: https://thunderheadone.github.io/one-dataexport-api/swagger-ui/
- Look full spec:
- Preview spec version for branch
[branch]
: https://thunderheadone.github.io/one-dataexport-api/preview/[branch]
Warning: All above links are updated only after Travis CI finishes deployment
Working on specification
Install
- Install Node JS
- Clone repo and
cd
- Run
npm install
- Run
Usage
- Run
npm start
- Checkout console output to see where local server is started. You can use all links (except
preview
) by replacing https://thunderheadone.github.io/one-dataexport-api/ with url from the message:Server started <url>
- Make changes using your favorite editor or
swagger-editor
(look for URL in console output) - 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 andswagger-ui
in parallel - Once you finish with the changes you can run tests using:
npm test
- Share your changes with the rest of the world by pushing to GitHub 😄
Questions or need help
The Thunderhead ONE team is available 24/7 to answer any questions you have. Just email onesupport@thunderhead.com or visit our docs page for more detailed installation and usage information.