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

List of Open API 3.0 features that are not supported by redoc@2.0.0-alpha.32 ( Release 2.0.0-alpha.32 ) #592

Closed
somayaji1983 opened this issue Aug 2, 2018 · 8 comments

Comments

@somayaji1983
Copy link

Dear Team,
Please help us with information on open api 3.0 features that are not supported by
redoc@2.0.0-alpha.32 ( Release 2.0.0-alpha.32 ) version.

Thanks
Ramesh

@chatelao
Copy link

chatelao commented Aug 7, 2018

Links ?

@RomanHotsiy
Copy link
Member

Would be great if anyone can help with this...
PR's are welcome

@somayaji1983
Copy link
Author

somayaji1983 commented Aug 28, 2018

Dear Team,
After testing with latest release version of ReDoc ( release 2.0.0.-alpha.36 ), here are the list of API 3.0 features which are not supported in ReDoc and some issues that are observed.

This is just a consolidated list with observations.

S.No Issue Description
1 ReDoc has no option to navigate through all templated servers, ReDoc rendering computed URLs with default or first enumerated values
2 ReDoc unable to generating example for response content type with “application/xml”.
3 ReDoc rendering failed and throw error, when “scope” is not defined inside OAuth2 security scheme .
4 ReDoc GUI is scattered some time when rendering conditions like anyOf, oneOf in requestBody or responses
5 ReDoc not supporting Open API 3.0 Links features
6 ✅ Callbacks are supported since 2.0.0-rc.27 ReDoc not supporting Open API 3.0 Callbacks features
7 ReDoc unable to render external link reference through externalValue in example section
8 ReDoc GUI is scattered when description field with HEADING level string is written under Info object.

Thanks
Ramesh

@yinchanted
Copy link

@RomanGotsiy Is the support for Open API 3.0 Links and Callbacks feature in the roadmap?

@trinh-ngo-ntq
Copy link

@RomanGotsiy Is the support for Open API 3.0 Links and Callbacks feature in the roadmap?

IMHO, possible no.
This feature had been added to OA3.0 long time but Redoc still does not support it, till today

@RomanHotsiy
Copy link
Member

RomanHotsiy commented Mar 15, 2019

Is the support for Open API 3.0 Links and Callbacks feature in the roadmap?

@yinchanted yes it is.

This feature had been added to OA3.0 long time but Redoc still does not support it, till today

@trinh-ngo-ntq Your PRs are welcome!

@forivall
Copy link

Callbacks were added via #1224

@RomanHotsiy
Copy link
Member

I just checked the points from the table again and I am going to close this issue:

  1. ReDoc has no option to navigate through all templated servers, ReDoc rendering computed URLs with default or first enumerated values

It has. Once you click on the server you will see a popover with all the servers.

  1. ReDoc unable to generating example for response content type with “application/xml”

Dup of #492

  1. ReDoc rendering failed and throw error, when “scope” is not defined inside OAuth2 security scheme

Scope is REQUIRED in OAuth2 security scheme (empty array works too), won't fix

  1. ReDoc GUI is scattered some time when rendering conditions like anyOf, oneOf in requestBody or responses

Not actionable. I need specific issues.

  1. ReDoc not supporting Open API 3.0 Links features

Dup of #437

  1. ReDoc unable to render external link reference through externalValue in example section

It should be able. Open a separate issue with the reproduction steps.

  1. ReDoc GUI is scattered when description field with HEADING level string is written under Info object.

It needs more details.

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

6 participants