Spot OpenAPI Specification

Spot OpenAPI Specification is a static site built using OpenAPI definitions and powered by ReDoc.

Table of Contents

• Requirements
• Local Development
• Build Artifacts
• Getting Help
• Community
• Contributing
• License

Requirements

• Nvm
• Node.js
• Yarn

Local Development

• Start the ReDoc webserver (available at http://localhost:8080):

# using yarn
$ yarn serve

# using docker
$ make serve

• Validate the API definition against the OpenAPI schema:

# using yarn
$ yarn validate

# using docker
$ make validate

Build Artifacts

• Make a static HTML file with ReDoc:

# using yarn
$ yarn bundle:redoc

# using docker
$ make bundle-redoc

• Make a single JSON bundle of the OpenAPI spec:

# using yarn
$ yarn bundle:swagger

# using docker
$ make bundle-swagger

Getting Help

We use GitHub issues for tracking bugs and feature requests. Please use these community resources for getting help:

• Ask a question on Stack Overflow and tag it with spot-openapi.
• Join our Spot community on Slack.
• Open an issue.

Community

• Slack
• Twitter

Contributing

Please see the contribution guidelines.

License

Code is licensed under the Apache License 2.0.