Skip to content

Commit 730b5ab

Browse files
committed
Document missing API endpoints: members, markers, relation operations
Adds documentation for endpoints that the module uses but were missing from API-CONTRACT.md: - GET /members — campaign member listing for user auto-matching - GET/DELETE /entities/:entityId/relations/:relationId — relation CRUD - PUT /entities/:entityId/relations/:relationId/metadata — item metadata - GET/POST/PUT/DELETE /maps/:mapId/markers — map pin/marker CRUD https://claude.ai/code/session_01J3F55nRmeFHTtK4BnYgGGk
1 parent 4b14378 commit 730b5ab

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

API-CONTRACT.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,39 @@ the relation type (not a numeric ID).
429429
}
430430
```
431431

432+
#### GET /entities/:entityId/relations
433+
List all relations on an entity.
434+
435+
**Used by:** `item-sync.mjs` → pull inventory relations for actors
436+
437+
#### DELETE /entities/:entityId/relations/:relationId
438+
Delete a relation.
439+
440+
**Used by:** `item-sync.mjs` → remove item from actor inventory
441+
442+
#### PUT /entities/:entityId/relations/:relationId/metadata
443+
Update relation metadata (e.g., item quantity, equipped state).
444+
445+
**Used by:** `item-sync.mjs` → update inventory item metadata
446+
447+
---
448+
449+
### Members
450+
451+
#### GET /members
452+
Lists campaign members with their display names and roles.
453+
454+
**Used by:** `sync-manager.mjs` → auto-match Chronicle users to Foundry users by display name
455+
456+
**Response:**
457+
```json
458+
{
459+
"data": [
460+
{ "id": "uuid", "display_name": "Alice", "role": "player" }
461+
]
462+
}
463+
```
464+
432465
---
433466

434467
### Sync Mappings
@@ -550,6 +583,18 @@ Updates fog of war data.
550583
#### GET /maps/:mapId/layers
551584
Lists map layers.
552585

586+
#### GET /maps/:mapId/markers
587+
Lists map markers (pins/notes on the map).
588+
589+
#### POST /maps/:mapId/markers
590+
Creates a map marker.
591+
592+
#### PUT /maps/:mapId/markers/:markerId
593+
Updates a map marker.
594+
595+
#### DELETE /maps/:mapId/markers/:markerId
596+
Deletes a map marker.
597+
553598
---
554599

555600
### Calendar

0 commit comments

Comments
 (0)