Add description to field

[josejachuf]

Hi
Is there any way to add a description of the fields of the structure?

Something similar to:

#[derive(ToSchema)]
struct Pet {
   id: u64,
   #[utoipa(desc = "this is my field description")]
   name: String,
   age: Option<i32>,
}

[juhaku]

Yes just add a doc comment for your field. Keep in mind that OpenAPI V3 does not support field descriptions on schema ref fields but only in primitive type fields.

#[derive(ToSchema)]
struct Pet {
   id: u64,
   /// This is my field description
   name: String,
   age: Option<i32>,
}

[josejachuf]

This works fine.
Thanks very much!