interface to change password

[syp.git] / devdoc / api.txt

diff --git a/devdoc/api.txt b/devdoc/api.txt
index 8cc6fefa376b72952f3d88ecc27007e380190fc3..804c0c4d4baba7295f629a5d0af4d1651e0c8087 100644 (file)
--- a/devdoc/api.txt
+++ b/devdoc/api.txt
@@ -20,6 +20,12 @@ but server may be written in any language.
 ## auth
  asks for authentication
 
+## changepass
+ change user password
+ * `$_POST ["pass_current"]` must contain current password. This is needed: cookie
+    authentification is not enough.
+ * `$_POST ["pass_new"]` must contain new password
+
 ## newuser
  adds a new user
  * `$_POST ["newuser_name"]` must contain user name
@@ -79,6 +85,7 @@ 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)
+ * `wrongpass`: wrong current password when trying to change password
  * `newuser_exists`: when trying to add an user which has the same name as an already registered user
 
 ## success handling:
@@ -89,6 +96,10 @@ as _text/html_
  * `<success request="newuser"><user>?user_name?</name></success>`:
      new user addition was successfull. ?user_name? is name of newly added user.
 
+ * `<success request="changepass"><user>?user_name?</name></success>`:
+     password change was successfull. ?user_name? is name user whose password
+     has been changed.
+
  * `<success request="del">
      <feature>
         <id>?id?</id>