openapi-format

---

Format an OpenAPI document by ordering, formatting and filtering fields (https://github.com/thim81/openapi-format).

Backend: pants.backend.experimental.openapi.lint.openapi_format

Config section: [openapi-format]

Basic options

skip

--[no-]openapi-format-skip
PANTS_OPENAPI_FORMAT_SKIP

default: False

If true, don't use openapi-format when running scie-pants-linux-x86_64 fmt and scie-pants-linux-x86_64 lint.

args

--openapi-format-args="[<shell_str>, <shell_str>, ...]"
PANTS_OPENAPI_FORMAT_ARGS

default: []

Arguments to pass directly to openapi-format, e.g. --openapi-format-args='--no-sort'.

Advanced options

version

--openapi-format-version=<str>
PANTS_OPENAPI_FORMAT_VERSION

default: openapi-format@1.13.1

Version string for the tool in the form package@version (e.g. prettier@2.6.2)

install_from_resolve

--openapi-format-install-from-resolve=<str>
PANTS_OPENAPI_FORMAT_INSTALL_FROM_RESOLVE

default: None

If specified, install the tool using the lockfile for this named resolve, instead of the version configured in this subsystem.

If unspecified, the tool will use the default configured package manager [nodejs].package_manager`, and install the tool without a lockfile.

Deprecated options

None