{ "path": "/twonks/:id", "description": "The most critical aspect.", "actions": [ { "description": "Retrieve a representation of an individual twonk.", "method": "GET", "authentication_required": false, "request": { "parameters": [ { "type": "path", "key": "id", "required": true, "description": "The ID of the desired twonk." }, { "type": "query", "key": "werp", "required": false, "default": 12, "description": "Self-explanatory." } ], "headers": [ { "key": "User-Agent", "description": "The thingy you're using." } ] }, "response": { "statuses": [ { "code": 200, "description": "The specified twonk was retrieved successfully." }, { "code": 404, "description": "A twonk with the specified ID could not be found." } ], "body": { "content_type": "application/json", "attributes": [ { "key": "name", "type": "string", "required": true, "description": "The name of the twonk." }, { "key": "created_by", "type": "object", "required": true, "description": "The short name of the user who created the twonk." } ] } } }, { "description": "Update a twonk.", "method": "PUT", "authentication_required": true, "request": { "parameters": [ { "type": "path", "key": "id", "required": true, "description": "The ID of the twonk to be updated." } ], "body": { "content_type": "application/x-www-form-urlencoded", "attributes": [ { "key": "name", "type": "string", "required": true, "description": "The name of the twonk." }, { "key": "hoinked_by", "type": "number", "required": false, "default": 3, "description": "The ID of the person who hoinked this twonk." } ] } }, "response": { "statuses": [ { "code": 201, "description": "The specified twonk was updated successfully." } ] } } ] }