redoc icon indicating copy to clipboard operation
redoc copied to clipboard

No Support for OpenAPI 3.0

Open samclam23 opened this issue 2 years ago • 3 comments

Attempting to render an OpenAPI 3.0 specification partially works but is missing attributes like "server" which replaced "host" and "requestBody" which replaced "parameters.body" in the upgrade from swagger 2.0 to OpenAPI 3.0

samclam23 avatar Mar 16 '22 21:03 samclam23

I was able to solve this by loading a newer version of redoc. You can do this by specifying redoc_uri in your conf.py file.

redoc_uri = 'https://unpkg.com/[email protected]/bundles/redoc.standalone.js'

There is a brief section on it in the docs https://sphinxcontrib-redoc.readthedocs.io/en/stable/

Screen Shot 2022-04-07 at 1 03 32 AM

tgallant avatar Apr 07 '22 08:04 tgallant

Workaround that I can confirm works (for late 2024):

redoc_uri = 'https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js'

When you look at the redoc.js in build, it's actually using redoc 1.x (For some reason! The docs hint it's using a /latest cdn, where even then, it's an unexpected actually 2.x.x-rc)

Use redoc.ly instead == fix

dylanh724 avatar Aug 29 '24 02:08 dylanh724

@ikalnytskyi Hey bud, great pkg -- but are you still maintaining this? I saw this was opened in 2022

dylanh724 avatar Aug 29 '24 02:08 dylanh724