Redocly / Redocly/redoc

Support OpenAPI 3.2 documents

Open
#2,746 2 comments 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the problem to be solved

OpenAPI Specification 3.2.0 was published in September: OpenAPI Specification v3.2.0

However, if attempting to load an OpenAPI 3.2 document into https://redocly.github.io/redoc/ the following error occurs:

Error: Unsupported OpenAPI version: 3.2.0
    at t.detectSpec (https://redocly.github.io/redoc/redoc-demo.bundle.js:2:22498)
    at https://redocly.github.io/redoc/redoc-demo.bundle.js:2:872
    at Generator.next (<anonymous>)
    at https://redocly.github.io/redoc/redoc-demo.bundle.js:2:355
    at new Promise (<anonymous>)
    at r (https://redocly.github.io/redoc/redoc-demo.bundle.js:2:100)
    at b (https://redocly.github.io/redoc/redoc-demo.bundle.js:2:664)
    at https://redocly.github.io/redoc/redoc-demo.bundle.js:2:5064
    at Generator.next (<anonymous>)
    at https://redocly.github.io/redoc/redoc-demo.bundle.js:2:355

Describe the solution you'd like

The ability for redoc to consume OpenAPI 3.2 documents.

Describe alternatives you've considered

None.

Additional context

None.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by loading the linked OpenAPI Specification v3.2.0 document in the Redoc demo and trace the reported unsupported-version path. Review how Redoc detects supported OpenAPI versions, then verify that an OpenAPI 3.2 document can be consumed without the shown error.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.