[FIXED] How to set description to a field using swagger OpenAPI annotations

Issue

To improve our api documentation I want to add a description to a field of a response body

as an example see the default petstore spec here: https://editor.swagger.io/

In the POST /pet in the pet response, status has the description "pet status in the store"

How can I do this from an annotation perspective in my code base?

(swagger v3)

Solution

solution in kotlin:

data class Pet(
        @field:Schema(description = "Pet status in the store")
        val status: String
     )

Answered By - Viktor Baert
Answer Checked By - Gilberto Lyons (JavaFixing Admin)