Skip to main content
Version: 2.16.x (deprecated)

openapi_documents

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

Backend: pants.backend.experimental.openapi

tags​

field.type_hint
required

Arbitrary strings to describe a target.

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

description​

field.type_hint
required

A human-readable description of the target.

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

sources​

field.type_hint
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']

skip_spectral​

field.type_hint
default: False
backend: pants.backend.experimental.openapi.lint.spectral

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

dependencies​

field.type_hint
required

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 scie-pants-linux-x86_64 dependencies or scie-pants-linux-x86_64 peek on this target to get the final result.

See https://www.pantsbuild.org/v2.16/docs/targets for more about how addresses are formed, including for generated targets. You can also run scie-pants-linux-x86_64 list :: to find all addresses in your project, or scie-pants-linux-x86_64 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.