highsource / jaxb2-annotate-plugin

Add arbitrary annotations to JAXB classes.
Other
72 stars 28 forks source link

Swagger annotations #59

Open clemi2408 opened 4 years ago

clemi2408 commented 4 years ago

https://github.com/victools/jsonschema-generator/wiki#41-features the page states:

Set a field/method's "description" as per @ApiModelProperty(value = ...)

but properties are annotated like this: @ApiModelProperty(notes = "Email of the user", name = "email", value = "john@doe.com")

notes element of the annotation holds a description, and value an example for the range of that property.

the current implementation creates out of: @ApiModelProperty(notes = "Email of the user", name = "email", value = "john@doe.com")

the following schema: .. "email" : { "type" : "string", "description" : "john@doe.com", "pattern" : ".{0,0}|\\w+([-]\\w+)*( (\\w)+)+" } .. so the value is mapped to description instead of using the notes field.