cadmium-im/cadmium-docs-legacy
1
0
Fork 0
mirror of https://github.com/cadmium-im/cadmium-docs-legacy.git synced 2024-11-08 19:51:02 +00:00
Code Issues Projects Releases Wiki Activity

Accept server ID purpose (from mail lists thread) for EntityID

Browse Source
This commit is contained in:
ChronosX88 2019-11-20 17:35:38 +04:00
parent 200638a542
commit 8fffa2cc64
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
protocol-spec/core.md
View File

@ -22,10 +22,15 @@ For starting we simply use JSON + Websockets.
* Room ID: `!<roomID>@<serverpart>` * Room ID: `!<roomID>@<serverpart>`
* Single server-part: `<serverpart>` * Single server-part: `<serverpart>`
**Server-part (hostname)** - `IPv4 / [IPv6] / dns-domain:<port (1-65535)>`. **Server-part**:
- hostname: `IPv4 / [IPv6] / dns-domain:<port (1-65535)>` (for end-users use)
- server ID: static SHA256 hash string from 4096 characters (for internal protocol use)
**Username/Room alias/RoomID** - MUST NOT be empty, and MUST contain only the characters `a-z`, `0-9`, `.`, `_`, `=`, `-`, and `/`. **Username/Room alias/RoomID** - MUST NOT be empty, and MUST contain only the characters `a-z`, `0-9`, `.`, `_`, `=`, `-`, and `/`.
RoomID SHOULD be UUID identifier. **Special business rules**:
- RoomID SHOULD be UUID identifier.
- Servers MUST use server ID in internal purposes instead of normal server-part with hostname. Only end-users MUST use normal server-part with hostname. This is done for easy multi-domain serving.
## BaseMessage ## BaseMessage
BaseMessage is a basic message model, basis of the whole protocol. It is used for a very easy protocol extension process. BaseMessage is a basic message model, basis of the whole protocol. It is used for a very easy protocol extension process.
@ -85,7 +90,7 @@ Adds into type name `:error` postfix.
## Account registration/login ## Account registration/login
### Create account ### Create account
**Description**: Create user account on a server **Description**: Create user account on a server
**Type**: `profile:register` **Type**: `profile:register`
**Payload**: **Payload**:
- Request: - Request:
- `username: string` - the username that the user wants to register - `username: string` - the username that the user wants to register