Commit 7a4858dd by Marcus Efraimsson

docs: update folders api

parent 2835acf4
...@@ -19,6 +19,10 @@ The unique identifier (uid) of a folder can be used for uniquely identify folder ...@@ -19,6 +19,10 @@ The unique identifier (uid) of a folder can be used for uniquely identify folder
The uid can have a maximum length of 40 characters. The uid can have a maximum length of 40 characters.
## A note about the General folder
The General folder (id=0) is special and is not part of the Folder API which means
that you cannot use this API for retrieving information about the General folder.
## Get all folders ## Get all folders
...@@ -273,14 +277,14 @@ Status Codes: ...@@ -273,14 +277,14 @@ Status Codes:
## Get folder by id ## Get folder by id
`GET /api/folders/:id` `GET /api/folders/id/:id`
Will return the folder identified by id. Will return the folder identified by id.
**Example Request**: **Example Request**:
```http ```http
GET /api/folders/1 HTTP/1.1 GET /api/folders/id/1 HTTP/1.1
Accept: application/json Accept: application/json
Content-Type: application/json Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment