7u4 / api-definitions

Rebilly's public API definitions

Rebilly OpenAPI Definitions

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

TBD: Add Redocly validation status badge.

Links

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

Contributing

Read our contribution guide.

Environment setup

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

Install

1. Install Node JS (version 14 or more recent)
2. Clone repo and run npm ci in the repo root

Usage

Preview

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

Build

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

Validate

Run npx redocly lint to validate the definitions.