-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Support for markdown table in OAS 3.0 #1413
Comments
I believe this is a related issue swagger-api/swagger-ui#2745 OpenAPI 3.0 requires that tooling support "at a minimum" commonMark 0.27 for markdown, and tables are not part of commonMark 0.27. It is not 100% clear to me if "at a minimum" relates to the commonMark version, or any superset of commonMark 0.27. Swagger/OpenAPI 2.0 supported GitHub-flavoured-markdown (gfm) which does support the pipe table syntax. Depending on your specific tooling, you may need to use html |
Ok great, thanks! 👍 I'll probably just use a list for now but I'll keep my eyes peeled for any updates. I'll close this issue. |
Hey @JoeScho, after quite some time I have noticed that in the API global description, top of the document, under info, the GitHub flavoured table is still not working but it is working under path > [http method] > description. Although I have used HTML table under info > description, I want to know whether it could be work in the same way as others are working? |
I noticed that it works everywhere when the multiline indicator is openapi: "3.0.0" |
In previous versions of swagger it was possible to add tables such as:
Running the following in the Swagger editor produces different results:
this one works
this one doesn't work
It would be great to have the feature brought across into OAS 3.0
Thanks!
The text was updated successfully, but these errors were encountered: