openapi_documents

---

Generate an openapi_document target for each file in the sources field.

Backend: pants.backend.experimental.openapi

---

dependencies

Iterable[str] | None

default: None

Addresses to other targets that this target depends on, e.g. ['helloworld/subdir:lib', 'helloworld/main.py:lib', '3rdparty:reqs#django'].

This augments any dependencies inferred by Pants, such as by analyzing your imports. Use pants dependencies or pants peek on this target to get the final result.

See https://www.pantsbuild.org/2.24/docs/using-pants/key-concepts/targets-and-build-files for more about how addresses are formed, including for generated targets. You can also run pants list :: to find all addresses in your project, or pants list dir to find all addresses defined in that directory.

If the target is in the same BUILD file, you can leave off the BUILD file path, e.g. :tgt instead of helloworld/subdir:tgt. For generated first-party addresses, use ./ for the file path, e.g. ./main.py:tgt; for all other generated targets, use :tgt#generated_name.

You may exclude dependencies by prefixing with !, e.g. ['!helloworld/subdir:lib', '!./sibling.txt']. Ignores are intended for false positives with dependency inference; otherwise, simply leave off the dependency from the BUILD file.

description

str | None

default: None

A human-readable description of the target.

Use pants list --documented :: to see all targets with descriptions.

java_api_package

str | None

default: None

backend: pants.backend.experimental.openapi.codegen.java

Root package for generated API code

java_model_package

str | None

default: None

backend: pants.backend.experimental.openapi.codegen.java

Root package for generated model code

jvm_jdk

str | None

default: None

backend: pants.backend.experimental.openapi.codegen.java

The major version of the JDK that this target should be built with. If not defined, will default to [jvm].default_source_jdk.

jvm_resolve

str | None

default: None

backend: pants.backend.experimental.openapi.codegen.java

The resolve from [jvm].resolves to use when compiling this target.

If not defined, will default to [jvm].default_resolve.

skip_java

bool

default: False

backend: pants.backend.experimental.openapi.codegen.java

If true, skips generation of Java sources from this target

skip_spectral

bool

default: False

backend: pants.backend.experimental.openapi.lint.spectral

If true, don't run spectral lint on this target's code.

sources

Iterable[str] | None

default: ('openapi.json', 'openapi.yaml', 'openapi.yml')

A list of files and globs that belong to this target.

Paths are relative to the BUILD file's directory. You can ignore files/globs by prefixing them with !.

Example: sources=['openapi.json']

tags

Iterable[str] | None

default: None

Arbitrary strings to describe a target.

For example, you may tag some test targets with 'integration_test' so that you could run pants --tag='integration_test' test :: to only run on targets with that tag.