Catalyst Server API Definition
API definition for the Catalyst Server implementation.
Check out the public API docs here
Working on the Catalyst API Definition
Install
- Install Node JS.
- Clone this repo and run
npm install
in the repo root.
Usage
npm start
Starts the reference docs preview server.
npm run build
Bundles the definition to the dist folder.
npm test
Validates the definition.
Readocly
This repository uses Redocly to generate API reference documentation
The .redocly.yaml
controls settings for various
tools including the lint tool and the reference
docs engine. Open it to find examples and
read the docs
for more information.