some more API documentation for these password reset request methods

git-svn-id: svn://svn.open-ils.org/ILS/trunk@16562 dcc99617-32d9-48b4-a31d-7c20da2025e4

diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm b/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
index f9d8934..061122f 100644 (file)
--- a/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
+++ b/Open-ILS/src/perlmods/OpenILS/Application/Actor.pm
@@ -3690,11 +3690,15 @@ __PACKAGE__->register_method(
        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 @@ __PACKAGE__->register_method(
        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) = @_;