Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@ExampleObject missing description #3341

Open
pioto opened this issue Oct 25, 2019 · 0 comments

Comments

@pioto
Copy link

@pioto pioto commented Oct 25, 2019

It seems that the @ExampleObject annotation doesn't provide a description field, as defined in https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#exampleObject

Instead, it seems to copy the name over as a description in the generated schema, which ends up looking weird.

If I'm reading things right, the fix should be to both add a String description() default "" to io.swagger.v3.oas.annotations.media.ExampleObject, and to adapt the schema generation to code to use this field, and default it to nothing instead of the name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.