Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support a configurable version of redoc.standalone.js for preview-docs #734

Open
austpaul opened this issue Jun 20, 2022 · 5 comments
Open

Comments

@austpaul
Copy link

austpaul commented Jun 20, 2022

Is your feature request related to a problem? Please describe.
At times, the latest version of the redoc.standalone.js bundle can contain bugs. This is the situation right now, with 2.0.0-rc.72, which has several bugs. Preview-docs references https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js, with no option to override it.

Describe the solution you'd like
An additional optional parameter to specify the standalone.js version.
For example redocly preview-docs ./petstore.yaml --standalone-version=2.0.0-rc.58

This would result in https://cdn.jsdelivr.net/npm/redoc@2.0.0-rc.58/bundles/redoc.standalone.js being used instead of https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js.

Describe alternatives you've considered
I have not found other good alternatives. When publishing the documentation, we can always point to the desired version, but we would like to have the same experience when designing and testing the documentation using preview-docs.

Additional context
The affected code is to be found here:

: 'https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js'

@SmoliyY
Copy link
Contributor

SmoliyY commented Jun 21, 2022

@austpaul thank you for feature suggestion! We consider to implement this in the future.

@adamaltman
Copy link
Member

Side note: @austpaul have you reported the bugs in rc.72 or are existing bug issues opened?

@austpaul
Copy link
Author

Side note: @austpaul have you reported the bugs in rc.72 or are existing bug issues opened?

Hi. Not completely sure if all issues are already registered. I recognised these, so did not register my own.
Redocly/redoc#2044
Redocly/redoc#2040
Redocly/redoc#2066

There might be another issue which could be solved by this one, but not sure. I will create an example definition file and create a ticket to be sure.
Redocly/redoc#2042

@austpaul
Copy link
Author

@adamaltman I have registered an additional bug report for redoc.
Redocly/redoc#2079

@adamaltman
Copy link
Member

Thanks @austpaul -- looks like we fixed that yesterday.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants