sails-swagger icon indicating copy to clipboard operation
sails-swagger copied to clipboard

Parameters are missing in documentation.

Open akhare22sandeep opened this issue 9 years ago • 2 comments

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

akhare22sandeep avatar Jan 27 '16 21:01 akhare22sandeep

HI @akhare22sandeep , I am proposing an update as seen in this pull request https://github.com/tjwebb/sails-swagger/pull/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

gggordon avatar Mar 28 '16 21:03 gggordon

@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...

CodeJjang avatar Sep 19 '16 11:09 CodeJjang