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

Ordering of endpoints is random with the use of yaml library : switch to oyaml #31

Open
rompom opened this issue Mar 5, 2020 · 1 comment

Comments

@rompom
Copy link

rompom commented Mar 5, 2020

If you want an embedded openapi in the page, the order of the endpoints is not kept.
The issue stem from there : https://github.com/sphinx-contrib/redoc/blob/master/sphinxcontrib/redoc.py#L94

The yaml library does not keep the order of the keys in dict structure.

I 've made a test with oyaml (https://github.com/wimglenn/oyaml), in this case the order is kept.

@ikalnytskyi
Copy link
Member

Hey @rompom,

Thanks for reporting that. Honestly, I have no capacity to maintain this library. If you come up with a PR, I'll gladly accept it. However, I'd recommend another solution: simply use python3.6 or higher to build you Sphinx docs and you will face no issues with ordering.

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