We welcome and encourage contributions from the community. Keep in mind that this spec describes the current production API so changes must reflect actual behavior of the API.
The tooling chosen supports either authoring, validation, testing, or publishing. Respective Make targest
- Spectral: JSON/YAML linter with support for OpenAPI v3, custom rules, built-in functions, and custom functions
- OpenAPI CLI: OpenAPI CLI toolbox with rich validation and bundling features.
In addition, the following tools are leveraged to facilitate authoring the spec.
These are useful extensions when choosing to author OpenAPI spec using Visual Studio Code.
- Spectral: View linting violations inline
- OpenAPI Preview: Preview the API spec in SwaggerUI within the editor