Glossary API Service
Glossary API Service
Note
REST API service for glossary CRUD operations, served at /api/projects/{slug}/glossary.
Base URL
/api/projects/{slug}/glossary
Handler
Authentication
None (local desktop application).
Response Format
JSON with camelCase keys.
Routes
| Method | Path | Description |
|---|---|---|
| GET | /glossary |
List Entries |
| POST | /glossary |
Create Entry |
| GET | /glossary/{id} |
Get Entry |
| PUT | /glossary/{id} |
Update Entry |
| DELETE | /glossary/{id} |
Delete Entry |
| GET | /glossary/{id}/occurrences |
Get Occurrences |
Common Error Responses
| Status | Description |
|---|---|
| 404 | Project or entry not found |
| 405 | Method not allowed |
| 500 | Server error |
Event Schemas
Three glossary-specific events flow through the moduleEventBus:
| Event | Description |
|---|---|
| glossary:view-term | User clicks a glossary mark in the editor |
| glossary:entry-saved | Entry created or updated |
| glossary:entry-deleted | Entry deleted |