Why Derive Macro utoipa::Component does not support field description

[shenopkss]

Hope support, Thank you very much!

[juhaku]

You probably mean that the fields of a Component which in turn are also Components does not retain the doc comment? In this case this is a duplicate to this one: #137. The thing is that the doc comments are supported for primitive types but for types that are Components it is not supported because of simply limitations of the OpenAPI 3.0 spec standard.

Yes that is not actually bug but unimplemented by desing. Since OpenAPI 3.0 version does not have description or summary in fields which are references to another components. See here https://swagger.io/specification/#reference-object. For each type having field of Component the OpenAPI represents them as a $ref which does not have the aforementioned values.

It's worth note that the Swagger UI does not support newer spec than 3.0 which in turn does not leave a room for an improvement untill the Swagger UI itself will start support the 3.1 spec standard.

[juhaku]

Closing due inactivity.