roles_controller.rb 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. # Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/
  2. class RolesController < ApplicationController
  3. prepend_before_action { authentication_check(permission: 'admin.role') }
  4. =begin
  5. Format:
  6. JSON
  7. Example:
  8. {
  9. "id":1,
  10. "name":"some role",
  11. "note":"some note",
  12. "updated_at":"2012-09-14T17:51:53Z",
  13. "created_at":"2012-09-14T17:51:53Z",
  14. "updated_by_id":2,
  15. "created_by_id":2,
  16. }
  17. =end
  18. =begin
  19. Resource:
  20. GET /api/v1/roles.json
  21. Response:
  22. [
  23. {
  24. "id": 1,
  25. "name": "some_name1",
  26. ...
  27. },
  28. {
  29. "id": 2,
  30. "name": "some_name2",
  31. ...
  32. }
  33. ]
  34. Test:
  35. curl http://localhost/api/v1/roles.json -v -u #{login}:#{password}
  36. =end
  37. def index
  38. model_index_render(Role, params)
  39. end
  40. =begin
  41. Resource:
  42. GET /api/v1/roles/#{id}.json
  43. Response:
  44. {
  45. "id": 1,
  46. "name": "name_1",
  47. ...
  48. }
  49. Test:
  50. curl http://localhost/api/v1/roles/#{id}.json -v -u #{login}:#{password}
  51. =end
  52. def show
  53. model_show_render(Role, params)
  54. end
  55. =begin
  56. Resource:
  57. POST /api/v1/roles.json
  58. Payload:
  59. {
  60. "name": "some name",
  61. "note": "",
  62. "active":true,
  63. }
  64. Response:
  65. {
  66. "id": 1,
  67. "name": "some_name",
  68. ...
  69. }
  70. Test:
  71. curl http://localhost/api/v1/roles.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"name": "some_name","active": true, "note": "some note"}'
  72. =end
  73. def create
  74. model_create_render(Role, params)
  75. end
  76. =begin
  77. Resource:
  78. PUT /api/v1/roles/{id}.json
  79. Payload:
  80. {
  81. "name": "some name",
  82. "note": "",
  83. "active":true,
  84. }
  85. Response:
  86. {
  87. "id": 1,
  88. "name": "some_name",
  89. ...
  90. }
  91. Test:
  92. curl http://localhost/api/v1/roles.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"name": "some_name","active": true, "note": "some note"}'
  93. =end
  94. def update
  95. model_update_render(Role, params)
  96. end
  97. =begin
  98. Resource:
  99. Response:
  100. Test:
  101. =end
  102. def destroy
  103. model_destroy_render(Role, params)
  104. end
  105. end