Show description for schema object fields and responses

Neoteroi / essentials-openapi

Functions to handle OpenAPI Documentation.

MIT License

21 stars 9 forks source link

Show description for schema object fields and responses #45

Open Maia-Everett opened 2 months ago

Maia-Everett commented 2 months ago

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.

RobertoPrevato commented 2 months ago

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.