Skip to content

Commit 79f99c6

Browse files
authored
Revise API endpoints and documentation structure
Updated API endpoints and system flow diagrams in README.
1 parent 197081b commit 79f99c6

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

  • plugin_use_cases/public/dashboard-builder

plugin_use_cases/public/dashboard-builder/README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,19 @@ Messages received from plugin:
5353

5454
Multi-Area Bookmark Management:
5555
• POST /api/multi-area-bookmarks/save - Create new bookmark
56+
5657
• GET /api/multi-area-bookmarks/list - List workbook bookmarks
58+
5759
• GET /api/multi-area-bookmarks/get/:id - Get specific bookmark
60+
5861
• DELETE /api/multi-area-bookmarks/delete/:id - Delete bookmark
62+
5963
• GET /api/multi-area-bookmarks/stats - Database statistics
6064

6165
JWT & Legacy:
66+
6267
• POST /api/jwt/view?bookmarkId - Generate embed URLs
68+
6369
• POST /api/bookmarks/create-bookmark - Create Sigma bookmarks
6470

6571

@@ -84,17 +90,9 @@ Messages received from plugin:
8490
2. Preserve History: Keep Sigma bookmark for exploreKey history
8591
3. Reset UI: Update dropdown and reload if current bookmark was deleted
8692

87-
## SYSTEM FLOW DIAGRAMS
88-
89-
┌─────────────────────────────────────────────────────────────────────────────────┐
90-
│ DASHBOARD BUILDER SYSTEM │
91-
│ Multi-Area KPI Placement │
92-
└─────────────────────────────────────────────────────────────────────────────────┘
93-
94-
┌─────────────────────────────────────────────────────────────────────────────────┐
95-
│ COMPONENT OVERVIEW │
96-
└─────────────────────────────────────────────────────────────────────────────────┘
93+
## SYSTEM FLOW DIAGRAMS
9794

95+
### COMPONENT OVERVIEW
9896
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
9997
│ AREA 1 │ │ AREA 2 │ │ AREA 3 │
10098
│ │ │ │ │ │
@@ -296,11 +294,10 @@ Message Types:
296294
- Efficient Message Filtering
297295
- Background Database Operations
298296

299-
┌─────────────────────────────────────────────────────────────────────────────────┐
300-
│ DATA STRUCTURES │
301-
└─────────────────────────────────────────────────────────────────────────────────┘
297+
## DATA STRUCTURES
302298

303-
LOWDB BOOKMARK STRUCTURE:
299+
### LOWDB BOOKMARK STRUCTURE:
300+
```
304301
{
305302
"id": "uuid-local-bookmark-id",
306303
"name": "User-Friendly Name",
@@ -314,8 +311,9 @@ Message Types:
314311
"created": "2025-10-15T14:31:52.604Z",
315312
"updated": "2025-10-15T14:31:52.604Z"
316313
}
314+
```
317315

318-
RUNTIME STATE TRACKING:
316+
## RUNTIME STATE TRACKING:
319317
- currentExploreKey: Active exploreKey for JWT generation
320318
- areaNodeIdMap: { "viz1_nodeid": "nodeId", ... }
321319
- availableBookmarks: Array of bookmark objects for dropdown

0 commit comments

Comments
 (0)