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

Documenation: Scheme list examples #12

Open
AndreasA opened this issue Mar 31, 2021 · 5 comments
Open

Documenation: Scheme list examples #12

AndreasA opened this issue Mar 31, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation examples help wanted PRs are encouraged and will be accepted question QnA

Comments

@AndreasA
Copy link

It would be nice if the provided schemes are visible individually from a response/request too.

@rohit-gohri
Copy link
Owner

If I understand the issue correctly, then I think this would be out of scope for this project and would be more suited for https://github.com/redocly/redoc ?

@AndreasA
Copy link
Author

Hi could be, I wasn't sure if it was just a missing configuration option here or a missing redoc feature. What I basically meant is it would be nice to have the model list from the swagger editor separately too:
https://editor.swagger.io/ should show the pet store example by default and at the bottom there is "Models".

@AndreasA
Copy link
Author

AndreasA commented Apr 13, 2021

@rohit-gohri I just checked the redoc live demo http://redocly.github.io/redoc/
and there is a sidebar that contains models. I can't seem to see that part using redocsuarus, am I missing a configuration option? ok. could it be that i have to use the x-tagGroups etc. to get this to work?

EDIT: If I understand this correctly, it can currently be defined/shown using those custom x- etc. attributes but it isn't done automatically and there already is a feature request for that: Redocly/redoc#134
So I guess there is nothing that can be done here as long as the custom properties are already supported and wait for redoc to implement the rest. Will try the custom x- stuff for now.

@rohit-gohri
Copy link
Owner

Oh that, I have used those. I'll try to add an example for that.

@rohit-gohri rohit-gohri added the question QnA label Apr 14, 2021
@AndreasA
Copy link
Author

@rohit-gohri Thanks

@rohit-gohri rohit-gohri added documentation Improvements or additions to documentation help wanted PRs are encouraged and will be accepted labels Mar 17, 2022
@rohit-gohri rohit-gohri changed the title Feature: Scheme list Documenation: Scheme list examples Mar 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation examples help wanted PRs are encouraged and will be accepted question QnA
Projects
Status: No status
Development

No branches or pull requests

2 participants