• Our website (www.rebilly.com) is powered by the Redocly Portal.
• Our API reference is powered by Redocly Reference.

TBD: Add Redocly validation status badge.

• Core API docs
• Users API docs
• Reports API docs
• Storefront API docs (this API is in development and subject to change)

Read our contribution guide.

If you use VS Code, use the Redocly VS Code extension to edit this repo and get inline lint feedback and previews.

1. Install Node JS
2. Clone repo and run npm ci in the repo root

Starts the development server to preview the docs:

• npm run serve-core - preview Core API docs
• npm run serve-users - preview Users API docs
• npm run serve-reports - preview Reports API doc
• npm run serve-storefront - preview Storefront API docs
• npm run serve-combined - preview combined API docs

Run npm run build to bundle the definitions into a single file in the dist folder.

Run npm test to validate the definitions.

Each API definition has its own root document in the root of the openapi folder.