# Deprecations

<!-- Generated by scripts/build_deprecation_docs.py. Do not edit manually. -->

This page lists deprecations and scheduled breaking changes.

| ID | Kind | Target | Warning since | Removal | Replacement |
|----|------|--------|---------------|---------|-------------|
| `format.default-formatters` | behavior | `Default formatters` | 0.52.0 | TBD | Set formatters explicitly, for example black and isort or builtin. |
| `behavior.pydantic-v2-use-annotated-default` | behavior | `Pydantic v2 default for --use-annotated` | 0.52.1 | TBD | Explicitly pass --use-annotated or --no-use-annotated. |
| `behavior.remote-ref-default` | behavior | `Remote $ref fetching without --allow-remote-refs` | 0.56.0 | TBD | Pass --allow-remote-refs for trusted remote schemas, or --no-allow-remote-refs to block HTTP(S) $ref fetching. |
| `cli.allow-extra-fields` | cli-option | `--allow-extra-fields` | 0.31.0 | TBD | --extra-fields=allow |
| `cli.parent-scoped-naming` | cli-option | `--parent-scoped-naming` | 0.48.0 | TBD | --naming-strategy parent-prefixed |
| `cli.validation` | cli-option | `--validation` | 0.24.0 | TBD | --field-constraints |
| `config.json-config-strict-validation` | config | `JSON configuration values accepted by legacy validation` | 0.64.2 | TBD | Update the JSON configuration to match --output-format-json-schema config. |
| `config.yaml-non-lowercase-bool` | config | `YAML bool values True, False, TRUE, FALSE` | 0.48.0 | TBD | Use lowercase true or false. |
| `python-api.python-version-has-type-alias` | python-api | `PythonVersion.has_type_alias` | 0.52.1 | TBD | - |
| `schema.jsonschema-items-array` | schema | `JSON Schema Draft 2020-12 items array tuple validation` | 0.53.0 | TBD | Use prefixItems. |
| `schema.openapi-nullable` | schema | `OpenAPI 3.1 nullable keyword` | 0.53.0 | TBD | Use type arrays such as type: ["string", "null"]. |

## Details

### `format.default-formatters`

- **Kind:** behavior
- **Target:** `Default formatters`
- **Warning since:** 0.52.0
- **Planned removal:** TBD
- **Warning category:** `FutureWarning`
- **Replacement:** Set formatters explicitly, for example black and isort or builtin.

The default external formatters (black, isort) will become opt-in in a future version.

### `behavior.pydantic-v2-use-annotated-default`

- **Kind:** behavior
- **Target:** `Pydantic v2 default for --use-annotated`
- **Warning since:** 0.52.1
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`
- **Replacement:** Explicitly pass --use-annotated or --no-use-annotated.

Pydantic v2 with --use-annotated is recommended for correct type annotations. In a future version, --use-annotated will be enabled by default for Pydantic v2.

### `behavior.remote-ref-default`

- **Kind:** behavior
- **Target:** `Remote $ref fetching without --allow-remote-refs`
- **Warning since:** 0.56.0
- **Planned removal:** TBD
- **Warning category:** `FutureWarning`
- **Replacement:** Pass --allow-remote-refs for trusted remote schemas, or --no-allow-remote-refs to block HTTP(S) $ref fetching.

Remote $ref fetching without --allow-remote-refs is deprecated.

The current default allows remote fetching for compatibility; the scheduled default is disabled. Private, loopback, link-local, and otherwise non-public network targets require --allow-private-network.

### `cli.allow-extra-fields`

- **Kind:** cli-option
- **Target:** `--allow-extra-fields`
- **Warning since:** 0.31.0
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`
- **Replacement:** --extra-fields=allow

--allow-extra-fields is deprecated. Use --extra-fields=allow instead.

The replacement supports allow, forbid, and ignore modes.

### `cli.parent-scoped-naming`

- **Kind:** cli-option
- **Target:** `--parent-scoped-naming`
- **Warning since:** 0.48.0
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`
- **Replacement:** --naming-strategy parent-prefixed

--parent-scoped-naming is deprecated. Use --naming-strategy parent-prefixed instead.

### `cli.validation`

- **Kind:** cli-option
- **Target:** `--validation`
- **Warning since:** 0.24.0
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`
- **Replacement:** --field-constraints

The `--validation` option is deprecated and will be removed in a future release. Use --field-constraints instead.

### `config.json-config-strict-validation`

- **Kind:** config
- **Target:** `JSON configuration values accepted by legacy validation`
- **Warning since:** 0.64.2
- **Planned removal:** TBD
- **Warning category:** `FutureWarning`
- **Replacement:** Update the JSON configuration to match --output-format-json-schema config.

JSON configuration values that do not match the documented schema are deprecated and will become validation errors in a future release.

### `config.yaml-non-lowercase-bool`

- **Kind:** config
- **Target:** `YAML bool values True, False, TRUE, FALSE`
- **Warning since:** 0.48.0
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`
- **Replacement:** Use lowercase true or false.

Non-lowercase YAML bool values are deprecated. Use lowercase true or false instead.

### `python-api.python-version-has-type-alias`

- **Kind:** python-api
- **Target:** `PythonVersion.has_type_alias`
- **Warning since:** 0.52.1
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`

has_type_alias is deprecated and will be removed in a future version.

The project minimum Python version already supports TypeAlias.

### `schema.jsonschema-items-array`

- **Kind:** schema
- **Target:** `JSON Schema Draft 2020-12 items array tuple validation`
- **Warning since:** 0.53.0
- **Planned removal:** TBD
- **Warning category:** `UserWarning`
- **Replacement:** Use prefixItems.

items as array tuple validation is deprecated in Draft 2020-12. Use prefixItems instead.

### `schema.openapi-nullable`

- **Kind:** schema
- **Target:** `OpenAPI 3.1 nullable keyword`
- **Warning since:** 0.53.0
- **Planned removal:** TBD
- **Warning category:** `DeprecationWarning`
- **Replacement:** Use type arrays such as type: ["string", "null"].

nullable keyword is deprecated in OpenAPI 3.1, use type: ["string", "null"] instead.
