OBP-API/src/main/scala/code/api/APIBuilder/apiResourceDoc/apisResource.json
2018-12-29 08:32:11 +01:00

64 lines
1.6 KiB
JSON

{
"resource_docs": [
{
"summary": "Get Template",
"request_verb": "GET",
"description": "Return one template. Authentication is Mandatory. ",
"request_url": "/my/templates/TEMPLATE_ID",
"example_request_body": {},
"success_response_body": {
"template": {
"author": "Chinua Achebe",
"pages": 209,
"points": 1.3
}
}
},
{
"summary": "Get Templates",
"request_verb": "GET",
"description": "Return All my templates. Authentication is Mandatory. ",
"request_url": "/my/templates",
"example_request_body": {},
"success_response_body": {
"templates": [
{
"author": "Chinua Achebe",
"pages": 209,
"points": 1.3
},
{
"author": "Hans Christian Andersen",
"pages": 784,
"points": 1.3
}
]
}
},
{
"summary": "Create Template",
"request_verb": "POST",
"description": "Create one template, Authentication is Mandatory ",
"request_url": "/my/templates",
"example_request_body": {
"author": "Chinua Achebe",
"pages": 209,
"points": 1.3
},
"success_response_body": {
"author": "Chinua Achebe",
"pages": 209,
"points": 1.3
}
},
{
"summary": "Delete Template",
"request_verb": "DELETE",
"description": "Delete a template by id. Authentication is Mandatory. ",
"request_url": "/my/templates/TEMPLATE_ID",
"example_request_body": {},
"success_response_body": true
}
]
}