shareandcharge / sharecharge-api

HTTP webserver for the Share&Charge e-Mobility Network
0 stars 0 forks source link

the swagger documentation is incomplete #6

Closed AndreiD closed 6 years ago

AndreiD commented 6 years ago

running npm run document then -> http://localhost:3000/api/docs/#/ there are things missing PUT on locations, mint the token etc.

I guess it's because the functions are missing:

 /**
     * @api {get} /api/store/tariffs/:cpo get all tariffs by CPO
     * @apiName tariffs/:cpo
     * @apiGroup store
     * @apiHeader {String} Authorization Authorization Token value  
     * @apiParam {String} cpo The CPO ID of which the tariffs belong to
     * 
     * @apiDescription get all tariffs by CPO
    */ 

This is low priority, but nice-to-have.

AndreiD commented 6 years ago

also it would be nice to have examples for the payload used in POST / PUT methods....since they are not generated with the swagger docs