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

Document path parameters outside "API Example:" section #17

Open
calebjones opened this issue Oct 6, 2011 · 2 comments
Open

Document path parameters outside "API Example:" section #17

calebjones opened this issue Oct 6, 2011 · 2 comments
Labels
Milestone

Comments

@calebjones
Copy link

Usually, path parameters are self-explanatory. However it is useful under certain circumstances or for verbosity to have each path parameter documented.

Currently the matching @param only shows up in the "API Example:" section. It would be great if a "Path Parameters:" section was added alongside the "Input:"/"Output:"/"Query parameters:"/etc. sections.

Note, the string name of the parameter inside @PathParam (ie: @PathParam("foo")) should just be for display purposes so java variables can be named whatever is appropriate.

@calebjones
Copy link
Author

Note, it appears at the top of the page. So perhaps this request is moot.

@FroMage
Copy link
Owner

FroMage commented Dec 12, 2011

Originally we had it there, but we moved it up because someone preferred it up. We can definitely make this optional, but I won't have time to do this right away. Patches welcome :)

@wikier wikier modified the milestones: 0.10.2, 0.10.1 Jul 11, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants