Scout has a powerful API that the front end application uses, but could also be scripted against or used by other third party integrations. In order to most effectively support these integrations, it's important to have complete documentation. All of the endpoints in controllers/servers.js and users.js are already complete, so those would make good examples.
The current scout docs are generated based off of block comments in the controllers. This is setup in app.js where you can view the instance URL and included files.
Add Swagger Docs to these Controllers:
devices.js (Excluding the Datatables endpoints)
commands.js
patches.js
reports.js
webhooks.js
Pull Request Ready When:
All of the above controllers have swagger docs that are accurate and useful.
Scout has a powerful API that the front end application uses, but could also be scripted against or used by other third party integrations. In order to most effectively support these integrations, it's important to have complete documentation. All of the endpoints in
controllers/servers.jsandusers.jsare already complete, so those would make good examples.The current scout docs are generated based off of block comments in the controllers. This is setup in app.js where you can view the instance URL and included files.
Add Swagger Docs to these Controllers:
devices.js(Excluding the Datatables endpoints)commands.jspatches.jsreports.jswebhooks.jsPull Request Ready When: