u
This commit is contained in:
@@ -265,9 +265,11 @@ Generated from `@openapi` annotations in [`src/api/routes/`](../../src/api/route
|
||||
| [`routes/pos/pimage.md`](routes/pos/pimage.md) | `GET /v1/pimage` |
|
||||
| [`routes/v1/product.md`](routes/v1/product.md) | `GET /v1/product` |
|
||||
| [`routes/vfs/list.md`](routes/vfs/list.md) | `GET /vfs` |
|
||||
| [`routes/vfs/applets-restore.md`](routes/vfs/applets-restore.md) | `POST /vfs/applets/restore` |
|
||||
| [`routes/vfs/drafts/response.md`](routes/vfs/drafts/response.md) | `POST /vfs/drafts/response` |
|
||||
| [`routes/vfs/mkdir.md`](routes/vfs/mkdir.md) | `POST /vfs/mkdir` |
|
||||
| [`routes/vfs/rename.md`](routes/vfs/rename.md) | `POST /vfs/rename` |
|
||||
| [`routes/vfs/skills-restore.md`](routes/vfs/skills-restore.md) | `POST /vfs/skills/restore` |
|
||||
| [`routes/vfs/upload.md`](routes/vfs/upload.md) | `POST /vfs/upload` |
|
||||
| [`routes/vfs/delete.md`](routes/vfs/delete.md) | `DELETE /vfs/{*path}` |
|
||||
| [`routes/vfs/_*path.md`](routes/vfs/_*path.md) | `GET /vfs/{*path}` |
|
||||
@@ -305,7 +307,7 @@ Clients subscribe via [`GET /events`](routes/events.md) (`text/event-stream`). A
|
||||
| `quote` | `DELETE /quote/{id}/file/{fileId}`, `POST /quote/{id}/pdf` |
|
||||
| `shipment` | `PATCH /shipment/{id}`, `DELETE /shipment/{id}/file/{fileId}`, `POST /shipment/{id}/pdf` |
|
||||
| `stock` | `POST /stock/adjust` |
|
||||
| `vfs` | `POST /vfs/mkdir`, `POST /vfs/rename`, `POST /vfs/upload`, `DELETE /vfs/{*path}`, `POST /vfs/{*path}`, `PUT /vfs/{*path}` |
|
||||
| `vfs` | `POST /vfs/applets/restore`, `POST /vfs/mkdir`, `POST /vfs/rename`, `POST /vfs/skills/restore`, `POST /vfs/upload`, `DELETE /vfs/{*path}`, `POST /vfs/{*path}`, `PUT /vfs/{*path}` |
|
||||
| `warehouse` | `POST /warehouse`, `PUT /warehouse/order`, `DELETE /warehouse/{id}`, `PUT /warehouse/{id}` |
|
||||
|
||||
## DESIGN
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dash API Routes Overview (All)
|
||||
|
||||
Overview of all 248 API endpoints across all modules.
|
||||
Overview of all 250 API endpoints across all modules.
|
||||
|
||||
### Notation
|
||||
|
||||
@@ -912,6 +912,9 @@ _none_
|
||||
#### List virtual filesystem files — `GET /vfs`
|
||||
_none_
|
||||
- Returns: `200 { files: { name: str, size: int, mime: str, updated_at: str, created_at: str, isText: bool, isImage: bool, isPdf: bool }[] }`
|
||||
#### Restore system default applets — `POST /vfs/applets/restore`
|
||||
_none_
|
||||
- Returns: `200 { success: bool, restored: str[], count: int }`
|
||||
#### Respond to a frontend draft request — `POST /vfs/drafts/response`
|
||||
- Params: `body: { requestId: str, content?: any, error?: str, files?: any[] }`
|
||||
- Returns: `200 { success: bool }`
|
||||
@@ -921,6 +924,9 @@ _none_
|
||||
#### Rename or move a virtual filesystem file or directory — `POST /vfs/rename`
|
||||
- Params: `body: { oldPath: str, newPath: str }`
|
||||
- Returns: `200 { success: bool, oldPath: str, newPath: str }`
|
||||
#### Restore system default skills — `POST /vfs/skills/restore`
|
||||
_none_
|
||||
- Returns: `200 { success: bool, restored: str[], count: int }`
|
||||
#### Upload files to virtual filesystem — `POST /vfs/upload`
|
||||
- Params: `form: { files: str[], targetDir?: str }`
|
||||
- Returns: `200 { success: bool, uploaded: { name: str, size: int, mime: str }[] }`
|
||||
|
||||
40
docs/api/routes/vfs/applets-restore.md
Normal file
40
docs/api/routes/vfs/applets-restore.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# `POST /vfs/applets/restore`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Restore system default applets
|
||||
|
||||
Restores all shipped system default example applets (.applet.js) into the active virtual
|
||||
filesystem (VFS) for the authenticated user's selected company, overwriting existing system applets with their upstream definitions.
|
||||
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `vfs` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
System applets restored successfully
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"restored": [
|
||||
"…"
|
||||
],
|
||||
"count": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 500 | Restore failed — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
40
docs/api/routes/vfs/skills-restore.md
Normal file
40
docs/api/routes/vfs/skills-restore.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# `POST /vfs/skills/restore`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Restore system default skills
|
||||
|
||||
Restores all shipped system default SKILL files into the active virtual filesystem (VFS)
|
||||
for the authenticated user's selected company, overwriting existing system skills with their upstream definitions.
|
||||
|
||||
|
||||
## Signals
|
||||
|
||||
On success, emits SSE signal: `vfs` (see [`GET /events`](../events.md)).
|
||||
|
||||
## Response `200`
|
||||
|
||||
System skills restored successfully
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"restored": [
|
||||
"…"
|
||||
],
|
||||
"count": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 500 | Restore failed — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user