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

Possible to add descriptions to parameter documentation? #19

Open
brandonparsons opened this issue Jul 15, 2017 · 1 comment
Open

Possible to add descriptions to parameter documentation? #19

brandonparsons opened this issue Jul 15, 2017 · 1 comment

Comments

@brandonparsons
Copy link

maru_swagger is correctly capturing my parameters, but I'm wondering if there is a way to add descriptions to them such that it shows up in the generated API documentation?

@pablobcb
Copy link

pablobcb commented Jan 11, 2018

maybe this is doing the trick?

params do
        optional :my_field, type: String, desc: "here goes the description"
end

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

2 participants