Request: Include documentation in objects and fields

[diamondburned]

Currently, the schema doesn't include any documentation at all. This would be a very nice addition for autogenerated documentation and code.

[mbialecka]

we agree :)

[diamondburned]

I think for starter, a requirement to link a table of the hand-written doc to a reference key within the OpenAPI documentation or vice versa would go a very long way without being too difficult. For example, Embed Image Structure could be linked to #/components/schemas/MessageEmbedImageResponse.

Or perhaps we could use some LLM AI to autogenerate the comments just by feeding it the documentation...