Skip to content

Commit da95f2d

Browse files
committed
Docs: add version info to unsupported features tables
1 parent e93346c commit da95f2d

File tree

1 file changed

+38
-36
lines changed

1 file changed

+38
-36
lines changed

docs/supported_formats.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -124,48 +124,50 @@ datamodel-code-generator detects the OpenAPI version from the `openapi` field:
124124

125125
### JSON Schema - Unsupported Features
126126

127-
| Feature | Status | Notes |
128-
|---------|--------|-------|
129-
| `$anchor` | ❌ Not supported | Use `$ref` with `$id` instead |
130-
| `$dynamicRef` / `$dynamicAnchor` | ❌ Not supported | Draft 2020-12 dynamic references |
131-
| `unevaluatedProperties` | ❌ Not supported | Use `additionalProperties` instead |
132-
| `unevaluatedItems` | ❌ Not supported | Use `additionalItems` instead |
133-
| `contentMediaType` | ❌ Not supported | Content type hints ignored |
134-
| `contentEncoding` | ❌ Not supported | Encoding hints ignored |
135-
| `contentSchema` | ❌ Not supported | Nested content schema ignored |
136-
| `$vocabulary` | ❌ Not supported | Vocabulary declarations ignored |
137-
| `$comment` | ⚠️ Ignored | Comments not preserved in output |
138-
| `deprecated` | ⚠️ Partial | Recognized but not enforced |
139-
| `examples` (array) | ⚠️ Partial | Only first example used for Field default |
140-
| Recursive `$ref` | ⚠️ Partial | Supported with `ForwardRef`, may require manual adjustment |
141-
| `propertyNames` | ❌ Not supported | Property name validation ignored |
142-
| `dependentRequired` | ❌ Not supported | Dependent requirements ignored |
143-
| `dependentSchemas` | ❌ Not supported | Dependent schemas ignored |
127+
| Feature | Introduced | Status | Notes |
128+
|---------|------------|--------|-------|
129+
| `$anchor` | 2019-09 | ❌ Not supported | Use `$ref` with `$id` instead |
130+
| `$dynamicRef` / `$dynamicAnchor` | 2020-12 | ❌ Not supported | Dynamic references |
131+
| `unevaluatedProperties` | 2019-09 | ❌ Not supported | Use `additionalProperties` instead |
132+
| `unevaluatedItems` | 2019-09 | ❌ Not supported | Use `additionalItems` instead |
133+
| `contentMediaType` | Draft 7 | ❌ Not supported | Content type hints ignored |
134+
| `contentEncoding` | Draft 7 | ❌ Not supported | Encoding hints ignored |
135+
| `contentSchema` | 2019-09 | ❌ Not supported | Nested content schema ignored |
136+
| `$vocabulary` | 2019-09 | ❌ Not supported | Vocabulary declarations ignored |
137+
| `$comment` | Draft 7 | ⚠️ Ignored | Comments not preserved in output |
138+
| `deprecated` | 2019-09 | ⚠️ Partial | Recognized but not enforced |
139+
| `examples` (array) | Draft 6 | ⚠️ Partial | Only first example used for Field default |
140+
| Recursive `$ref` | Draft 4+ | ⚠️ Partial | Supported with `ForwardRef`, may require manual adjustment |
141+
| `propertyNames` | Draft 6 | ❌ Not supported | Property name validation ignored |
142+
| `dependentRequired` | 2019-09 | ❌ Not supported | Dependent requirements ignored |
143+
| `dependentSchemas` | 2019-09 | ❌ Not supported | Dependent schemas ignored |
144144

145145
### OpenAPI - Unsupported Features
146146

147-
| Feature | Status | Notes |
148-
|---------|--------|-------|
149-
| OpenAPI 2.0 (Swagger) | ⚠️ Limited | Recommend converting to 3.0+ |
150-
| `$ref` sibling keywords (3.0) | ❌ Not supported | 3.0 spec limitation |
151-
| `links` | ❌ Not supported | Runtime linking not applicable |
152-
| `callbacks` | ❌ Not supported | Webhook callbacks ignored |
153-
| `security` definitions | ❌ Not supported | Security schemes not generated |
154-
| `servers` | ❌ Not supported | Server configuration ignored |
155-
| `externalDocs` | ❌ Not supported | External documentation links ignored |
156-
| `xml` | ❌ Not supported | XML serialization hints ignored |
157-
| Request body `required` | ⚠️ Partial | Affects field optionality |
158-
| Header/Cookie parameters | ⚠️ Partial | Generated but not validated |
147+
| Feature | Introduced | Status | Notes |
148+
|---------|------------|--------|-------|
149+
| OpenAPI 2.0 (Swagger) | OAS 2.0 | ⚠️ Limited | Recommend converting to 3.0+ |
150+
| `$ref` sibling keywords | OAS 3.0 | ❌ Not supported | 3.0 spec limitation (fixed in 3.1) |
151+
| `links` | OAS 3.0 | ❌ Not supported | Runtime linking not applicable |
152+
| `callbacks` | OAS 3.0 | ❌ Not supported | Webhook callbacks ignored |
153+
| `webhooks` | OAS 3.1 | ❌ Not supported | Top-level webhooks ignored |
154+
| `security` definitions | OAS 2.0+ | ❌ Not supported | Security schemes not generated |
155+
| `servers` | OAS 3.0 | ❌ Not supported | Server configuration ignored |
156+
| `externalDocs` | OAS 2.0+ | ❌ Not supported | External documentation links ignored |
157+
| `xml` | OAS 2.0+ | ❌ Not supported | XML serialization hints ignored |
158+
| Request body `required` | OAS 3.0 | ⚠️ Partial | Affects field optionality |
159+
| Header/Cookie parameters | OAS 3.0 | ⚠️ Partial | Generated but not validated |
159160

160161
### GraphQL - Unsupported Features
161162

162-
| Feature | Status | Notes |
163-
|---------|--------|-------|
164-
| Directives | ❌ Not supported | Custom directives ignored |
165-
| Subscriptions | ❌ Not supported | Only Query/Mutation types |
166-
| Custom scalars | ⚠️ Partial | Mapped to `Any` by default |
167-
| Interfaces inheritance | ⚠️ Partial | Flattened to concrete types |
168-
| Federation directives | ❌ Not supported | Apollo Federation not supported |
163+
| Feature | Spec | Status | Notes |
164+
|---------|------|--------|-------|
165+
| Directives | Core | ❌ Not supported | Custom directives ignored |
166+
| Subscriptions | Core | ❌ Not supported | Only Query/Mutation types |
167+
| Custom scalars | Core | ⚠️ Partial | Mapped to `Any` by default |
168+
| Interfaces inheritance | Core | ⚠️ Partial | Flattened to concrete types |
169+
| Federation directives | Apollo | ❌ Not supported | Apollo Federation not supported |
170+
| Input unions | Proposal | ❌ Not supported | Not yet in GraphQL spec |
169171

170172
### Legend
171173

0 commit comments

Comments
 (0)