Skip to main content

Specs commands

The Specs commands are used to build, lint and validate the REST API specs.

Usage

client defaults to all

yarn docker build specs <client | all>

Available options

OptionCommandDescription
verbose-v, --verboseMake the process verbose, display logs from third party tools
interactive-i, --interactiveOpen prompt to query parameters
skip cache-s, --skip-cacheSkip cache checking to force building specs

Build

Build all specs

yarn docker build specs

Build specific spec

yarn docker build specs recommend

Lint

Fix specs

Automatically done when building specs

yarn specs:fix

Check specs

If you just want to check the format (not override the files)

yarn specs:lint <client>
yarn specs:lint search