[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: spec for GET /tips
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: spec for GET /tips |
Date: |
Fri, 05 Jun 2020 19:29:22 +0200 |
This is an automated email from the git hooks/post-receive script.
jonathan-buchanan pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new c028b2d spec for GET /tips
c028b2d is described below
commit c028b2d151aaacb446035638379f565e8e5c30cd
Author: Jonathan Buchanan <jonathan.russ.buchanan@gmail.com>
AuthorDate: Fri Jun 5 13:29:09 2020 -0400
spec for GET /tips
---
core/api-merchant.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 44 insertions(+)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 317480f..3bde039 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1955,6 +1955,50 @@ Giving Customer Tips
expiration: Timestamp;
}
+
+
+.. http:get:: /tips
+
+ Return the list of all tips.
+
+ **Request:**
+
+ :query expired: *Optional*. If set to "yes", the response also includes
+ tips that have expired. Otherwise only unexpired tips are returned.
+
+ **Response:**
+
+ :status 200 OK:
+ The backend has successfully found the list of tips. The backend responds
+ with a `TipsResponse`.
+
+ .. ts:def:: TipsResponse
+
+ interface TipsResponse {
+
+ // List of tips that are present in the backend.
+ tips: Tip[];
+ }
+
+ .. ts:def:: Tip
+
+ interface Tip {
+
+ // Unique identifier for the tip.
+ tip_id: HashCode;
+
+ // Exchange from which the tip will be withdrawn.
+ exchange_url: string;
+
+ // (remaining) amount of the tip (including fees).
+ tip_amount: Amount;
+
+ // Timestamp indicating when the tip is set to expire (may be in the
past).
+ expiration: Timestamp;
+ }
+
+
+
.. http:post:: /tips/$TIP_ID/pickup
Handle request from wallet to pick up a tip.
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: spec for GET /tips,
gnunet <=