KTOR-9255 Docs for JSON schema inference #752
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
bjhham
left a comment
bjhham
left a comment
There was a problem hiding this comment.
Sorry for the delay, I forgot to hit the button 🥲
| ### Customize schemas with annotations | ||
|
|
||
| You can override automatically generated JSON schema fields by adding annotations to your data classes: | ||
|
|
||
| ```kotlin | ||
| @JsonSchema.Description("Represents a news article") | ||
| data class Article( | ||
| val title: String, | ||
| val content: String | ||
| ) | ||
| ``` |
There was a problem hiding this comment.
Could you clarify that we're referring to these annotations?
Maybe it would be good to link to the KDocs for the full list of options.
There was a problem hiding this comment.
Good idea - added a link to the API docs.
2 participants
KTOR-9255
Add a new section in the OpenAPI spec gen topic for Schema inference. Mention how to use annotations and reflection-based schema inference when using Jackson and Gson.