Hello if I copy the swagger specifications generated and pas

Question

Hello if I copy the swagger specifications generated and paste them in the swagger editor I get a lot of errors because fields description is null Any way to set them or not generate them if null or set then to empty string Ex of json generate par default project ```info title Test API version v1 0 description null tags paths contract api v1 echo post summary echoes the name and message sent to it description null tags contract api v1 parameters requestBody content application json example name jim message hello schema $ref components schemas NameAndMessage description null example null required true responses 200 description OK content application json example name jim message hello schema $ref components schemas NameAndMessage description null example null security api key operationId postContractApiV1Echo deprecated false components schemas NameAndMessage properties name example jim description null type string message example hello description null type string example name jim message hello description null type object required message name securitySchemes api key type apiKey in query name api openapi 3 0 0``` and the online editor <https editor swagger io >

dave · Answer

You can create a custom Jackson instance which doesn t serialise nulls and the use that to create the OpenApi3Renderer

Razvan · Answer

thanks shouldn t be the default for OpenApiRenderer Otherwise any way to add description to an object or and object fields

dave · Answer

``` inline fun lt reified T Any gt Body Companion auto description String = null contentNegotiation ContentNegotiation = None = autoBody lt T gt description contentNegotiation ```

dave · Answer

that s the Body extension method signature ^^

Razvan · Answer

Thanks sorry for not checking out by myself slightly smiling face you were right when you said if anything should be there check sources chances are it s there

Razvan · Answer

So that fix the comment on class but where should I look for the description of an element of a class or that s not supported

dave · Answer

you will need to add annotations to the models to get those descriptions to render ```JsonPropertyDescription```

Razvan · Answer

There s a particular setting for the lens description as i can t see the It s the name and the message in the generated json for ```val nameAndMessageLens = Body auto lt NameAndMessage gt description = It s the name and the message toLens ```

Razvan · Answer

and for the fields is disconcerting ```data class NameAndMessage JsonPropertyDescription It s the name val name String JsonPropertyDescription It s the message val message String ``` I get the descriptions if I use the default Jackson as param ```renderer = OpenApi3 ApiInfo Http4KPres API v1 0 Jackson ``` ``` name example jim description It s the name type string ``` but if i use a custom one that s exactly the same as the Jackson object ```val customJackson = ConfigurableJackson KotlinModule asConfigurable withStandardMappings done deactivateDefaultTyping configure DeserializationFeature FAIL ON UNKNOWN PROPERTIES false configure DeserializationFeature FAIL ON IGNORED PROPERTIES false configure DeserializationFeature USE BIG DECIMAL FOR FLOATS true configure DeserializationFeature USE BIG INTEGER FOR INTS true renderer = OpenApi3 ApiInfo Http4KPres API v1 0 customJackson ``` I get a null description ``` name example jim description null type string ```

dave · Answer

that s strange

dave · Answer

can you look to see if JacksonFieldMetadataRetrievalStrategy gets hit in the findName method

Razvan · Answer

Sorry out of my league wink can t figure out how to do that

Cosmin Victor Celea · Answer

Hei Razvan I had the some problems and i just wrote my custom Jackson as David is saying

Cosmin Victor Celea · Answer

I can share the code with you

Razvan · Answer

Thanks happy to see that Why that customJackson is not all right beside it misses the ` setSerializationInclusion JsonInclude Include NON NULL ` that i commented out just to see it it was that setting that removing the description from JsonPropertyDescription

Razvan · Answer

if that can help for testing the descriptions that does not appear with `Jackson` get description from JsonPropertyDescription with `CustomJackson` nope The Body auto description does not appear for neither ```data class NameAndMessage JsonPropertyDescription It s the name val name String JsonPropertyDescription It s the message val message String val nameAndMessageLens = Body auto lt NameAndMessage gt It s the name and the message toLens object ExampleContractRoute private val spec = echo meta summary = echoes the name and message sent to it description = This is a exemple that echoes the input string receiving nameAndMessageLens to NameAndMessage jim hello returning Status OK nameAndMessageLens to NameAndMessage jim hello bindContract <http Method POST|Method POST> private val echo HttpHandler = request Request gt val received NameAndMessage = nameAndMessageLens request Response Status OK with nameAndMessageLens of received operator fun invoke ContractRoute = spec to echo val app = routes contract api v1 bind contract renderer = OpenApi3 ApiInfo Http4KPres API v1 0 customJackson renderer = OpenApi3 ApiInfo Test API v1 0 Jackson descriptionPath = swagger json routes += ExampleContractRoute fun main DebuggingFilters PrintRequest then app asServer Undertow 9000 start object CustomJackson ConfigurableJackson KotlinModule asConfigurable withStandardMappings done deactivateDefaultTyping configure DeserializationFeature FAIL ON UNKNOWN PROPERTIES false configure DeserializationFeature FAIL ON IGNORED PROPERTIES false configure DeserializationFeature USE BIG DECIMAL FOR FLOATS true configure DeserializationFeature USE BIG INTEGER FOR INTS true setSerializationInclusion JsonInclude Include NON NULL ```