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

Fix to property in CPE 2/3 use cases section, add urn:cadmium prefix to all identifiers in these CPEs

Browse Source
This commit is contained in:
ChronosX88 2020-10-09 18:01:17 +04:00
parent 2380309051
commit 5643c80979
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CPEs/proposed/CPE2 - In-band account login.md
View File

@ -6,12 +6,12 @@ This extension is intended for logging into user account on a server by username
## Message type identifiers
- `profile:login`
- `urn:cadmium:profile:login`
## Errors
- Ratelimit system: enabled
- `invalid_creds`: user ID/password isn't valid
- `urn:cadmium:profile:login:invalid_creds`: user ID/password isn't valid
## Use cases
@ -20,8 +20,8 @@ This extension is intended for logging into user account on a server by username
```json
{
"id": "abcd",
"type": "profile:login",
"to": "cadmium.org",
"type": "urn:cadmium:profile:login",
"to": ["cadmium.org"],
"payload": {
"username": "juliet",
"password": "romeo1"
@ -34,7 +34,7 @@ This extension is intended for logging into user account on a server by username
```json
{
"id": "abcd",
"type": "profile:login",
"type": "urn:cadmium:profile:login",
"from": "cadmium.org",
"ok": true,
"payload": {
@ -49,11 +49,11 @@ This extension is intended for logging into user account on a server by username
```json
{
"id": "abcd",
"type": "profile:login",
"type": "urn:cadmium:profile:login",
"from": "cadmium.org",
"ok": false,
"payload": {
"errID": "invalid_creds",
"errID": "urn:cadmium:profile:login:invalid_creds",
"errText": "Username/password isn't valid"
}
}

16
CPEs/proposed/CPE3 - In-band account registration.md
View File

@ -6,13 +6,13 @@ This extension is intended for creating user accounts on a server
## Message type identifiers
- `profile:register`
- `urn:cadmium:profile:register`
## Errors
- Ratelimit system: enabled
- `id_exists`: username/third party ID already taken
- `reg_disabled`: registration isn't allowed on a server
- `urn:cadmium:profile:register:id_exists`: username/third party ID already taken
- `urn:cadmium:profile:register:reg_disabled`: registration isn't allowed on a server
## Use cases
@ -25,8 +25,8 @@ This extension is intended for creating user accounts on a server
```json
{
"id": "abcd",
"type": "profile:register",
"to": "cadmium.org",
"type": "urn:cadmium:profile:register",
"to": ["cadmium.org"],
"payload": {
"username": "juliet",
"thirdPIDs": [
@ -44,7 +44,7 @@ This extension is intended for creating user accounts on a server
```json
{
"id": "abcd",
"type": "profile:register",
"type": "urn:cadmium:profile:register",
"from": "cadmium.org",
"ok": true,
"payload": {
@ -58,11 +58,11 @@ This extension is intended for creating user accounts on a server
```json
{
"id": "abcd",
"type": "profile:register",
"type": "urn:cadmium:profile:register",
"from": "cadmium.org",
"ok": false,
"payload": {
"errID": "id_exists",
"errID": "urn:cadmium:profile:register:id_exists",
"errText": "Username/email/msisdn already taken"
}
}