123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142 |
- # Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/
- class RolesController < ApplicationController
- prepend_before_action { authentication_check(permission: 'admin.role') }
- =begin
- Format:
- JSON
- Example:
- {
- "id":1,
- "name":"some role",
- "note":"some note",
- "updated_at":"2012-09-14T17:51:53Z",
- "created_at":"2012-09-14T17:51:53Z",
- "updated_by_id":2,
- "created_by_id":2,
- }
- =end
- =begin
- Resource:
- GET /api/v1/roles.json
- Response:
- [
- {
- "id": 1,
- "name": "some_name1",
- ...
- },
- {
- "id": 2,
- "name": "some_name2",
- ...
- }
- ]
- Test:
- curl http://localhost/api/v1/roles.json -v -u #{login}:#{password}
- =end
- def index
- model_index_render(Role, params)
- end
- =begin
- Resource:
- GET /api/v1/roles/#{id}.json
- Response:
- {
- "id": 1,
- "name": "name_1",
- ...
- }
- Test:
- curl http://localhost/api/v1/roles/#{id}.json -v -u #{login}:#{password}
- =end
- def show
- model_show_render(Role, params)
- end
- =begin
- Resource:
- POST /api/v1/roles.json
- Payload:
- {
- "name": "some name",
- "note": "",
- "active":true,
- }
- Response:
- {
- "id": 1,
- "name": "some_name",
- ...
- }
- Test:
- 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"}'
- =end
- def create
- model_create_render(Role, params)
- end
- =begin
- Resource:
- PUT /api/v1/roles/{id}.json
- Payload:
- {
- "name": "some name",
- "note": "",
- "active":true,
- }
- Response:
- {
- "id": 1,
- "name": "some_name",
- ...
- }
- Test:
- 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"}'
- =end
- def update
- model_update_render(Role, params)
- end
- =begin
- Resource:
- Response:
- Test:
- =end
- def destroy
- model_destroy_render(Role, params)
- end
- end
|