forked from andyburke/autonomous.contact
refactor: rooms => zones
This commit is contained in:
parent
525568d368
commit
20a5d1bc88
27 changed files with 2466 additions and 2044 deletions
28
public/api/zones/README.md
Normal file
28
public/api/zones/README.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# /api/zones
|
||||
|
||||
Interact with zones.
|
||||
|
||||
## POST /api/zones
|
||||
|
||||
Create a new zone.
|
||||
|
||||
```
|
||||
export type ZONE = {
|
||||
id: string; // unique id for this zone
|
||||
name: string; // the name of the zone (max 128 characters)
|
||||
icon_url?: string; // optional url for a zone icon
|
||||
topic?: string; // optional zone topic
|
||||
tags: string[]; // a list of tags for the zone
|
||||
meta: Record<string, any>;
|
||||
limits: {
|
||||
users: number;
|
||||
user_messages_per_minute: number;
|
||||
};
|
||||
creator_id: string; // user_id of the zone creator
|
||||
emojis: Record<string, string>; // either: string: emoji eg: { 'rofl: 🤣, ... } or { 'rofl': 🤣, 'blap': 'https://somewhere.someplace/image.jpg' }
|
||||
};
|
||||
```
|
||||
|
||||
## GET /api/zones
|
||||
|
||||
Get zones.
|
||||
Loading…
Add table
Add a link
Reference in a new issue