trabajo-afectivo/app/controllers/text_modules_controller.rb

151 lines
2.2 KiB
Ruby
Raw Normal View History

2014-02-03 19:24:49 +00:00
# Copyright (C) 2012-2014 Zammad Foundation, http://zammad-foundation.org/
2012-10-22 13:00:26 +00:00
class TextModulesController < ApplicationController
before_filter :authentication_check
=begin
Format:
JSON
Example:
{
"id":1,
"name":"some text_module",
"user_id": null,
"keywords":"some keywords",
"content":"some content",
"active":true,
"updated_at":"2012-09-14T17:51:53Z",
"created_at":"2012-09-14T17:51:53Z",
"updated_by_id":2.
"created_by_id":2,
}
2012-10-22 13:00:26 +00:00
=end
=begin
Resource:
GET /api/v1/text_modules.json
2012-10-22 13:00:26 +00:00
Response:
[
{
"id": 1,
"name": "some_name1",
...
},
{
"id": 2,
"name": "some_name2",
...
}
]
Test:
curl http://localhost/api/v1/text_modules.json -v -u #{login}:#{password}
2012-10-22 13:00:26 +00:00
=end
def index
model_index_render(TextModule, params)
end
=begin
Resource:
GET /api/v1/text_modules/#{id}.json
2012-10-22 13:00:26 +00:00
Response:
{
"id": 1,
"name": "name_1",
...
}
Test:
curl http://localhost/api/v1/text_modules/#{id}.json -v -u #{login}:#{password}
2012-10-22 13:00:26 +00:00
=end
def show
model_show_render(TextModule, params)
end
=begin
Resource:
POST /api/v1/text_modules.json
2012-10-22 13:00:26 +00:00
Payload:
{
"name": "some name",
"keywords":"some keywords",
"content":"some content",
"active":true,
}
Response:
{
"id": 1,
"name": "some_name",
...
}
Test:
curl http://localhost/api/v1/text_modules.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"name": "some_name","active": true, "note": "some note"}'
2012-10-22 13:00:26 +00:00
=end
def create
model_create_render(TextModule, params)
end
=begin
Resource:
PUT /api/v1/text_modules/{id}.json
2012-10-22 13:00:26 +00:00
Payload:
{
"name": "some name",
"keywords":"some keywords",
"content":"some content",
"active":true,
}
Response:
{
"id": 1,
"name": "some_name",
...
}
Test:
curl http://localhost/api/v1/text_modules.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"name": "some_name","active": true, "note": "some note"}'
2012-10-22 13:00:26 +00:00
=end
def update
model_update_render(TextModule, params)
end
=begin
Resource:
DELETE /api/v1/text_modules/{id}.json
2012-10-22 13:00:26 +00:00
Response:
{}
Test:
curl http://localhost/api/v1/text_modules.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X DELETE
2012-10-22 13:00:26 +00:00
=end
def destroy
model_destory_render(TextModule, params)
end
end