From 5647ed2be5cc69d25e393fc3a511bb0959566367 Mon Sep 17 00:00:00 2001
From: Christian Grothoff <christian@grothoff.org>
Date: Tue, 27 Jan 2015 22:20:57 +0100
Subject: document /withdraw/* operations

---
 src/mint/taler-mint-httpd_withdraw.c | 13 +++++++++++--
 src/mint/taler-mint-httpd_withdraw.h | 13 +++++++++++--
 2 files changed, 22 insertions(+), 4 deletions(-)

(limited to 'src')

diff --git a/src/mint/taler-mint-httpd_withdraw.c b/src/mint/taler-mint-httpd_withdraw.c
index 8c74b72b6..957d684fe 100644
--- a/src/mint/taler-mint-httpd_withdraw.c
+++ b/src/mint/taler-mint-httpd_withdraw.c
@@ -29,7 +29,10 @@
 
 
 /**
- * Handle a "/withdraw/status" request
+ * Handle a "/withdraw/status" request.  Parses the
+ * given "reserve_pub" argument (which should contain the
+ * EdDSA public key of a reserve) and then respond with the
+ * status of the reserve.
  *
  * @param rh context of the handler
  * @param connection the MHD connection to handle
@@ -62,7 +65,13 @@ TALER_MINT_handler_withdraw_status (struct RequestHandler *rh,
 
 
 /**
- * Handle a "/withdraw/sign" request
+ * Handle a "/withdraw/sign" request.  Parses the "reserve_pub"
+ * EdDSA key of the reserve and the requested "denom_pub" which
+ * specifies the key/value of the coin to be withdrawn, and checks
+ * that the signature "reserve_sig" makes this a valid withdrawl
+ * request from the specified reserve.  If so, the envelope
+ * with the blinded coin "coin_ev" is passed down to execute the
+ * withdrawl operation.
  *
  * @param rh context of the handler
  * @param connection the MHD connection to handle
diff --git a/src/mint/taler-mint-httpd_withdraw.h b/src/mint/taler-mint-httpd_withdraw.h
index 6587a194f..2c53a6d92 100644
--- a/src/mint/taler-mint-httpd_withdraw.h
+++ b/src/mint/taler-mint-httpd_withdraw.h
@@ -27,7 +27,10 @@
 #include "taler-mint-httpd.h"
 
 /**
- * Handle a "/withdraw/status" request
+ * Handle a "/withdraw/status" request.  Parses the
+ * given "reserve_pub" argument (which should contain the
+ * EdDSA public key of a reserve) and then respond with the
+ * status of the reserve.
  *
  * @param rh context of the handler
  * @param connection the MHD connection to handle
@@ -45,7 +48,13 @@ TALER_MINT_handler_withdraw_status (struct RequestHandler *rh,
 
 
 /**
- * Handle a "/withdraw/sign" request
+ * Handle a "/withdraw/sign" request.  Parses the "reserve_pub"
+ * EdDSA key of the reserve and the requested "denom_pub" which
+ * specifies the key/value of the coin to be withdrawn, and checks
+ * that the signature "reserve_sig" makes this a valid withdrawl
+ * request from the specified reserve.  If so, the envelope
+ * with the blinded coin "coin_ev" is passed down to execute the
+ * withdrawl operation.
  *
  * @param rh context of the handler
  * @param connection the MHD connection to handle
-- 
cgit v1.2.3