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

Fold long examples #23

Closed
derberg opened this issue May 13, 2020 · 1 comment
Closed

Fold long examples #23

derberg opened this issue May 13, 2020 · 1 comment

Comments

@derberg
Copy link
Member

derberg commented May 13, 2020

@Tamriel commented on Wed Jul 17 2019

When you have long examples, they take up so much space in the right column, that in the middle column there will be very much white space between one operation to the next.

The OpenApi html generator ReDoc solves this by folding the examples. The user is able to expand and collapse them.


@fmvilas commented on Fri Jul 19 2019

Absolutely agree.


@jonaslagoni commented on Fri Nov 08 2019

I think this was the same as #126 and closed by #153


@fmvilas commented on Sat Nov 09 2019

🤔 I don't think it's the same. The problem here is that, when the example is so long, it takes a lot of space on the screen. We're talking about limiting the visible height of the example and having an Expand/Collapse link/button below the example.


@derberg commented on Sat Feb 15 2020

It would be great to get some sample asyncapi spec that is actually generating such a long content, or do you know already some good public example?

Regarding ReDoc. Can you actually point me to a section where this functionality is visible? Is it expand/collapse by default to all, or only for the ones that are longer than the middle section?

In asyncapi-react component, it is solved in the way that all is collapsed by default, and you have one button to expand all, or you can expand one-by-one. So there are different ways to do it, this is why I ask :)


@github-actions[bot] commented on Wed May 13 2020

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

@WaleedAshraf
Copy link
Contributor

@derberg check here for an example: https://redocly.github.io/redoc/#tag/pet
I'll try a take on this.

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

No branches or pull requests

2 participants