From 0688f8849d283dc5e1fa7c03d01ec97395b61e29 Mon Sep 17 00:00:00 2001 From: ChronosX88 Date: Thu, 26 Dec 2019 17:41:23 +0400 Subject: [PATCH] Fix CEDF --- protocol-spec/account-login-by-username.md | 5 +++-- protocol-spec/account-registration.md | 3 ++- protocol-spec/cadmium-extension-document-format.md | 8 ++++---- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/protocol-spec/account-login-by-username.md b/protocol-spec/account-login-by-username.md index 27c69bf..cec0e6d 100644 --- a/protocol-spec/account-login-by-username.md +++ b/protocol-spec/account-login-by-username.md @@ -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 diff --git a/protocol-spec/account-registration.md b/protocol-spec/account-registration.md index 570d946..9224723 100644 --- a/protocol-spec/account-registration.md +++ b/protocol-spec/account-registration.md @@ -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 diff --git a/protocol-spec/cadmium-extension-document-format.md b/protocol-spec/cadmium-extension-document-format.md index 51276f3..98d9dd6 100644 --- a/protocol-spec/cadmium-extension-document-format.md +++ b/protocol-spec/cadmium-extension-document-format.md @@ -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