adds docs
This commit is contained in:
Christian Beutel
Binary file not shown.
|
Before Width: | Height: | Size: 300 KiB After Width: | Height: | Size: 6.6 MiB |
BIN
docs/src/assets/guides/wanderer_lists_edit.png
Normal file
BIN
docs/src/assets/guides/wanderer_lists_edit.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 MiB |
391
docs/src/content/docs/api-reference/list-share.md
Normal file
391
docs/src/content/docs/api-reference/list-share.md
Normal file
@@ -0,0 +1,391 @@
|
||||
---
|
||||
title: list-share
|
||||
---
|
||||
|
||||
## GET show
|
||||
|
||||
GET /list-share/{id}
|
||||
|
||||
### Params
|
||||
|
||||
|Name|Location|Type|Required|Description|
|
||||
|---|---|---|---|---|
|
||||
|id|path|string| yes |none|
|
||||
|
||||
> Response Examples
|
||||
|
||||
> 200 Response
|
||||
|
||||
```json
|
||||
{
|
||||
"collectionId": "string",
|
||||
"collectionName": "string",
|
||||
"created": "2019-08-24T14:15:22Z",
|
||||
"id": "string",
|
||||
"permission": "view",
|
||||
"list": "string",
|
||||
"updated": "2019-08-24T14:15:22Z",
|
||||
"user": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Responses
|
||||
|
||||
|HTTP Status Code |Meaning|Description|Data schema|
|
||||
|---|---|---|---|
|
||||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
||||
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|none|Inline|
|
||||
|
||||
### Responses Data Schema
|
||||
|
||||
HTTP Status Code **200**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» collectionId|string|true|none||none|
|
||||
|» collectionName|string|true|none||none|
|
||||
|» created|string(date-time)|true|none||none|
|
||||
|» id|string|true|none||none|
|
||||
|» permission|string|true|none||none|
|
||||
|» list|string|true|none||none|
|
||||
|» updated|string(date-time)|true|none||none|
|
||||
|» user|string|true|none||none|
|
||||
|
||||
#### Enum
|
||||
|
||||
|Name|Value|
|
||||
|---|---|
|
||||
|permission|view|
|
||||
|permission|edit|
|
||||
|
||||
HTTP Status Code **404**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» url|string|true|none||none|
|
||||
|» status|integer|true|none||none|
|
||||
|» response|object|true|none||none|
|
||||
|»» code|integer|true|none||none|
|
||||
|»» message|string|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|» isAbort|boolean|true|none||none|
|
||||
|» originalError|object|true|none||none|
|
||||
|»» url|string|true|none||none|
|
||||
|»» status|integer|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|»»» code|integer|true|none||none|
|
||||
|»»» message|string|true|none||none|
|
||||
|»»» data|object|true|none||none|
|
||||
|» name|string|true|none||none|
|
||||
|
||||
## POST update
|
||||
|
||||
POST /list-share/{id}
|
||||
|
||||
> Body Parameters
|
||||
|
||||
```json
|
||||
{
|
||||
"list": "string",
|
||||
"user": "string",
|
||||
"permission": "view"
|
||||
}
|
||||
```
|
||||
|
||||
### Params
|
||||
|
||||
|Name|Location|Type|Required|Description|
|
||||
|---|---|---|---|---|
|
||||
|id|path|string| yes |none|
|
||||
|Content-Type|header|string| yes |none|
|
||||
|body|body|object| no |none|
|
||||
|» list|body|string| yes |none|
|
||||
|» user|body|string| yes |none|
|
||||
|» permission|body|string| yes |none|
|
||||
|
||||
#### Enum
|
||||
|
||||
|Name|Value|
|
||||
|---|---|
|
||||
|» permission|view|
|
||||
|» permission|edit|
|
||||
|
||||
> Response Examples
|
||||
|
||||
> 200 Response
|
||||
|
||||
```json
|
||||
{
|
||||
"collectionId": "string",
|
||||
"collectionName": "string",
|
||||
"created": "2019-08-24T14:15:22Z",
|
||||
"id": "string",
|
||||
"permission": "view",
|
||||
"list": "string",
|
||||
"updated": "2019-08-24T14:15:22Z",
|
||||
"user": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Responses
|
||||
|
||||
|HTTP Status Code |Meaning|Description|Data schema|
|
||||
|---|---|---|---|
|
||||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
||||
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|none|Inline|
|
||||
|
||||
### Responses Data Schema
|
||||
|
||||
HTTP Status Code **200**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» collectionId|string|true|none||none|
|
||||
|» collectionName|string|true|none||none|
|
||||
|» created|string(date-time)|true|none||none|
|
||||
|» id|string|true|none||none|
|
||||
|» permission|string|true|none||none|
|
||||
|» list|string|true|none||none|
|
||||
|» updated|string(date-time)|true|none||none|
|
||||
|» user|string|true|none||none|
|
||||
|
||||
#### Enum
|
||||
|
||||
|Name|Value|
|
||||
|---|---|
|
||||
|permission|view|
|
||||
|permission|edit|
|
||||
|
||||
HTTP Status Code **404**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» url|string|true|none||none|
|
||||
|» status|integer|true|none||none|
|
||||
|» response|object|true|none||none|
|
||||
|»» code|integer|true|none||none|
|
||||
|»» message|string|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|» isAbort|boolean|true|none||none|
|
||||
|» originalError|object|true|none||none|
|
||||
|»» url|string|true|none||none|
|
||||
|»» status|integer|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|»»» code|integer|true|none||none|
|
||||
|»»» message|string|true|none||none|
|
||||
|»»» data|object|true|none||none|
|
||||
|» name|string|true|none||none|
|
||||
|
||||
## GET list
|
||||
|
||||
GET /list-share
|
||||
|
||||
> Response Examples
|
||||
|
||||
> 200 Response
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"collectionId": "string",
|
||||
"collectionName": "string",
|
||||
"created": "string",
|
||||
"id": "string",
|
||||
"list": "string",
|
||||
"permission": "string",
|
||||
"updated": "string",
|
||||
"user": "string",
|
||||
"expand": {
|
||||
"user": {
|
||||
"avatar": "string",
|
||||
"collectionId": "string",
|
||||
"collectionName": "string",
|
||||
"id": "string",
|
||||
"username": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Responses
|
||||
|
||||
|HTTP Status Code |Meaning|Description|Data schema|
|
||||
|---|---|---|---|
|
||||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
||||
|
||||
### Responses Data Schema
|
||||
|
||||
HTTP Status Code **200**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» collectionId|string|false|none||none|
|
||||
|» collectionName|string|false|none||none|
|
||||
|» created|string|false|none||none|
|
||||
|» id|string|false|none||none|
|
||||
|» list|string|false|none||none|
|
||||
|» permission|string|false|none||none|
|
||||
|» updated|string|false|none||none|
|
||||
|» user|string|false|none||none|
|
||||
|» expand|object|false|none||none|
|
||||
|»» user|object|true|none||none|
|
||||
|»»» avatar|string|true|none||none|
|
||||
|»»» collectionId|string|true|none||none|
|
||||
|»»» collectionName|string|true|none||none|
|
||||
|»»» id|string|true|none||none|
|
||||
|»»» username|string|true|none||none|
|
||||
|
||||
## DELETE delete
|
||||
|
||||
DELETE /list-share/{id}
|
||||
|
||||
### Params
|
||||
|
||||
|Name|Location|Type|Required|Description|
|
||||
|---|---|---|---|---|
|
||||
|id|path|string| yes |none|
|
||||
|
||||
> Response Examples
|
||||
|
||||
> 200 Response
|
||||
|
||||
```json
|
||||
{
|
||||
"acknowledged": true
|
||||
}
|
||||
```
|
||||
|
||||
### Responses
|
||||
|
||||
|HTTP Status Code |Meaning|Description|Data schema|
|
||||
|---|---|---|---|
|
||||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
||||
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|none|Inline|
|
||||
|
||||
### Responses Data Schema
|
||||
|
||||
HTTP Status Code **200**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» acknowledged|boolean|true|none||none|
|
||||
|
||||
HTTP Status Code **404**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» url|string|true|none||none|
|
||||
|» status|integer|true|none||none|
|
||||
|» response|object|true|none||none|
|
||||
|»» code|integer|true|none||none|
|
||||
|»» message|string|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|» isAbort|boolean|true|none||none|
|
||||
|» originalError|object|true|none||none|
|
||||
|»» url|string|true|none||none|
|
||||
|»» status|integer|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|»»» code|integer|true|none||none|
|
||||
|»»» message|string|true|none||none|
|
||||
|»»» data|object|true|none||none|
|
||||
|» name|string|true|none||none|
|
||||
|
||||
## PUT create
|
||||
|
||||
PUT /list-share
|
||||
|
||||
> Body Parameters
|
||||
|
||||
```json
|
||||
{
|
||||
"list": "string",
|
||||
"user": "string",
|
||||
"permission": "view"
|
||||
}
|
||||
```
|
||||
|
||||
### Params
|
||||
|
||||
|Name|Location|Type|Required|Description|
|
||||
|---|---|---|---|---|
|
||||
|body|body|object| no |none|
|
||||
|» list|body|string| yes |none|
|
||||
|» user|body|string| yes |none|
|
||||
|» permission|body|string| yes |none|
|
||||
|
||||
#### Enum
|
||||
|
||||
|Name|Value|
|
||||
|---|---|
|
||||
|» permission|view|
|
||||
|» permission|edit|
|
||||
|
||||
> Response Examples
|
||||
|
||||
> 200 Response
|
||||
|
||||
```json
|
||||
{
|
||||
"collectionId": "string",
|
||||
"collectionName": "string",
|
||||
"created": "2019-08-24T14:15:22Z",
|
||||
"id": "string",
|
||||
"permission": "view",
|
||||
"list": "string",
|
||||
"updated": "2019-08-24T14:15:22Z",
|
||||
"user": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Responses
|
||||
|
||||
|HTTP Status Code |Meaning|Description|Data schema|
|
||||
|---|---|---|---|
|
||||
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
|
||||
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|none|Inline|
|
||||
|
||||
### Responses Data Schema
|
||||
|
||||
HTTP Status Code **200**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» collectionId|string|true|none||none|
|
||||
|» collectionName|string|true|none||none|
|
||||
|» created|string(date-time)|true|none||none|
|
||||
|» id|string|true|none||none|
|
||||
|» permission|string|true|none||none|
|
||||
|» list|string|true|none||none|
|
||||
|» updated|string(date-time)|true|none||none|
|
||||
|» user|string|true|none||none|
|
||||
|
||||
#### Enum
|
||||
|
||||
|Name|Value|
|
||||
|---|---|
|
||||
|permission|view|
|
||||
|permission|edit|
|
||||
|
||||
HTTP Status Code **400**
|
||||
|
||||
|Name|Type|Required|Restrictions|Title|description|
|
||||
|---|---|---|---|---|---|
|
||||
|» url|string|true|none||none|
|
||||
|» status|integer|true|none||none|
|
||||
|» response|object|true|none||none|
|
||||
|»» code|integer|true|none||none|
|
||||
|»» message|string|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|» isAbort|boolean|true|none||none|
|
||||
|» originalError|object|true|none||none|
|
||||
|»» url|string|true|none||none|
|
||||
|»» status|integer|true|none||none|
|
||||
|»» data|object|true|none||none|
|
||||
|»»» code|integer|true|none||none|
|
||||
|»»» message|string|true|none||none|
|
||||
|»»» data|object|true|none||none|
|
||||
|» name|string|true|none||none|
|
||||
|
||||
# Data Schema
|
||||
|
||||
@@ -3,18 +3,27 @@ title: Lists
|
||||
description: What are lists and how can we use them?
|
||||
---
|
||||
|
||||
Lists allow you to further organise your trails by bundling them in one place. Over at `/lists` you can create, update, and delete your custom lists. You can view all trails in a list either on a map or in a simple list.
|
||||
Lists allow you to further organise your trails by bundling them in one place. Over at `/lists` you can create, update, share and delete your custom lists.
|
||||
|
||||
|
||||
|
||||
## Create a list
|
||||
|
||||
Simply click the `+ Create new list` button and give your list a name. Optionally, you can also add an avatar and a short description.
|
||||
Simply click the <button class="h-10 text-white rounded-lg px-4 py-2 mx-2 bg-primary font-semibold transition-all hover:bg-primary-hover focus:ring-4 ring-zinc-400 leading-none">+ New List</button> button. You will be redirected to the editor where you can give your list a name and add one or more trails to it. Optionally, you can also add an avatar and a short description.
|
||||
|
||||
## Add a trail
|
||||
To add a trail to the list simply search for it and click on the search suggestion. After adding a trail you can change its position in the list using the up- and down arrows.
|
||||
|
||||
To add a trail to a list head over to `/trails` and click on the trail you want to add. From the ⋮ menu select "Add to list" and select the list you want to add the trail to. To remove the trail simply repeat this process.
|
||||
Once you are done creating your list simply click the <button class="h-10 text-white rounded-lg px-4 py-2 mx-2 bg-primary font-semibold transition-all hover:bg-primary-hover focus:ring-4 ring-zinc-400 leading-none">Save List</button> button at the bottom.
|
||||
|
||||
|
||||
|
||||
## Share a list
|
||||
You can also share a list to allow other users access it. To do so select the list in the overview and click "Share" in the ⋮ menu. Everything else works analogous to <a href="/guides/share-trails#share-a-trail">sharing a trail</a>. Depending on the permission you set for the shared list a user can simply view the list or also modify its contents.
|
||||
|
||||
:::caution
|
||||
Sharing a list with another user will also automatically share all trails contained in that list with the user. Unsharing a list will _not_ automatically unshare all trails contained in the list.
|
||||
:::
|
||||
|
||||
## Edit & delete a list
|
||||
|
||||
To edit or delete a list simply select the respective entry from the ⋮ menu.
|
||||
To edit or delete a list first select it from the overview. Then you can select the respective entry from the ⋮ menu.
|
||||
Reference in New Issue
Block a user