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

Code comments rendering in openapi #404

Closed
matteo-cristino opened this issue Dec 13, 2024 · 1 comment · Fixed by #406
Closed

Code comments rendering in openapi #404

matteo-cristino opened this issue Dec 13, 2024 · 1 comment · Fixed by #406

Comments

@matteo-cristino
Copy link
Contributor

matteo-cristino commented Dec 13, 2024

Zenroom comments starts with #, but at the same time the openapi description field is rendered as a Markdown, thus our comments are transformed into titles, making the code a lot less readable. A quick solution can be to substitute every # with \\# when creating the openapi json. Maybe there are more cleaner solutions

@puria
Copy link
Member

puria commented Dec 13, 2024

Chic trick solved this in restroom-mw: https://github.com/dyne/restroom-mw/blob/master/packages/ui/src/index.ts#L13-L21

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

Successfully merging a pull request may close this issue.

2 participants