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

Parameters are missing in documentation. #23

Open
akhare22sandeep opened this issue Jan 27, 2016 · 2 comments
Open

Parameters are missing in documentation. #23

akhare22sandeep opened this issue Jan 27, 2016 · 2 comments

Comments

@akhare22sandeep
Copy link

I have actions , shortcuts and rest set to false on few controllers and updated routes.js for each method action (custom routes).
Now when i generate the documents its not having any information about the parameters (query Parameters).
Am i missing something ? why my documentation is missing Parameters section for all custom methods.
Plus i would like to know how to get more information about models , properties and methods ?
where i need to put that metadata ?

Note : When I added query Parameter information in routes its working

@gggordon
Copy link
Contributor

HI @akhare22sandeep , I am proposing an update as seen in this pull request #26 where you can specify parameters, models and additional metadata.

It currently lives on this branch : https://github.com/gggordon/sails-swagger/tree/i-custom-definitions , let me know if that works for you

@CodeJjang
Copy link

CodeJjang commented Sep 19, 2016

@gggordon Sails defined a way to add query parameters to the custom route via pipe '|'.
Will your fork support that?? It'd be great.. Right now the module ignores it.

P.S tried installing your module and it fails...

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

3 participants