Timezynk OpenAPI Specification

Links

• Documentation(ReDoc): https://developer.timezynk.com/
• SwaggerUI: https://developer.timezynk.com/swagger-ui/
• Look full spec:
  • JSON https://developer.timezynk.com/openapi.json
  • YAML https://developer.timezynk.com/openapi.yaml
• Preview spec version for branch [branch]: http://developer.timezynk.com/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

npm start

Starts the development server.

npm run build

Bundles the spec and prepares web_deploy folder with static assets.

npm test

Validates the spec.

npm run gh-pages

Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.

docker-compose up

Mocks api. Responds with hardcoded examples defines in each schema.