trabajo-afectivo/app/controllers/overviews_controller.rb

157 lines
2.3 KiB
Ruby
Raw Normal View History

2012-04-10 14:06:46 +00:00
class OverviewsController < ApplicationController
before_filter :authentication_check
=begin
2012-04-10 14:06:46 +00:00
Format:
JSON
2012-04-10 14:06:46 +00:00
Example:
{
"id":1,
"name":"some overview",
"meta":{"m_a":1,"m_b":2},
"condition":{"c_a":1,"c_b":2},
"order":{"o_a":1,"o_b":2},
"view":{"v_a":1,"v_b":2},
"user_id": null,
"role_id": null,
"updated_at":"2012-09-14T17:51:53Z",
"created_at":"2012-09-14T17:51:53Z",
"updated_by_id":2.
"created_by_id":2,
}
=end
2012-04-10 14:06:46 +00:00
=begin
2012-04-10 14:06:46 +00:00
Resource:
GET /api/overviews.json
2012-04-10 14:06:46 +00:00
Response:
[
{
"id": 1,
"name": "some_name1",
...
},
{
"id": 2,
"name": "some_name2",
...
}
]
Test:
curl http://localhost/api/overviews.json -v -u #{login}:#{password}
=end
def index
model_index_render(Overview, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
GET /api/overviews/#{id}.json
Response:
{
"id": 1,
"name": "name_1",
...
}
Test:
curl http://localhost/api/overviews/#{id}.json -v -u #{login}:#{password}
=end
def show
model_show_render(Overview, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
POST /api/overviews.json
Payload:
{
"name":"some overview",
"meta":{"m_a":1,"m_b":2},
"condition":{"c_a":1,"c_b":2},
"order":{"o_a":1,"o_b":2},
"view":{"v_a":1,"v_b":2},
"user_id": null,
"role_id": null,
}
Response:
{
"id": 1,
"name": "some_name",
...
}
Test:
curl http://localhost/api/overviews.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"name": "some_name","active": true, "note": "some note"}'
=end
2012-04-10 14:06:46 +00:00
def create
model_create_render(Overview, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
PUT /api/overviews/{id}.json
Payload:
{
"name":"some overview",
"meta":{"m_a":1,"m_b":2},
"condition":{"c_a":1,"c_b":2},
"order":{"o_a":1,"o_b":2},
"view":{"v_a":1,"v_b":2},
"user_id": null,
"role_id": null,
}
Response:
{
"id": 1,
"name": "some_name",
...
}
Test:
curl http://localhost/api/overviews.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"name": "some_name","active": true, "note": "some note"}'
=end
2012-04-10 14:06:46 +00:00
def update
model_update_render(Overview, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
DELETE /api/overviews/{id}.json
Response:
{}
2012-04-10 14:06:46 +00:00
Test:
curl http://localhost/api/overviews.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X DELETE
=end
def destroy
model_destory_render(Overview, params)
2012-04-10 14:06:46 +00:00
end
end