(no commit message)
authorGreg Burri <greg.burri@gmail.com>
Tue, 22 Apr 2008 07:13:37 +0000 (07:13 +0000)
committerGreg Burri <greg.burri@gmail.com>
Tue, 22 Apr 2008 07:13:37 +0000 (07:13 +0000)
doc/protocole3.txt

index fdb68df..2ce1a9e 100644 (file)
@@ -1,15 +1,13 @@
 Euphorik - Protocole v3
 -----------------------
 
-A. Introduction
----------------
+== Introduction ==
 Ce document a pour but de décrire la communication client-serveur du site euphorik.\r
 Les messages échangés sont basés sur le format JSON.
 Ce document remplace 'protocole2.txt'.
 \r
 
-B. Principes
-------------
+== Principes ==
 Enregistrement:\r
  * Permet de créer un compte, un cookie est donné en retour. Ce cookie doit être stocké par le client pour pouvoir s'authentifier par la suite.
 
@@ -23,8 +21,7 @@ Rafraichissement:
  * Dès qu'un nouveau message arrive, le serveur débloque la connexion et envoie le ou les messages manquants.
  
 
-C. Protocole
-------------
+== Protocole ==
 c : client
 s : server
 Les messages client vers serveur sont envoyés par HTTP-POST.
@@ -43,8 +40,7 @@ Message ok g
    }
 
 
-C.1. Login
-----------
+=== Login ===
 Le mot de passe est hashé en md5.\r
 
 c -> s\r
@@ -85,8 +81,7 @@ s -> c
    }
  \r
  
-C.2. Logout
------------
+=== Logout ===
 c -> s\r
    {\r
       "action" : "logout",\r
@@ -94,8 +89,7 @@ c -> s
    }
  \r
  
-C.3. Profile
-------------
+=== Profile ===
 
 c -> s\r
    {\r
@@ -121,8 +115,7 @@ ou
    <error>
 
 
-C.4. Wait event
----------------------
+=== Wait event ===
 Si "last_message_id" est absent alors le client ne possède pas de message.
 Les conversations données sont définies dans le profile.
 
@@ -181,9 +174,7 @@ ou
    }
 \r
 \r
-C.5. Envoie troll\r
--------------------\r
-\r
+=== Envoie d'un troll ===\r
 c -> s\r
    {\r
       "action" : "put_troll",\r
@@ -196,10 +187,15 @@ s -> c
       "reply" : "ok" | "error",\r
       "error_message" : "blabla"\r
    }\r
-   
+   \r
+=== Modification d'un troll ===\r
+TODO\r
+=== Demande de trolls ===\r
+TODO\r
+=== Suppression d'un troll ===\r
+TODO
 
-C.6. Envoie message
--------------------
+=== Envoie message ===
 Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
 "answer_to" n'est pas obligatoire.\r
 
@@ -220,8 +216,7 @@ s -> c
    }
  \r
  \r
-C.7. Ajout d'une correction d'un messages\r
-----------------------------------------\r
+=== Ajout d'une correction d'un messages ===\r
 Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
 Le message est appondu avec un " +++ " devant, par exemple :\r
 > Gnome c'est mieux que KDE +++ Euh non ok, c'est faux\r