Compatibility and support¶
This page summarizes which specification versions are supported by Jane components.
At a glance¶
- OpenAPI generation supports 2.0, 3.0.x and 3.1.x.
- JSON Schema generation supports draft 2019-09 and 2020-12.
- Validation support follows JSON Schema validation draft 2020-12.
Support matrix¶
| Area | Supported versions | Notes |
|---|---|---|
| OpenAPI client generation | 2.0, 3.0.x, 3.1.x | See detailed mapping below to pick the right component |
| JSON Schema model generation | 2019-09, 2020-12 | Applies to generated models and normalizers |
| JSON Schema validation | 2020-12 | See Validation guide for currently unsupported keywords |
| Nullability behavior | OpenAPI 2, 3.0.x, 3.1.x and JSON Schema | See Nullability guide for syntax per spec |
OpenAPI component selection¶
Use this mapping when choosing which OpenAPI package/component to install.
| OpenAPI version in your schema | Composer package to install | Internal component family |
|---|---|---|
| 2.0 | jane-php/open-api-2 + jane-php/open-api-runtime |
OpenApi2 |
| 3.0.x | jane-php/open-api-3 + jane-php/open-api-runtime |
OpenApi3 |
| 3.1.x | jane-php/open-api-3-1 + jane-php/open-api-runtime |
OpenApi31 |
Tip
If you handle mixed OpenAPI versions across projects, you can keep both jane-php/open-api-2 and jane-php/open-api-3 as dev dependencies. Jane will select the matching parser/component from the schema version.