redocusaurus icon indicating copy to clipboard operation
redocusaurus copied to clipboard

Documenation: Scheme list examples

Open AndreasA opened this issue 3 years ago • 5 comments

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

AndreasA avatar Mar 31 '21 08:03 AndreasA

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 ?

rohit-gohri avatar Apr 13 '21 19:04 rohit-gohri

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 avatar Apr 13 '21 21:04 AndreasA

@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: https://github.com/Redocly/redoc/issues/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.

AndreasA avatar Apr 13 '21 21:04 AndreasA

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

rohit-gohri avatar Apr 14 '21 03:04 rohit-gohri

@rohit-gohri Thanks

AndreasA avatar Apr 14 '21 05:04 AndreasA