From 74a179b3c41596e23e8d31dd09236b60ccc765c8 Mon Sep 17 00:00:00 2001
From: Thorsten Eckel <te@znuny.com>
Date: Thu, 18 Dec 2014 16:12:36 +0100
Subject: [PATCH] Added Swagger YARD doc for user history get.

---
 app/controllers/users_controller.rb | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/app/controllers/users_controller.rb b/app/controllers/users_controller.rb
index 530c80769..e28f203a3 100644
--- a/app/controllers/users_controller.rb
+++ b/app/controllers/users_controller.rb
@@ -309,7 +309,19 @@ class UsersController < ApplicationController
     }
   end
 
-  # GET /api/v1/users/history/1
+  # @path       [GET] /users/history/{id}
+  #
+  # @tag History
+  # @tag User
+  #
+  # @summary          Returns the History of a User matching the given identifier.
+  # @notes            Requester has to be in role 'Admin' or 'Agent' to
+  #                   get the history of a User.
+  #
+  # @parameter        id(required) [Integer] The identifier matching the requested User.
+  #
+  # @response_message 200 [History] The History ressource of the requested User.
+  # @response_message 401           Invalid session.
   def history
 
     # permissin check