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

Response and request description not rendered. #69

Open
eo33 opened this issue Dec 7, 2024 · 0 comments
Open

Response and request description not rendered. #69

eo33 opened this issue Dec 7, 2024 · 0 comments

Comments

@eo33
Copy link

eo33 commented Dec 7, 2024

Hi everyone 👋 I'm trying to render my OpenAPI Spec (OAS) here in MKDocs-material. I've done some research and I found a plugin called neoteroi-mkdocs that I should be able to use to render my OAS file. I tried it and was able to render the OAS document by adding a [OAD(./oas/account.yaml)] in my Markdown file. However, it doesn't show the description of the request and response body in a table format. This is what it looks like:

image

I've also tried manually essentials-openapi that can convert OpenAPI document (OAD) to Markdown format using this command:

oad gen-docs -s "./oas/account.yaml" -d "./docs/output.md"

The command ran successfully and it created a Markdown file, but it is still not showing the response and request body in the table. This is my public repo: https://github.com/eo33/tfb_oas

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

1 participant