web interface to add co-administrators

[syp.git] / devdoc / api.txt

diff --git a/devdoc/api.txt b/devdoc/api.txt
index cc1413e78b94de01a3009dff96e418787cc40302..8cc6fefa376b72952f3d88ecc27007e380190fc3 100644 (file)
--- a/devdoc/api.txt
+++ b/devdoc/api.txt
@@ -11,12 +11,22 @@ Client submits a classic html form to server.
 **note**: In this documentation, php notation is used (`_POST` and `_FILES`),
 but server may be written in any language.
 
+` _POST["password"]` and `_POST["user"] may contain user name and password. If
+ they are set, access is checked. If they is not set, cookies are checked. If
+ neither are present.
+
 `_POST["request"]` is either:
 
 ## auth
  asks for authentication
 
- * ` _POST["password"]` must contains user password
+## newuser
+ adds a new user
+ * `$_POST ["newuser_name"]` must contain user name
+ * `$_POST ["newuser_password"]` must contain user password
+
+ Only admin can add new users.
+
 
 ## add
  adds a new feature
@@ -69,11 +79,15 @@ as _text/html_
  * `toobig`: uploaded file was too big
  * `notation`: uploaded file was not an image
  * `nochange`: when trying to update a feature, there is nothing to update (ie: no field of the feature has changed)
+ * `newuser_exists`: when trying to add an user which has the same name as an already registered user
 
 ## success handling:
 
- * `<success request="auth"></success>`:
-     authentication was successfull
+ * `<success request="auth"><user>?user_name?</name></success>`:
+     authentication was successfull. ?user_name? is name of authenticated user.
+
+ * `<success request="newuser"><user>?user_name?</name></success>`:
+     new user addition was successfull. ?user_name? is name of newly added user.
 
  * `<success request="del">
      <feature>