[open-ils-commits] r16562 - trunk/Open-ILS/src/perlmods/OpenILS/Application (phasefx)

[svn at svn.open-ils.org]

Author: phasefx
Date: 2010-06-02 14:46:24 -0400 (Wed, 02 Jun 2010)
New Revision: 16562

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
Log:
some more API documentation for these password reset request methods

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm	2010-06-02 18:28:26 UTC (rev 16561)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm	2010-06-02 18:46:24 UTC (rev 16562)
@@ -3690,11 +3690,15 @@
 	method	=> "request_password_reset",
 	api_name	=> "open-ils.actor.patron.password_reset.request",
 	signature	=> {
+        desc => "Generates a UUID token usable with the open-ils.actor.patron.password_reset.commit " .
+                "method for changing a user's password.  The UUID token is distributed via A/T "      .
+                "templates (i.e. email to the user).",
         params => [
             { desc => 'user_id_type', type => 'string' },
             { desc => 'user_id', type => 'string' },
-        ]
-    },
+        ],
+        return => {desc => '1 on success, Event on error'}
+    }
 );
 sub request_password_reset {
     my($self, $conn, $user_id_type, $user_id) = @_;
@@ -3835,11 +3839,15 @@
 	method	=> "commit_password_reset",
 	api_name	=> "open-ils.actor.patron.password_reset.commit",
 	signature	=> {
+        desc => "Checks a UUID token generated by the open-ils.actor.patron.password_reset.request method for " .
+                "validity, and if valid, uses it as authorization for changing the associated user's password " .
+                "with the supplied password.",
         params => [
             { desc => 'uuid', type => 'string' },
             { desc => 'password', type => 'string' },
-        ]
-    },
+        ],
+        return => {desc => '1 on success, Event on error'}
+    }
 );
 sub commit_password_reset {
     my($self, $conn, $uuid, $password) = @_;