brian/wanderer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updates docs with openAPI yaml

Browse Source
This commit is contained in:
Christian Beutel
2025-01-03 17:07:32 +01:00
parent 7e0276aecb
commit 9887874ad7
22 changed files with 31844 additions and 6537 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/astro.config.mjs
View File

@@ -4,6 +4,7 @@ import tailwind from '@astrojs/tailwind';
import node from "@astrojs/node"; import node from "@astrojs/node";
import starlightOpenAPI, { openAPISidebarGroups } from 'starlight-openapi'
// https://astro.build/config // https://astro.build/config
export default defineConfig({ export default defineConfig({
integrations: [starlight({ integrations: [starlight({
@@ -19,6 +20,15 @@ export default defineConfig({
components: { components: {
Footer: './src/components/footer.astro' Footer: './src/components/footer.astro'
}, },
plugins: [
starlightOpenAPI([
{
base: 'api-reference',
label: 'API Reference',
schema: 'wanderer.openapi.yaml',
},
]),
],
sidebar: [{ sidebar: [{
label: 'Getting Started', label: 'Getting Started',
items: [{ items: [{
@@ -68,12 +78,8 @@ export default defineConfig({
label: 'API', label: 'API',
link: '/guides/api/' link: '/guides/api/'
}] }]
}, { },
label: 'API Reference', ...openAPISidebarGroups,],
autogenerate: {
directory: 'api-reference'
}
}],
customCss: ['./src/custom.css', './src/tailwind.css', '@fontsource/ibm-plex-sans/400.css', '@fontsource/ibm-plex-sans/600.css', '@fontsource/ibm-plex-mono/400.css', '@fontsource/ibm-plex-mono/600.css'] customCss: ['./src/custom.css', './src/tailwind.css', '@fontsource/ibm-plex-sans/400.css', '@fontsource/ibm-plex-sans/600.css', '@fontsource/ibm-plex-mono/400.css', '@fontsource/ibm-plex-mono/600.css']
}), tailwind({ }), tailwind({
applyBaseStyles: false applyBaseStyles: false

5427
docs/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

15
docs/package.json
View File

@@ -10,16 +10,17 @@
"astro": "astro" "astro": "astro"
}, },
"dependencies": { "dependencies": {
"@astrojs/check": "^0.7.0", "@astrojs/check": "^0.9.4",
"@astrojs/node": "^8.2.6", "@astrojs/node": "^9.0.0",
"@astrojs/starlight": "^0.24.0", "@astrojs/starlight": "^0.30.3",
"@astrojs/starlight-tailwind": "^2.0.3", "@astrojs/starlight-tailwind": "^3.0.0",
"@astrojs/tailwind": "^5.1.0", "@astrojs/tailwind": "^5.1.3",
"@fontsource/ibm-plex-mono": "^5.0.13", "@fontsource/ibm-plex-mono": "^5.0.13",
"@fontsource/ibm-plex-sans": "^5.0.20", "@fontsource/ibm-plex-sans": "^5.0.20",
"astro": "^4.8.6", "astro": "^5.0.2",
"sharp": "^0.32.5", "sharp": "^0.32.5",
"tailwindcss": "^3.4.1", "starlight-openapi": "^0.9.0",
"tailwindcss": "^3.4.4",
"typescript": "^5.4.5" "typescript": "^5.4.5"
} }
} }

BIN
docs/src/assets/hero.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 984 KiB

After

Width:  |  Height:  |  Size: 1.3 MiB

2
docs/src/components/footer.astro
View File

@@ -124,7 +124,7 @@ const isNotHomepage = Astro.props.slug !== "";
</a> </a>
</li> </li>
<li> <li>
<a href="/api-reference/auth">API Reference</a> <a href="/api-reference">API Reference</a>
</li> </li>
<li> <li>
<a href="https://pocketbase.io/">PocketBase</a> <a href="https://pocketbase.io/">PocketBase</a>

110
docs/src/content/docs/api-reference/auth.md
View File

@@ -1,110 +0,0 @@
---
title: auth
---
# auth
## POST login
POST /auth/login
> Body Parameters
```json
{
"username": "string",
"password": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» username|body|string| yes |none|
|» password|body|string| yes |none|
> Response Examples
> 200 Response
```json
{
"record": {
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"email": "string",
"emailVisibility": true,
"id": "string",
"language": "string",
"location": {
"lat": 0,
"lon": 0,
"name": "string"
},
"token": "string",
"unit": "string",
"updated": "string",
"username": "string",
"verified": true
},
"token": "string"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» record|object|true|none||none|
|»» avatar|string|true|none||none|
|»» collectionId|string|true|none||none|
|»» collectionName|string|true|none||none|
|»» created|string|true|none||none|
|»» email|string|true|none||none|
|»» emailVisibility|boolean|true|none||none|
|»» id|string|true|none||none|
|»» language|string|true|none||none|
|»» location|object|true|none||none|
|»»» lat|number|true|none||none|
|»»» lon|number|true|none||none|
|»»» name|string|true|none||none|
|»» token|string|true|none||none|
|»» unit|string|true|none||none|
|»» updated|string|true|none||none|
|»» username|string|true|none||none|
|»» verified|boolean|true|none||none|
|» token|string|true|none||none|
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|

45
docs/src/content/docs/api-reference/category.md
View File

@@ -1,45 +0,0 @@
---
title: category
---
## GET list
GET /category
> Response Examples
> 200 Response
```json
[
{
"collectionId": "string",
"collectionName": "string",
"created": "string",
"id": "string",
"img": "string",
"name": "string",
"updated": "string"
}
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|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|true|none||none|
|» id|string|true|none||none|
|» img|string|true|none||none|
|» name|string|true|none||none|
|» updated|string|true|none||none|

401
docs/src/content/docs/api-reference/comment.md
View File

@@ -1,401 +0,0 @@
---
title: comment
---
## GET show
GET /comment/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"expand": {
"author": {
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"email": "string",
"emailVisibility": true,
"id": "string",
"token": "string",
"updated": "string",
"username": "string",
"verified": true
}
},
"id": "string",
"rating": 0,
"text": "string",
"trail": "string",
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» expand|object|true|none||none|
|»» author|object|true|none||none|
|»»» avatar|string|true|none||none|
|»»» collectionId|string|true|none||none|
|»»» collectionName|string|true|none||none|
|»»» created|string|true|none||none|
|»»» email|string|true|none||none|
|»»» emailVisibility|boolean|true|none||none|
|»»» id|string|true|none||none|
|»»» token|string|true|none||none|
|»»» updated|string|true|none||none|
|»»» username|string|true|none||none|
|»»» verified|boolean|true|none||none|
|» id|string|true|none||none|
|» rating|integer|true|none||none|
|» text|string|true|none||none|
|» trail|string|true|none||none|
|» updated|string(date-time)|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|
## POST update
POST /comment/{id}
> Body Parameters
```json
{
"text": "string",
"trail": "string",
"author": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» text|body|string| yes |none|
|» trail|body|string| yes |none|
|» author|body|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"id": "string",
"rating": 0,
"text": "string",
"trail": "string",
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» id|string|true|none||none|
|» rating|integer|true|none||none|
|» text|string|true|none||none|
|» trail|string|true|none||none|
|» updated|string(date-time)|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|
## DELETE delete
DELETE /comment/{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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
## GET list
GET /comment
> Response Examples
> 200 Response
```json
[
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"expand": {
"author": {
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"email": "string",
"emailVisibility": true,
"id": "string",
"token": "string",
"updated": "string",
"username": "string",
"verified": true
}
},
"id": "string",
"rating": 0,
"text": "string",
"trail": "string",
"updated": "string"
}
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string|true|none||none|
|» expand|object|true|none||none|
|»» author|object|true|none||none|
|»»» avatar|string|true|none||none|
|»»» collectionId|string|true|none||none|
|»»» collectionName|string|true|none||none|
|»»» created|string|false|none||none|
|»»» email|string|false|none||none|
|»»» emailVisibility|boolean|false|none||none|
|»»» id|string|true|none||none|
|»»» token|string|false|none||none|
|»»» updated|string|false|none||none|
|»»» username|string|true|none||none|
|»»» verified|boolean|false|none||none|
|» id|string|true|none||none|
|» rating|integer|true|none||none|
|» text|string|true|none||none|
|» trail|string|true|none||none|
|» updated|string|true|none||none|
## PUT create
PUT /comment
> Body Parameters
```json
{
"author": "string",
"text": "string",
"trail": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» author|body|string| yes |none|
|» text|body|string| yes |none|
|» trail|body|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"id": "string",
"rating": 0,
"text": "string",
"trail": "string",
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» id|string|true|none||none|
|» rating|integer|true|none||none|
|» text|string|true|none||none|
|» trail|string|true|none||none|
|» updated|string(date-time)|true|none||none|
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|

391
docs/src/content/docs/api-reference/list-share.md
View File

@@ -1,391 +0,0 @@
---
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

567
docs/src/content/docs/api-reference/list.md
View File

@@ -1,567 +0,0 @@
---
title: list
---
## POST file
POST /list/{id}/file
> Body Parameters
```yaml
avatar: string
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» avatar|body|string(binary)| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline|
### Responses Data Schema
## GET show
GET /list/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"expand": {
"trails": [
{
"author": "string",
"category": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"date": "string",
"description": "string",
"difficulty": "string",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"expand": {
"category": {},
"waypoints": [
null
]
},
"gpx": "string",
"id": "string",
"lat": 0,
"location": "string",
"lon": 0,
"name": "string",
"photos": [
"string"
],
"public": true,
"summit_logs": [
"string"
],
"thumbnail": 0,
"updated": "string",
"waypoints": [
"string"
]
}
]
},
"id": "string",
"name": "string",
"trails": [
"string"
],
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» description|string|true|none||none|
|» expand|object|true|none||none|
|»» trails|[object]|true|none||none|
|»»» author|string|true|none||none|
|»»» category|string|true|none||none|
|»»» collectionId|string|true|none||none|
|»»» collectionName|string|true|none||none|
|»»» created|string|true|none||none|
|»»» date|string|true|none||none|
|»»» description|string|true|none||none|
|»»» difficulty|string|true|none||none|
|»»» distance|number|true|none||none|
|»»» duration|integer|true|none||none|
|»»» elevation_gain|number|true|none||none|
|»»» expand|object|true|none||none|
|»»»» category|object|true|none||none|
|»»»»» collectionId|string|true|none||none|
|»»»»» collectionName|string|true|none||none|
|»»»»» created|string|true|none||none|
|»»»»» id|string|true|none||none|
|»»»»» img|string|true|none||none|
|»»»»» name|string|true|none||none|
|»»»»» updated|string|true|none||none|
|»»»» waypoints|[object]|true|none||none|
|»»»»» author|string|true|none||none|
|»»»»» collectionId|string|true|none||none|
|»»»»» collectionName|string|true|none||none|
|»»»»» created|string|true|none||none|
|»»»»» description|string|true|none||none|
|»»»»» icon|string|true|none||none|
|»»»»» id|string|true|none||none|
|»»»»» lat|number|true|none||none|
|»»»»» lon|number|true|none||none|
|»»»»» name|string|true|none||none|
|»»»»» photos|[string]|true|none||none|
|»»»»» updated|string|true|none||none|
|»»» gpx|string|true|none||none|
|»»» id|string|true|none||none|
|»»» lat|number|true|none||none|
|»»» location|string|true|none||none|
|»»» lon|number|true|none||none|
|»»» name|string|true|none||none|
|»»» photos|[string]|true|none||none|
|»»» public|boolean|true|none||none|
|»»» summit_logs|[string]|true|none||none|
|»»» thumbnail|integer|true|none||none|
|»»» updated|string|true|none||none|
|»»» waypoints|[string]|true|none||none|
|» id|string|true|none||none|
|» name|string|true|none||none|
|» trails|[string]|true|none||none|
|» updated|string(date-time)|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|
## POST update
POST /list/{id}
> Body Parameters
```json
{
"name": "string",
"description": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| no |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"name": "string",
"trails": [
"string"
],
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» description|string|true|none||none|
|» id|string|true|none||none|
|» name|string|true|none||none|
|» trails|[string]|true|none||none|
|» updated|string(date-time)|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|
## DELETE delete
DELETE /list/{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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
## GET list
GET /list
> Response Examples
> 200 Response
```json
[
{
"author": "string",
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"description": "string",
"id": "string",
"name": "string",
"trails": [
"string"
],
"updated": "string",
"expand": {
"trails": [
{
"author": "string",
"category": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"description": "string",
"difficulty": "string",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"expand": {
"category": null,
"waypoints": null
},
"gpx": "string",
"id": "string",
"lat": 0,
"location": "string",
"lon": 0,
"name": "string",
"photos": [
"string"
],
"public": true,
"summit_logs": [
"string"
],
"thumbnail": 0,
"updated": "string",
"waypoints": [
"string"
]
}
]
}
}
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string|true|none||none|
|» description|string|true|none||none|
|» id|string|true|none||none|
|» name|string|true|none||none|
|» trails|[string]|true|none||none|
|» updated|string|true|none||none|
|» expand|object|false|none||none|
|»» trails|[object]|true|none||none|
|»»» author|string|true|none||none|
|»»» category|string|true|none||none|
|»»» collectionId|string|true|none||none|
|»»» collectionName|string|true|none||none|
|»»» created|string|true|none||none|
|»»» description|string|true|none||none|
|»»» difficulty|string|true|none||none|
|»»» distance|integer|true|none||none|
|»»» duration|integer|true|none||none|
|»»» elevation_gain|integer|true|none||none|
|»»» expand|object|true|none||none|
|»»»» category|object|true|none||none|
|»»»»» collectionId|string|true|none||none|
|»»»»» collectionName|string|true|none||none|
|»»»»» created|string|true|none||none|
|»»»»» id|string|true|none||none|
|»»»»» img|string|true|none||none|
|»»»»» name|string|true|none||none|
|»»»»» updated|string|true|none||none|
|»»»» waypoints|[object]|false|none||none|
|»»»»» author|string|true|none||none|
|»»»»» collectionId|string|true|none||none|
|»»»»» collectionName|string|true|none||none|
|»»»»» created|string|true|none||none|
|»»»»» description|string|true|none||none|
|»»»»» icon|string|true|none||none|
|»»»»» id|string|true|none||none|
|»»»»» lat|number|true|none||none|
|»»»»» lon|number|true|none||none|
|»»»»» name|string|true|none||none|
|»»»»» photos|[string]|true|none||none|
|»»»»» updated|string|true|none||none|
|»»» gpx|string|true|none||none|
|»»» id|string|true|none||none|
|»»» lat|number|true|none||none|
|»»» location|string|true|none||none|
|»»» lon|number|true|none||none|
|»»» name|string|true|none||none|
|»»» photos|[string]|true|none||none|
|»»» public|boolean|true|none||none|
|»»» summit_logs|[string]|true|none||none|
|»»» thumbnail|integer|true|none||none|
|»»» updated|string|true|none||none|
|»»» waypoints|[string]|true|none||none|
## PUT create
PUT /list
> Body Parameters
```json
{
"name": "string",
"description": "string",
"author": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» description|body|string| no |none|
|» author|body|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"name": "string",
"trails": [
"string"
],
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» description|string|true|none||none|
|» id|string|true|none||none|
|» name|string|true|none||none|
|» trails|[string]|true|none||none|
|» updated|string(date-time)|true|none||none|
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|

364
docs/src/content/docs/api-reference/summit-log.md
View File

@@ -1,364 +0,0 @@
---
title: summit-log
---
## GET show
GET /summit-log/{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",
"date": "2019-08-24",
"id": "string",
"text": "string",
"updated": "2019-08-24T14:15:22Z"
}
```
### 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|
|» date|string(date)|true|none||none|
|» id|string|true|none||none|
|» text|string|true|none||none|
|» updated|string(date-time)|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|
## POST update
POST /summit-log/{id}
> Body Parameters
```json
{
"date": "2019-08-24",
"text": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» date|body|string(date)| yes |none|
|» text|body|string| no |none|
> Response Examples
> 200 Response
```json
{
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"date": "2019-08-24",
"id": "string",
"text": "string",
"updated": "2019-08-24T14:15:22Z"
}
```
### 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|
|» date|string(date)|true|none||none|
|» id|string|true|none||none|
|» text|string|true|none||none|
|» updated|string(date-time)|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|
## DELETE delete
DELETE /summit-log/{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|
## POST file
POST /summit-log/{id}/file
> Body Parameters
```yaml
gpx: ""
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» gpx|body|string(binary)| no |none|
> Response Examples
> 200 Response
```json
{}
```
### 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
## GET list
GET /summit-log
> Response Examples
> 200 Response
```json
[
{
"collectionId": "string",
"collectionName": "string",
"created": "string",
"date": "string",
"id": "string",
"text": "string",
"updated": "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|
|» date|string|false|none||none|
|» id|string|false|none||none|
|» text|string|false|none||none|
|» updated|string|false|none||none|
## PUT create
PUT /summit-log
> Body Parameters
```json
{
"date": "2019-08-24",
"text": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» date|body|string(date)| yes |none|
|» text|body|string| no |none|
> Response Examples
> 200 Response
```json
{
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"date": "2019-08-24",
"id": "string",
"text": "string",
"updated": "2019-08-24T14:15:22Z"
}
```
### 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|
|» date|string(date)|true|none||none|
|» id|string|true|none||none|
|» text|string|true|none||none|
|» updated|string(date-time)|true|none||none|
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

388
docs/src/content/docs/api-reference/trail-share.md
View File

@@ -1,388 +0,0 @@
---
title: trail-share
---
## GET show
GET /trail-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",
"trail": "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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
|» trail|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 /trail-share/{id}
> Body Parameters
```json
{
"trail": "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|
|» trail|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",
"trail": "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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
|» trail|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|
## DELETE delete
DELETE /trail-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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
## GET list
GET /trail-share
> Response Examples
> 200 Response
```json
[
{
"collectionId": "string",
"collectionName": "string",
"created": "string",
"id": "string",
"permission": "string",
"trail": "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)|OK|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|true|none||none|
|» id|string|true|none||none|
|» permission|string|true|none||none|
|» trail|string|true|none||none|
|» updated|string|true|none||none|
|» user|string|true|none||none|
|» expand|object|true|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|
## PUT create
PUT /trail-share
> Body Parameters
```json
{
"trail": "string",
"user": "string",
"permission": "view"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» trail|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",
"trail": "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)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|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|
|» trail|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|

619
docs/src/content/docs/api-reference/trail.md
View File

@@ -1,619 +0,0 @@
---
title: trail
---
## POST file
POST /trail/{id}/file
> Body Parameters
```yaml
photos: string
gpx: string
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» photos|body|string(binary)| no |none|
|» gpx|body|string(binary)| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline|
### Responses Data Schema
## GET show
GET /trail/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"category": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"date": "2019-08-24",
"description": "string",
"difficulty": "easy",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"gpx": "string",
"id": "string",
"lat": 0,
"location": "string",
"lon": 0,
"name": "string",
"photos": [
"string"
],
"public": true,
"summit_logs": [
"string"
],
"thumbnail": 0,
"updated": "2019-08-24T14:15:22Z",
"waypoints": [
"string"
]
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» category|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» date|string(date)|true|none||none|
|» description|string|true|none||none|
|» difficulty|string|true|none||none|
|» distance|number|true|none||none|
|» duration|number|true|none||none|
|» elevation_gain|number|true|none||none|
|» gpx|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» location|string|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» public|boolean|true|none||none|
|» summit_logs|[string]|true|none||none|
|» thumbnail|integer|true|none||none|
|» updated|string(date-time)|true|none||none|
|» waypoints|[string]|true|none||none|
#### Enum
|Name|Value|
|---|---|
|difficulty|easy|
|difficulty|moderate|
|difficulty|hard|
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 /trail/{id}
> Body Parameters
```json
{
"name": "string",
"category": "string",
"description": "string",
"difficulty": "easy",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"lat": 0,
"location": "string",
"lon": 0,
"public": true,
"thumbnail": 0
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| yes |none|
|» category|body|string| no |none|
|» description|body|string| no |none|
|» difficulty|body|string| no |none|
|» distance|body|number| no |none|
|» duration|body|number| no |none|
|» elevation_gain|body|number| no |none|
|» lat|body|number| no |none|
|» location|body|string| no |none|
|» lon|body|number| no |none|
|» public|body|boolean| no |none|
|» thumbnail|body|integer| no |none|
#### Enum
|Name|Value|
|---|---|
|» difficulty|easy|
|» difficulty|moderate|
|» difficulty|hard|
> Response Examples
> 200 Response
```json
{
"author": "string",
"category": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"date": "2019-08-24",
"description": "string",
"difficulty": "easy",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"expand": {
"category": {
"collectionId": "string",
"collectionName": "string",
"created": "string",
"id": "string",
"img": "string",
"name": "string",
"updated": "string"
},
"waypoints": [
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"description": "string",
"icon": "string",
"id": "string",
"lat": 0,
"lon": 0,
"name": "string",
"photos": [
"string"
],
"updated": "string"
}
]
},
"gpx": "string",
"id": "string",
"lat": 0,
"location": "string",
"lon": 0,
"name": "string",
"photos": [
"string"
],
"public": true,
"summit_logs": [
"string"
],
"thumbnail": 0,
"updated": "2019-08-24T14:15:22Z",
"waypoints": [
"string"
]
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» category|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» date|string(date)|true|none||none|
|» description|string|true|none||none|
|» difficulty|string|true|none||none|
|» distance|number|true|none||none|
|» duration|number|true|none||none|
|» elevation_gain|number|true|none||none|
|» expand|object|true|none||none|
|»» category|object|true|none||none|
|»»» collectionId|string|true|none||none|
|»»» collectionName|string|true|none||none|
|»»» created|string|true|none||none|
|»»» id|string|true|none||none|
|»»» img|string|true|none||none|
|»»» name|string|true|none||none|
|»»» updated|string|true|none||none|
|»» waypoints|[object]|true|none||none|
|»»» author|string|true|none||none|
|»»» collectionId|string|true|none||none|
|»»» collectionName|string|true|none||none|
|»»» created|string|true|none||none|
|»»» description|string|true|none||none|
|»»» icon|string|true|none||none|
|»»» id|string|true|none||none|
|»»» lat|number|true|none||none|
|»»» lon|number|true|none||none|
|»»» name|string|true|none||none|
|»»» photos|[string]|true|none||none|
|»»» updated|string|true|none||none|
|» gpx|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» location|string|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» public|boolean|true|none||none|
|» summit_logs|[string]|true|none||none|
|» thumbnail|integer|true|none||none|
|» updated|string(date-time)|true|none||none|
|» waypoints|[string]|true|none||none|
#### Enum
|Name|Value|
|---|---|
|difficulty|easy|
|difficulty|moderate|
|difficulty|hard|
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|
## DELETE delete
DELETE /trail/{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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
## GET list
GET /trail
> Response Examples
> 200 Response
```json
{
"page": 0,
"perPage": 0,
"totalItems": 0,
"totalPages": 0,
"items": [
{
"author": "string",
"category": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"description": "string",
"difficulty": "string",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"gpx": "string",
"id": "string",
"lat": 0,
"location": "string",
"lon": 0,
"name": "string",
"photos": [
"string"
],
"public": true,
"summit_logs": [
"string"
],
"thumbnail": 0,
"updated": "string",
"waypoints": [
"string"
]
}
]
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» page|integer|true|none||none|
|» perPage|integer|true|none||none|
|» totalItems|integer|true|none||none|
|» totalPages|integer|true|none||none|
|» items|[object]|true|none||none|
|»» author|string|true|none||none|
|»» category|string|true|none||none|
|»» collectionId|string|true|none||none|
|»» collectionName|string|true|none||none|
|»» created|string|true|none||none|
|»» description|string|true|none||none|
|»» difficulty|string|true|none||none|
|»» distance|integer|true|none||none|
|»» duration|integer|true|none||none|
|»» elevation_gain|integer|true|none||none|
|»» gpx|string|true|none||none|
|»» id|string|true|none||none|
|»» lat|number|true|none||none|
|»» location|string|true|none||none|
|»» lon|number|true|none||none|
|»» name|string|true|none||none|
|»» photos|[string]|true|none||none|
|»» public|boolean|true|none||none|
|»» summit_logs|[string]|true|none||none|
|»» thumbnail|integer|true|none||none|
|»» updated|string|true|none||none|
|»» waypoints|[string]|true|none||none|
## PUT upload
PUT /trail/upload
> Body Parameters
```yaml
string
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|Content-Type|header|string| yes |none|
|body|body|string(binary)| no |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"category": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"date": "2019-08-24",
"description": "string",
"difficulty": "easy",
"distance": 0,
"duration": 0,
"elevation_gain": 0,
"gpx": "string",
"id": "string",
"lat": 0,
"location": "string",
"lon": 0,
"name": "string",
"photos": [
"string"
],
"public": true,
"summit_logs": [
"string"
],
"thumbnail": 0,
"updated": "2019-08-24T14:15:22Z",
"waypoints": [
"string"
]
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» category|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» date|string(date)|true|none||none|
|» description|string|true|none||none|
|» difficulty|string|true|none||none|
|» distance|number|true|none||none|
|» duration|number|true|none||none|
|» elevation_gain|number|true|none||none|
|» gpx|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» location|string|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» public|boolean|true|none||none|
|» summit_logs|[string]|true|none||none|
|» thumbnail|integer|true|none||none|
|» updated|string(date-time)|true|none||none|
|» waypoints|[string]|true|none||none|
#### Enum
|Name|Value|
|---|---|
|difficulty|easy|
|difficulty|moderate|
|difficulty|hard|
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|
|»» message|string|true|none||none|
|» isAbort|boolean|true|none||none|
|» originalError|object|true|none||none|
|»» status|integer|true|none||none|
|»» response|object|true|none||none|
|»»» message|string|true|none||none|
|» name|string|true|none||none|

352
docs/src/content/docs/api-reference/user.md
View File

@@ -1,352 +0,0 @@
---
title: user
---
## POST file
POST /user/{id}/file
> Body Parameters
```yaml
avatar: string
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» avatar|body|string(binary)| no |none|
> Response Examples
> 200 Response
```json
{}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline|
### Responses Data Schema
## GET show
GET /user/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"email": "string",
"emailVisibility": true,
"id": "string",
"token": "string",
"updated": "2019-08-24T14:15:22Z",
"username": "string",
"verified": true
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» email|string|true|none||none|
|» emailVisibility|boolean|true|none||none|
|» id|string|true|none||none|
|» token|string|true|none||none|
|» updated|string(date-time)|true|none||none|
|» username|string|true|none||none|
|» verified|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|
## POST update
POST /user/{id}
> Body Parameters
```json
{}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
> Response Examples
> 200 Response
```json
{
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"email": "string",
"emailVisibility": true,
"id": "string",
"token": "string",
"updated": "2019-08-24T14:15:22Z",
"username": "string",
"verified": true
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» email|string|true|none||none|
|» emailVisibility|boolean|true|none||none|
|» id|string|true|none||none|
|» token|string|true|none||none|
|» updated|string(date-time)|true|none||none|
|» username|string|true|none||none|
|» verified|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|
## DELETE delete
DELETE /user/{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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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 /user
> Body Parameters
```json
{
"username": "string",
"password": "string",
"passwordConfirm": "string",
"email": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» username|body|string| yes |none|
|» password|body|string| yes |none|
|» passwordConfirm|body|string| yes |none|
|» email|body|string| yes |none|
> Response Examples
> 200 Response
```json
{
"avatar": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"emailVisibility": true,
"id": "string",
"token": "string",
"updated": "2019-08-24T14:15:22Z",
"username": "string",
"verified": true
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» avatar|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» emailVisibility|boolean|true|none||none|
|» id|string|true|none||none|
|» token|string|true|none||none|
|» updated|string(date-time)|true|none||none|
|» username|string|true|none||none|
|» verified|boolean|true|none||none|
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|
|»»» passwordConfirm|object|true|none||none|
|»»»» code|string|true|none||none|
|»»»» message|string|true|none||none|
|»»» username|object|true|none||none|
|»»»» code|string|true|none||none|
|»»»» message|string|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|
|»»»» passwordConfirm|object|true|none||none|
|»»»»» code|string|true|none||none|
|»»»»» message|string|true|none||none|
|»»»» username|object|true|none||none|
|»»»»» code|string|true|none||none|
|»»»»» message|string|true|none||none|
|» name|string|true|none||none|

387
docs/src/content/docs/api-reference/waypoint.md
View File

@@ -1,387 +0,0 @@
---
title: waypoint
---
## GET show
GET /waypoint/{id}
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"icon": "string",
"id": "string",
"lat": 0,
"lon": 0,
"name": "string",
"photos": [
"string"
],
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» description|string|true|none||none|
|» icon|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» updated|string(date-time)|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|
## POST update
POST /waypoint/{id}
> Body Parameters
```json
{
"name": "string",
"description": "string",
"lat": 0,
"lon": 0,
"icon": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|id|path|string| yes |none|
|Content-Type|header|string| yes |none|
|body|body|object| no |none|
|» name|body|string| no |none|
|» description|body|string| no |none|
|» lat|body|number| yes |none|
|» lon|body|number| yes |none|
|» icon|body|string| no |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"icon": "string",
"id": "string",
"lat": 0,
"lon": 0,
"name": "string",
"photos": [
"string"
],
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» description|string|true|none||none|
|» icon|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» updated|string(date-time)|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|
## DELETE delete
DELETE /waypoint/{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)|OK|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|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|
## GET list
GET /waypoint
> Response Examples
> 200 Response
```json
[
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "string",
"description": "string",
"icon": "string",
"id": "string",
"lat": 0,
"lon": 0,
"name": "string",
"photos": [
"string"
],
"updated": "string"
}
]
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string|true|none||none|
|» description|string|true|none||none|
|» icon|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» updated|string|true|none||none|
## PUT create
PUT /waypoint
> Body Parameters
```json
{
"name": "string",
"description": "string",
"author": "string",
"lat": 0,
"lon": 0,
"icon": "string"
}
```
### Params
|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|body|body|object| no |none|
|» name|body|string| no |none|
|» description|body|string| no |none|
|» author|body|string| yes |none|
|» lat|body|number| yes |none|
|» lon|body|number| yes |none|
|» icon|body|string| no |none|
> Response Examples
> 200 Response
```json
{
"author": "string",
"collectionId": "string",
"collectionName": "string",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"icon": "string",
"id": "string",
"lat": 0,
"lon": 0,
"name": "string",
"photos": [
"string"
],
"updated": "2019-08-24T14:15:22Z"
}
```
### Responses
|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|Inline|
### Responses Data Schema
HTTP Status Code **200**
|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» author|string|true|none||none|
|» collectionId|string|true|none||none|
|» collectionName|string|true|none||none|
|» created|string(date-time)|true|none||none|
|» description|string|true|none||none|
|» icon|string|true|none||none|
|» id|string|true|none||none|
|» lat|number|true|none||none|
|» lon|number|true|none||none|
|» name|string|true|none||none|
|» photos|[string]|true|none||none|
|» updated|string(date-time)|true|none||none|
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|

4
docs/src/content/docs/guides/api.md
View File

@@ -3,7 +3,7 @@ title: wanderer API
description: How to use wanderer's API description: How to use wanderer's API
--- ---
wanderer comes with a fully functional RESTful API out of the box. It largely follows the CRUD conventions implemented by the [PocketBase backend](https://pocketbase.io/docs/api-records/#crud-actions). All endpoints are available at `http://<wanderer_host>/api/v1`. The full technical API documentation can be found at `http://<wanderer_host>/docs/api/index.html` and is also provided in the [API Reference](/api-reference/auth). wanderer comes with a fully functional RESTful API out of the box. It largely follows the CRUD conventions implemented by the [PocketBase backend](https://pocketbase.io/docs/api-records/#crud-actions). All endpoints are available at `http://<wanderer_host>/api/v1`. The full technical API documentation can be found at `http://<wanderer_host>/docs/api/index.html` and is also provided in the [API Reference](/api-reference).
## Authentication ## Authentication
wanderer's API uses cookie-based authentication. To receive an auth cookie send a request to the `/auth/login` endpoint. The request must contain a JSON body in the following form: wanderer's API uses cookie-based authentication. To receive an auth cookie send a request to the `/auth/login` endpoint. The request must contain a JSON body in the following form:
@@ -24,7 +24,7 @@ http://localhost:3000/api/v1/auth/login
## Upload trails ## Upload trails
One common use case for wanderer's API is bulk uploading GPX files to create new trails. For that, the API provides a separate endpoint: `/trail/upload`. You must first log in to use the endpoint. Afterwards you can send a GPX file to the endpoint to let wanderer parse it an create a new trail in your collection. wanderer will try to infer as much information as possible from the file itself. All additional information can be added to the trail via the UPDATE [endpoint](/api-reference/trail#post-update). One common use case for wanderer's API is bulk uploading GPX files to create new trails. For that, the API provides a separate endpoint: `/trail/upload`. You must first log in to use the endpoint. Afterwards you can send a GPX file to the endpoint to let wanderer parse it an create a new trail in your collection. wanderer will try to infer as much information as possible from the file itself. All additional information can be added to the trail via the UPDATE [endpoint](/api-reference/operations/updatetrail).
### Example ### Example
```bash ```bash

4
docs/src/content/docs/index.mdx
View File

@@ -13,10 +13,10 @@ hero:
- text: Try the demo - text: Try the demo
link: https://demo.wanderer.to link: https://demo.wanderer.to
icon: rocket icon: rocket
variant: primary
- text: Read the docs - text: Read the docs
link: /getting-started/installation/ link: /getting-started/installation/
icon: right-arrow icon: right-arrow
variant: secondary
--- ---
@@ -45,7 +45,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
<Card title="Full API support" icon="seti:json"> <Card title="Full API support" icon="seti:json">
Use <span class="-tracking-[0.075em] s-y_bCXRrkrYfP">wanderer</span>'s API to interact with your trail data directly and automate the tasks you don't want to do manually. Use <span class="-tracking-[0.075em] s-y_bCXRrkrYfP">wanderer</span>'s API to interact with your trail data directly and automate the tasks you don't want to do manually.
[API reference →](/api-reference/auth) [API reference →](/api-reference)
</Card> </Card>
<Card title="Privacy friendly" icon="approve-check"> <Card title="Privacy friendly" icon="approve-check">
<span class="-tracking-[0.075em] s-y_bCXRrkrYfP">wanderer</span> is self-hosted and open-source. Your data stays on your machine and your machine only. <span class="-tracking-[0.075em] s-y_bCXRrkrYfP">wanderer</span> is self-hosted and open-source. Your data stays on your machine and your machine only.

14641
docs/wanderer.openapi.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

2
web/src/lib/components/footer.svelte
View File

@@ -18,7 +18,7 @@
> >
</li> </li>
<li> <li>
<a href="https://wanderer.to/api-reference/auth" <a href="https://wanderer.to/api-reference"
>{$_("api-documentation")}</a >{$_("api-documentation")}</a
> >
</li> </li>

2
web/static/docs/api/index.html
View File

File diff suppressed because one or more lines are too long

1
web/static/docs/api/wanderer.openapi.json
View File

File diff suppressed because one or more lines are too long

14641
web/static/docs/api/wanderer.openapi.yaml Normal file
View File

File diff suppressed because it is too large Load Diff