From d60765880f788d6af932fc3c6f81f1928b07f95e Mon Sep 17 00:00:00 2001 From: Frederic Merizen Date: Fri, 16 Mar 2018 10:10:43 +0100 Subject: [PATCH] Fix authentication token description --- app/controllers/api/v1/dossiers_controller.rb | 4 ++++ .../api/v1/procedures_controller.rb | 4 ++++ app/controllers/api_controller.rb | 18 ++++++++---------- 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/app/controllers/api/v1/dossiers_controller.rb b/app/controllers/api/v1/dossiers_controller.rb index e4a09dc02..b275f41b2 100644 --- a/app/controllers/api/v1/dossiers_controller.rb +++ b/app/controllers/api/v1/dossiers_controller.rb @@ -1,6 +1,10 @@ class API::V1::DossiersController < APIController DEFAULT_PAGE_SIZE = 100 + resource_description do + description AUTHENTICATION_TOKEN_DESCRIPTION + end + api :GET, '/procedures/:procedure_id/dossiers/', 'Liste de tous les dossiers d\'une procédure' param :procedure_id, Integer, desc: "L'identifiant de la procédure", required: true param :page, String, desc: "Numéro de la page", required: false diff --git a/app/controllers/api/v1/procedures_controller.rb b/app/controllers/api/v1/procedures_controller.rb index a51e2cd97..f983b9d21 100644 --- a/app/controllers/api/v1/procedures_controller.rb +++ b/app/controllers/api/v1/procedures_controller.rb @@ -1,4 +1,8 @@ class API::V1::ProceduresController < APIController + resource_description do + description AUTHENTICATION_TOKEN_DESCRIPTION + end + api :GET, '/procedures/:id', 'Informations concernant une procédure' param :id, Integer, desc: "L'identifiant de la procédure", required: true error code: 401, desc: "Non authorisé" diff --git a/app/controllers/api_controller.rb b/app/controllers/api_controller.rb index 8e30824e2..d1ab966a5 100644 --- a/app/controllers/api_controller.rb +++ b/app/controllers/api_controller.rb @@ -1,17 +1,15 @@ class APIController < ApplicationController + AUTHENTICATION_TOKEN_DESCRIPTION = <<-EOS + L'authentification de l'API se fait via un header HTTP : + + ``` + Authorization: Bearer <Token administrateur> + ``` + EOS + before_action :authenticate_user before_action :default_format_json - resource_description do - description <<-EOS - L'authentification de l'API se fait via un header HTTP : - - ``` - Authorization: Bearer <Token administrateur> - ``` - EOS - end - def authenticate_user if !valid_token? request_http_token_authentication