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

RequestParam#name() ignored #239

Closed
rtomsick opened this Issue Jul 19, 2017 · 1 comment

Comments

Projects
None yet
2 participants
@rtomsick

rtomsick commented Jul 19, 2017

Description

It appears that JSONDoc is ignoring the name attribute of the RequestParam annotation. The value attribute works as expected, despite the former being an alias for the latter.

Steps to reproduce

Attempt to generate documentation for a method like the following

@RequestMapping(value = "")
public void
authenticate(@RequestParam("username") String username, 
				@RequestParam("password") String password, 
				@RequestParam(required = false, name = "source") 
				String source)
throws IOException {/* ... */}

Expected outcome

The three query parameters ("username", "password", "source") are present in the resulting documentation.

Actual outcome

"source" is not present in the resulting documentation, instead the parameter is shown with no name, and the following error is present in a notice above the parameter descriptions: "- Missing documentation data: query parameter name"

Suggested resolution

Treat value and name as synonyms, since that is what Spring does.

@fabiomaffioletti

This comment has been minimized.

Show comment
Hide comment
@fabiomaffioletti

fabiomaffioletti Nov 20, 2017

Owner

Solved with #236

Owner

fabiomaffioletti commented Nov 20, 2017

Solved with #236

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment