sv-tools/Roas OpenAPI Action
Validate and convert OpenAPI specs and Overlay documents with roas
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| subcommand | roas subcommand: validate, convert, overlay validate, overlay convert, overlay apply, arazzo validate, or arazzo convert | — | validate |
| file | Positional input: the OpenAPI spec (validate, convert, overlay apply), the Overlay document (overlay validate, overlay convert), or the Arazzo description (arazzo validate, arazzo convert), as JSON or YAML | yes | — |
| from | Force input spec version (e.g. v2, v3.0, v3.1, v3.2). Spec validate/convert only. | — | — |
| to | Target version. For convert: a spec version (e.g. v3.1, v3.2). For overlay convert: an overlay version (v1.0, v1.1). For arazzo convert: an arazzo version (v1.0, v1.1). Required for convert, overlay convert, and arazzo convert. | — | — |
| merge | Newline-separated list of additional specs to merge on top of the base (convert only). Each source is upconverted to the target version, then merged in incoming-order. | — | — |
| merge-options | Whitespace-separated merge options (convert only, requires merge): base-wins, error-on-conflict, deep-merge-object-schemas, merge-info, replace-lists-when-empty. | — | — |
| apply | Newline-separated list of Overlay documents to apply on top of the converted/merged spec (convert only). Applied in order, last in the pipeline (after merge, before collapse). | — | — |
| overlay | Newline-separated list of Overlay documents to apply to the target spec (overlay apply only). Applied in order. Required when subcommand=overlay apply. | — | — |
| apply-options | Whitespace-separated overlay apply options (convert with apply, or overlay apply): error-on-zero-match, error-on-mixed-kind-match. | — | — |
| collapse | Lift inline components into the root bag and replace call sites with $refs (convert only). | — | false |
| load | Whitespace-separated $ref loaders to enable: file, http | — | — |
| ignore | Whitespace-separated checks to skip. validate: validation checks. overlay validate / arazzo validate: empty-info-title, empty-info-version. | — | — |
| format | Force input format: json or yaml | — | — |
| output-format | Force output format for convert, overlay convert, overlay apply, and arazzo convert: json or yaml | — | — |
| output-file | Write command output to this path instead of stdout | — | — |
| Echo the parsed spec/overlay/description on stdout (validate, overlay validate, and arazzo validate only) | — | false |
Outputs
no outputs