[authentication] Adds token param in docs

PET-EC-Sobral · Jul 7, 2016 · b448727 · b448727
1 parent 8441af9
commit b448727
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/application/controllers/Bus.php b/application/controllers/Bus.php
@@ -4,7 +4,10 @@
 require APPPATH.'/libraries/Jsv4/Validator.php';
 require APPPATH.'/libraries/Jsv4/ValidationException.php';
 include( APPPATH.'controllers/Authentication.php' );
-
+/**
+ * @apiDefine tokenParam
+ * @apiHeader {String} Token Token do usuario que realizara a ação.
+ */
 class Bus extends Authentication {
 
     function loadModel(){
@@ -16,6 +19,8 @@ function loadModel(){
      * @apiGroup Bus
      * @apiPermission client
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} idRoute ID da rota onde se deseja requisitar os onibus.
      * @apiParam (Parametros de url) {Interger} localizations Se maior que 0, retorna os ônibus com suas n ultimas 
      *            localizações. Onde n = localizations. 
@@ -104,6 +109,8 @@ function getBuses($routeId){
      * @apiGroup Bus
      * @apiPermission client
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} idRoute ID da rota que contem o onibus que se requisita.
      * @apiParam {Integer} idBus ID do onibus solicitado.          
      * @apiParam (Parametros de url) {Interger} localizations Se maior que 0, retorna o ônibus com suas n ultimas 
@@ -167,6 +174,8 @@ function getBus($idRoute, $idBus){
      * @apiGroup Bus
      * @apiPermission client
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} idRoute ID da rota que contem o onibus que se requisita as localizações.
      * @apiParam {Integer} idBus ID do onibus que se requisita as localizações.
      *
@@ -223,6 +232,8 @@ function getLocalizations($idRoute, $idBus){
      * @apiGroup Bus
      * @apiPermission tracker
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} idRoute ID da rota que contem o onibus que será adicionada a localização.
      * @apiParam {Integer} idBus ID do onibus que será adicionada a localização.
      *
@@ -290,6 +301,8 @@ function addLocalization($idRoute, $idBus){
      * @apiGroup Bus
      * @apiPermission tracker
      *
+     * @apiUse tokenParam
+     *
      * @apiSuccess (201 - RouteCreated) {Integer} idBus ID unico do onibus criado.
      * @apiSuccess (201 - RouteCreated) {Integer} idRoute ID da rota em que o onibus foi criado.
      *
@@ -338,6 +351,8 @@ function addBus($idRoute){
      * @apiGroup Bus
      * @apiPermission tracker
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} idRoute ID da rota que contem o onibus.
      * @apiParam {Integer} idBus ID do onibus que se deseja apagar as localizações.
      *
@@ -376,6 +391,8 @@ function deleteLocalizations($idRoute, $idBus){
      * @apiGroup Bus
      * @apiPermission tracker
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} idRoute ID da rota que contem o onibus.
      * @apiParam {Integer} idBus ID do onibus que se deseja apagar.
      *

diff --git a/application/controllers/Routes.php b/application/controllers/Routes.php
@@ -5,7 +5,10 @@
 require APPPATH.'/libraries/Jsv4/Validator.php';
 require APPPATH.'/libraries/Jsv4/ValidationException.php';
 include( APPPATH.'controllers/Authentication.php' );
-
+/**
+ * @apiDefine tokenParam
+ * @apiHeader {String} Token Token do usuario que realizara a ação.
+ */
 class Routes extends Authentication {
 	private $routes = array();
 
@@ -18,6 +21,8 @@ function loadModel(){
      * @apiGroup Routes
      * @apiPermission client
      *
+     * @apiUse tokenParam
+     *
      * @apiParam (Parametros de url) {boolean} points Se false, retorna as rotas sem os pontos. 
      *           Se true, retorna com os pontos. Por padrão é false.
      * @apiExample Exemplo de uso:
@@ -88,6 +93,8 @@ function getRoutes(){
      * @apiGroup Routes
      * @apiPermission tracker
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {String} name Nome da rota a ser adicionada.
      * @apiParam {String} description Descrição da rota a ser adicionada.
      * @apiParam {array} points Conjuntos de pontos(coordenadas geográfica) que quando ligados formam a rota a ser adicionada. 
@@ -162,6 +169,7 @@ function updateRoute($id){
      * @apiGroup Routes
      * @apiPermission client
      *
+     * @apiUse tokenParam
      *
      * @apiSuccess {Integer} id_routes ID unico da rota.
      * @apiSuccess {String} name  Nome da rota.
@@ -236,6 +244,8 @@ function addIdBuses($route){
      * @apiGroup Routes
      * @apiPermission client
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} id ID da rota que se requisita os pontos.
      * @apiSuccess {array} points Pontos com latidute e longitude que formam a rota.
      *
@@ -288,6 +298,8 @@ function getPoints($id){
      * @apiGroup Routes
      * @apiPermission tracker
      *
+     * @apiUse tokenParam
+     *
      * @apiParam {Integer} id ID da rota a ser deletada.
      * @apiSuccess (204 - RouteDeleted) {Integer} id ID da rota deletada.
      * @apiError (404 - RouteNotFound) {Interger} id ID da rota requisitada não encontrado.