aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx/rest.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sphinx/rest.rst')
-rw-r--r--doc/sphinx/rest.rst35
1 files changed, 33 insertions, 2 deletions
diff --git a/doc/sphinx/rest.rst b/doc/sphinx/rest.rst
index 605fc9f..7341992 100644
--- a/doc/sphinx/rest.rst
+++ b/doc/sphinx/rest.rst
@@ -141,6 +141,39 @@ In the following, UUID is always defined and used according to `RFC 4122`_.
141 141
142.. _`RFC 4122`: https://tools.ietf.org/html/rfc4122 142.. _`RFC 4122`: https://tools.ietf.org/html/rfc4122
143 143
144.. http:get:: /policy/$ACCOUNT_PUB/meta[?max_version=$NUMBER]
145
146 Get meta data about a customer's encrypted recovery documents.
147 If ``max_version`` is specified, only return results up to the
148 given version number. The response may not contain meta data
149 for all versions if there are way too many. In this case,
150 ``max_version`` must be used to incrementally fetch more versions.
151
152 **Response**:
153
154 :http:statuscode:`200 OK`:
155 The escrow provider responds with a RecoveryMetaSummary_ object.
156 :http:statuscode:`400 Bad request`:
157 The ``$ACCOUNT_PUB`` is not an EdDSA public key.
158 :http:statuscode:`402 Payment Required`:
159 The account's balance is too low for the specified operation.
160 See the Taler payment protocol specification for how to pay.
161 :http:statuscode:`404 Not found`:
162 The requested resource was not found.
163
164 **Details:**
165
166 .. _RecoveryMetaSummary:
167 .. ts:def:: RecoveryMetaSummary
168
169 interface RecoveryMetaSummary {
170 // Version numbers as a string (!) are used as keys,
171 // the value being the base32-encoded encrypted meta data
172 // for that version. A value can be NULL if the document
173 // exists but no meta data was provided.
174 "$VERSION": EncryptedMetaData;
175 }
176
144.. http:get:: /policy/$ACCOUNT_PUB[?version=$NUMBER] 177.. http:get:: /policy/$ACCOUNT_PUB[?version=$NUMBER]
145 178
146 Get the customer's encrypted recovery document. If ``version`` 179 Get the customer's encrypted recovery document. If ``version``
@@ -173,8 +206,6 @@ In the following, UUID is always defined and used according to `RFC 4122`_.
173 :http:statuscode:`402 Payment Required`: 206 :http:statuscode:`402 Payment Required`:
174 The account's balance is too low for the specified operation. 207 The account's balance is too low for the specified operation.
175 See the Taler payment protocol specification for how to pay. 208 See the Taler payment protocol specification for how to pay.
176 :http:statuscode:`403 Forbidden`:
177 The required account signature was invalid.
178 :http:statuscode:`404 Not found`: 209 :http:statuscode:`404 Not found`:
179 The requested resource was not found. 210 The requested resource was not found.
180 211