Specs commands
The Specs commands are used to build
, lint
and validate the REST API specs.
Usage
client
defaults toall
The
client
parameter is variadic, you can pass multipleclient
name
apic build specs <client... | all>
Available options
Option | Command | Description |
---|---|---|
verbose | -v, –verbose | Make the process verbose, display logs from third party tools |
skip cache | -s, –skip-cache | Skip cache checking to force building specs |
Build
Build all specs
apic build specs
Build specific spec
apic build specs recommend
Build many spec
apic build specs recommend search ingestion
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