Zuplo CLI

Zuplo CLI: OpenAPI Overlay

Apply an OpenAPI Overlay to an OpenAPI document

Code

zuplo oas overlay --input <file> --overlay <file> --output <file> [options]

Examples

Apply an overlay to an OpenAPI document

Code

zuplo oas overlay --input openapi.json --overlay changes.json --output result.json

Apply overlay and output in YAML format

Code

zuplo oas overlay -i api.yaml -v overlay.yaml -o result.yaml --yaml

Apply overlay and convert format in one step

Code

zuplo oas overlay \
  --input openapi.json \
  --overlay overlay.json \
  --output result.yaml \
  --format yaml

Watch input and overlay files for changes and automatically re-apply

Code

zuplo oas overlay \
  --input openapi.json \
  --overlay changes.json \
  --output result.json \
  --watch

The input OpenAPI file

Type: stringAlias: -i

The overlay file

Type: stringAlias: -l

The output OpenAPI file path

Type: stringAlias: -o

Output format

Type: stringChoices: json, yamlAlias: -f

Output in JSON format

Type: booleanConflicts: --yaml, --format

Output in YAML format

Type: booleanConflicts: --json, --format

Watch input and overlay files for changes and automatically re-apply

Type: booleanDefault: false

The following global options are available for all commands:

Last modified on October 25, 2026