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.

Sign up for GitHub

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

Jump to bottom

Show description for schema object fields and responses #45

Open
Maia-Everett opened this issue Apr 11, 2024 · 1 comment
Open

Show description for schema object fields and responses #45

Maia-Everett opened this issue Apr 11, 2024 · 1 comment

Comments

@Maia-Everett
Copy link

Maia-Everett commented Apr 11, 2024 •
edited
Loading

Hello! I'm using the OAD mkdocs plugin from https://github.com/Neoteroi/mkdocs-plugins.

It seems that for schema objects, only Name and Type columns are generated. Is it possible to also add a Description column for each object property?

Edit: Descriptions are not displayed for responses either.
@Maia-Everett Maia-Everett changed the title Add the description column to schema objects Show description for schema object fields and responses Apr 11, 2024
@RobertoPrevato
Copy link
Member

Hi @Maia-Everett
Thank You for reporting this issue, you are right it is best to display descriptions when they are available. I am looking into this.

RobertoPrevato added a commit that referenced this issue Apr 14, 2024
@RobertoPrevato
Fix #45
df79eae
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Maia-Everett @RobertoPrevato