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

Fix CEDF

Browse Source
This commit is contained in:
ChronosX88 2019-12-26 17:41:23 +04:00
parent f209420ee0
commit 0688f8849d
Signed by: ChronosXYZ
GPG Key ID: 085A69A82C8C511A
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
protocol-spec/account-login-by-username.md
View File

@ -8,8 +8,9 @@ This extension is intended for logging into user account on a server by username
- `profile:login`
## Error Identifiers
## Errors
- Ratelimit system: enabled
- `invalid_creds`: user ID/password isn't valid
## Use cases
@ -60,7 +61,7 @@ This extension is intended for logging into user account on a server by username
## Business Rules
- Ratelimit system: enabled
None.
## JSON Schema

3
protocol-spec/account-registration.md
View File

@ -10,6 +10,7 @@ This extension is intended for creating user accounts on a server
## Error identifiers
- Ratelimit system: enabled
- `id_exists`: username/third party ID already taken
- `reg_disabled`: registration isn't allowed on a server
@ -66,7 +67,7 @@ This extension is intended for creating user accounts on a server
## Business Rules
- Ratelimit system: enabled
None.
## JSON Schema

8
protocol-spec/cadmium-extension-document-format.md
View File

@ -22,7 +22,7 @@ When writing use cases and the associated protocols, make sure to:
* Describe the expected behavior of Cadmium clients, servers, and components when using this protocol.
* Include lots of protocol examples.
*Example 1. An Example from Shakespeare*
*Example 1. An Example from Shakespeare*:
```json
{
@ -36,13 +36,13 @@ When writing use cases and the associated protocols, make sure to:
}
```
## Error Codes
## Errors
If your proposal defines a number of error and status codes, it is a good idea to include a table of all the codes defined in your document.
If your proposal defines a number of error and error identifiers, it is a good idea to include a table of all the identifiers defined in your document.
## Business Rules
You may want to include a section describing various business rules (essentially, a variety of MUSTs, SHOULDs, and MAYs regarding application behavior). This is not required but can be helpful to implementers.
You may want to include a section describing various business rules (essentially, a variety of MUSTs, SHOULDs, and MAYs regarding application behavior). This section is not required but can be helpful to implementers.
## Implementation Notes