diff options
author | Bernhard Posselt <dev@bernhard-posselt.com> | 2016-04-26 21:35:38 +0200 |
---|---|---|
committer | Bernhard Posselt <dev@bernhard-posselt.com> | 2016-04-26 21:35:38 +0200 |
commit | 5fbe9b7287da80d23decc608982ef46ca8864722 (patch) | |
tree | 6e5ce2f175367ac8f7f80d3c422c8c9cac3c42bb /docs/api | |
parent | 2e9893e1da92e6f2f97f2419de4aa7fad1745e31 (diff) |
add type structures
Diffstat (limited to 'docs/api')
-rw-r--r-- | docs/api/v2/README.md | 59 |
1 files changed, 57 insertions, 2 deletions
diff --git a/docs/api/v2/README.md b/docs/api/v2/README.md index 6171019b6..5508d5597 100644 --- a/docs/api/v2/README.md +++ b/docs/api/v2/README.md @@ -250,7 +250,30 @@ The attributes mean the following: * **name**: Abitrary long text, folder's name ### Deleting A Folder -TBD +To delete a folder, use the following request: +* **Method**: DELETE +* **Route**: /folders/{id} +* **Route Parameters**: + * **{id}**: folder's id + +The following response is being returned: + +Status codes: +* **200**: Folder was deleted successfully +* **404**: Folder with given id was not found, no error object + +In case of an HTTP 200, the deleted folder is returned in full in the response, e.g.: + +```json +{ + "data": { + "folder": { + "id": 3, + "name": "funny stuff" + } + } +} +``` ### Creating A Folder TBD ### Changing A Folder @@ -291,7 +314,39 @@ The attributes mean the following: ### Deleting A Feed -TBD +To delete a feed, use the following request: +* **Method**: DELETE +* **Route**: /feeds/{id} +* **Route Parameters**: + * **{id}**: feed's id + +The following response is being returned: + +Status codes: +* **200**: Feed was deleted successfully +* **404**: Feed with given id was not found, no error object + +In case of an HTTP 200, the deleted feed is returned in full in the response, e.g.: + +```json +{ + "data": { + "feed": { + "id": 4, + "name": "The Oatmeal - Comics, Quizzes, & Stories", + "faviconLink": "http://theoatmeal.com/favicon.ico", + "folderId": 3, + "ordering": 0, + "isPinned": true, + "error": { + "code": 1, + "message": "" + } + } + } +} +``` + ### Creating A feed TBD ### Changing A Feed |