Skip to content

Instantly share code, notes, and snippets.

@Baggz Baggz/ast.json
Created Jan 8, 2014

Embed
What would you like to do?
{
"location": "http://www.google.com",
"name": "bubu",
"metadata": [],
"version": 7,
"description": "Notes API is a *short texts saving* service similar to its physical paper presence on your table.",
"htmlDescription": "<p>Notes API is a <em>short texts saving</em> service similar to its physical paper presence on your table.</p>\n",
"sections": [
{
"name": "Notes",
"description": "Notes related resources of the **Notes API**",
"htmlDescription": "<p>Notes related resources of the <strong>Notes API</strong></p>\n",
"resources": [
{
"method": "GET",
"url": "/notes",
"name": "Notes Collection",
"nameMethod": "List all Notes",
"actionName": "List all Notes",
"model": {},
"headers": {},
"actionHeaders": {},
"request": {
"headers": {}
},
"requests": [
{
"headers": {}
}
],
"responses": [
{
"status": "200",
"headers": {
"Content-Type": "application/json"
},
"body": "[{\n \"id\": 1, \"title\": \"Jogging in park\"\n}, {\n \"id\": 2, \"title\": \"Pick-up posters from post-office\"\n}]"
}
]
},
{
"method": "POST",
"url": "/notes",
"name": "Notes Collection",
"nameMethod": "Create a Note",
"actionName": "Create a Note",
"model": {},
"headers": {},
"actionHeaders": {},
"request": {
"headers": {
"Content-Type": "application/json"
},
"body": "{ \"title\": \"Buy cheese and bread for breakfast.\" }"
},
"requests": [
{
"headers": {
"Content-Type": "application/json"
},
"body": "{ \"title\": \"Buy cheese and bread for breakfast.\" }"
}
],
"responses": [
{
"status": "201",
"headers": {
"Content-Type": "application/json"
},
"body": "{ \"id\": 3, \"title\": \"Buy cheese and bread for breakfast.\" }"
}
]
},
{
"method": "GET",
"url": "/notes/{id}",
"name": "Note",
"nameMethod": "Retrieve a Note",
"actionName": "Retrieve a Note",
"descriptionMethod": "<p>A single Note object with all its details</p>\n",
"resourceDescription": "<p>A single Note object with all its details</p>\n",
"model": {},
"headers": {},
"actionHeaders": {},
"parameters": [
{
"key": "id",
"values": [],
"example": "1",
"default": "",
"required": true,
"type": "number",
"description": "<p>Numeric <code>id</code> of the Note to perform action with. Has example value.</p>\n"
}
],
"resourceParameters": [
{
"key": "id",
"values": [],
"example": "1",
"default": "",
"required": true,
"type": "number",
"description": "<p>Numeric <code>id</code> of the Note to perform action with. Has example value.</p>\n"
}
],
"request": {
"headers": {}
},
"requests": [
{
"headers": {}
}
],
"responses": [
{
"status": "200",
"headers": {
"X-My-Header": "The Value",
"Content-Type": "application/json"
},
"body": "{ \"id\": 2, \"title\": \"Pick-up posters from post-office\" }"
}
]
},
{
"method": "DELETE",
"url": "/notes/{id}",
"name": "Note",
"nameMethod": "Remove a Note",
"actionName": "Remove a Note",
"descriptionMethod": "<p>A single Note object with all its details</p>\n",
"resourceDescription": "<p>A single Note object with all its details</p>\n",
"model": {},
"headers": {},
"actionHeaders": {},
"parameters": [
{
"key": "id",
"values": [],
"example": "1",
"default": "",
"required": true,
"type": "number",
"description": "<p>Numeric <code>id</code> of the Note to perform action with. Has example value.</p>\n"
}
],
"resourceParameters": [
{
"key": "id",
"values": [],
"example": "1",
"default": "",
"required": true,
"type": "number",
"description": "<p>Numeric <code>id</code> of the Note to perform action with. Has example value.</p>\n"
}
],
"request": {
"headers": {}
},
"requests": [
{
"headers": {}
}
],
"responses": [
{
"status": "204",
"headers": {}
}
]
}
]
}
],
"validations": []
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.