Misleading results with nullable in OpenAPI 3.0.3
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Recently, nullable was "clarified" in OpenAPI 3.0.3: https://github.com/OAI/OpenAPI-Specification/blob/master/proposals/003_Clarify-Nullable.md
The solutions proposed there don't really work in Redoc, for example https://github.com/OAI/OpenAPI-Specification/blob/master/proposals/003_Clarify-Nullable.md#can-allof-be-used-to-define-a-non-nullable-subtype-of-a-nullable-base-schema
It could make sense to handle null as normal data type in the future.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked OpenAPI nullable clarification proposal and reproducing its allOf examples in Redoc. Investigate how Redoc currently interprets nullable schemas; done means the documented OpenAPI 3.0.3 cases no longer produce misleading results and the intended behavior is covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100