From 0c2ca9b68867dc470b8cca90e7d71e4fb66ec0c2 Mon Sep 17 00:00:00 2001
From: ChronosX88 <chronosx88@gmail.com>
Date: Sun, 17 Nov 2019 20:56:07 +0400
Subject: [PATCH] Define create account feature, slightly change error
 processing section

---
 protocol-spec/core.md | 74 +++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 71 insertions(+), 3 deletions(-)

diff --git a/protocol-spec/core.md b/protocol-spec/core.md
index bcb6ab3..8326fe2 100644
--- a/protocol-spec/core.md
+++ b/protocol-spec/core.md
@@ -5,6 +5,8 @@
   - [Entity ID](#entity-id)
   - [BaseMessage](#basemessage)
   - [Errors](#errors)
+  - [Account registration/login](#account-registrationlogin)
+    - [Create account](#create-account)
 
 ## Transport
 For starting we simply use JSON + Websockets.
@@ -41,11 +43,11 @@ Mechanism of error processing included into protocol.
 Adds into type name `:error` postfix.
 
 **Payload**:
-* `errCode: int` - error code (defined in extensions. Error code which defined in the specific extension MUST NOT overlap with other error codes)
+* `errCode: int` - error code (defined in extensions, may be same per extensions)
 * `errText: String` - explanation of error in human-readable view
 * `errPayload: Map<K,V>` - advanced error information (fields defined in extensions)
 
-**Example**:  
+**Usecase**:  
 
 *Request*:
 ```json
@@ -73,4 +75,70 @@ Adds into type name `:error` postfix.
         "errPayload": {}
     }
 }
-```
\ No newline at end of file
+```
+
+## Account registration/login
+### Create account
+**Description**: Create user account on a server  
+**Type**: `profile:register`  
+**Payload**:
+- Request: 
+  - `username: string` - the username that the user wants to register
+  - `thirdPIDs: []` - array of user third party IDs (email and/or MSISDN). Array contains objects with following fields: 
+    - `type: string` - type of third party ID.
+    - `value: string` - string contains third party ID. Examples: `juliet@capulett.com`, `+1234567890`.
+  - `password` - password of new account
+- Response:
+  - `userID: EntityID`- ID of user (Username in priority. If we haven't username, then we put to this field one of user's third party IDs).  
+
+**Errors**:
+- 0: username/third party ID already taken
+- 1: registration isn't allowed on a server
+
+**Usecase**:
+
+*Request*:
+```json
+{
+    "id": "abcd",
+    "type": "profile:register",
+    "to": "cadmium.org",
+    "payload": {
+        "username": "juliet",
+        "thirdPIDs": [
+            {"type":"email", "value":"juliet@capulett.com"},
+            {"type":"msisdn", "value":"+1234567890"},
+        ],
+        "password": "romeo1"
+    }
+}
+```
+
+*Response*:
+```json
+{
+    "id": "abcd",
+    "type": "profile:register",
+    "from": "cadmium.org",
+    "ok": true,
+    "payload": {
+        "userID": "@juliet@cadmium.org"
+    }
+}
+```
+
+*<b>Error</b> response*:
+```json
+{
+    "id": "abcd",
+    "type": "profile:register",
+    "from": "cadmium.org",
+    "ok": false,
+    "payload": {
+        "errCode": 0,
+        "errText": "{Username/email/msisdn} already taken"
+    }
+}
+```
+
+**Special business rules**: none.
\ No newline at end of file