This commit is contained in:
seb
2026-10-14 00:21:31 +02:00
parent 74b24686bc
commit f9ed4fe75d
18 changed files with 1508 additions and 279 deletions

View File

@@ -1,6 +1,6 @@
# Dash API Routes Overview
Overview of all 184 API endpoints across all modules.
Overview of all 164 API endpoints across all modules.
### Notation
@@ -58,27 +58,6 @@ Params: path values first, then `query:` and `body:` (`body?` = optional body).
### Routes
### Section: /.well-known
#### OAuth 2.0 Authorization Server Metadata (RFC 8414) — `GET /.well-known/oauth-authorization-server`
_none_
- Returns: `200`
#### OAuth 2.0 Protected Resource Metadata (RFC 9728) — `GET /.well-known/oauth-protected-resource`
_none_
- Returns: `200`
### Section: /account
#### List accounts — `GET /account`
_none_
- Returns: `200 { accounts: { id: int, companyId: int, type: str, name: str }[] }`
#### Create account — `POST /account`
- Params: `body: { type: str, name: str }`
- Returns: `201 { account: { id: int, companyId: int, type: str, name: str } }`
#### Delete account — `DELETE /account/{id}`
- Params: `id: int`
- Returns: `204 void`
### Section: /article
#### Create article in category — `POST /article`
@@ -223,24 +202,6 @@ _none_
- Params: `id: int, image/avif`
- Returns: `201 { attributevalue: { id: int, fullHash: str, thumbW: int, thumbH: int, thumbHash: str, pics: T39[] } }`
### Section: /auth
#### Login with Google ID token — `POST /auth/login`
- Params: `body: { idToken: str }`
- Returns: `200 { message: str, user: { id: int, email: str, selectedCompanyId: int|null, picture?: str } }`
#### Logout — `POST /auth/logout`
_none_
- Returns: `200 { message: str }`
### Section: /backup
#### List backups and service status — `GET /backup`
_none_
- Returns: `200 { status: {}, backups: {} }`
#### Trigger manual backup — `POST /backup/run`
_none_
- Returns: `200 {}`
### Section: /brand
#### List brands — `GET /brand`
@@ -448,30 +409,6 @@ _none_
- Params: `sku: str, query: transaction_type?: str`
- Returns: `200 T15`
### Section: /mcp
#### Model Context Protocol (MCP) Streamable HTTP endpoint — `POST /mcp`
_none_
- Returns: `200`
#### List active MCP client authorizations — `GET /mcp/authorizations`
_none_
- Returns: `200`
#### Revoke MCP client authorizations — `DELETE /mcp/authorizations/{clientId}`
- Params: `clientId: str`
- Returns: `200`
#### Get MCP authorization prompt details — `GET /mcp/authorize`
- Params: `query: client_id: str, redirect_uri: str, response_type?: str, code_challenge?: str, code_challenge_method?: str, state?: str, scope?: str`
- Returns: `200`
#### Grant or deny MCP client authorization — `POST /mcp/authorize`
- Params: `body: { client_id: str, redirect_uri: str, action: str, code_challenge?: str, code_challenge_method?: str, state?: str, scope?: str }`
- Returns: `200`
#### List registered MCP clients — `GET /mcp/clients`
_none_
- Returns: `200`
#### Delete registered MCP client — `DELETE /mcp/clients/{clientId}`
- Params: `clientId: str`
- Returns: `200`
### Section: /number
#### List number sequences — `GET /number`
@@ -481,21 +418,6 @@ _none_
- Params: `id: int, body: { prefix?: str, padding?: int, next?: int }`
- Returns: `200 { number: { id: int, type: str, prefix: str, padding: int, next: int } }`
### Section: /oauth
#### OAuth 2.1 Authorization Endpoint (RFC 6749 & RFC 7636) — `GET /oauth/authorize`
- Params: `query: client_id?: str, redirect_uri?: str, response_type?: str, code_challenge?: str, code_challenge_method?: str, state?: str`
_no response body_
#### OAuth 2.0 Token Introspection (RFC 7662) — `POST /oauth/introspect`
_none_
- Returns: `200`
#### Dynamic Client Registration (RFC 7591) — `POST /oauth/register`
- Params: `body: { redirect_uris: str[], client_name?: str }`
- Returns: `201`
#### OAuth 2.1 Token Endpoint (RFC 6749 & RFC 7636) — `POST /oauth/token`
- Params: `application/x-www-form-urlencoded`
- Returns: `200`
### Section: /order
#### List orders — `GET /order`