@dcl/catalyst-api-specs

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

1. Install Node JS.
2. Clone this repo and run yarn in the repo root.

Usage

yarn start

Starts the reference docs preview server.

yarn build

Bundles the definition to the dist folder.

yarn 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.