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

Swagger annotations #59

Open
clemi2408 opened this issue Jun 2, 2020 · 0 comments
Open

Swagger annotations #59

clemi2408 opened this issue Jun 2, 2020 · 0 comments

Comments

@clemi2408
Copy link

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 = "[email protected]")

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 = "[email protected]")

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant