summaryrefslogtreecommitdiff
path: root/doc/sphinx/rest.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2022-01-19 12:55:56 +0100
committerChristian Grothoff <christian@grothoff.org>2022-01-19 12:55:56 +0100
commit16bb30ce4b424fa5ada004c53721a6f3f202b538 (patch)
tree1e25885759a5b19201c972b023726dfc40c123ef /doc/sphinx/rest.rst
parentfbf87011b5129a44e2494758effc7bd6716d6d3b (diff)
downloadanastasis-16bb30ce4b424fa5ada004c53721a6f3f202b538.tar.gz
anastasis-16bb30ce4b424fa5ada004c53721a6f3f202b538.tar.bz2
anastasis-16bb30ce4b424fa5ada004c53721a6f3f202b538.zip
add meta handler and client implementation
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`_.
.. _`RFC 4122`: https://tools.ietf.org/html/rfc4122
+.. http:get:: /policy/$ACCOUNT_PUB/meta[?max_version=$NUMBER]
+
+ Get meta data about a customer's encrypted recovery documents.
+ If ``max_version`` is specified, only return results up to the
+ given version number. The response may not contain meta data
+ for all versions if there are way too many. In this case,
+ ``max_version`` must be used to incrementally fetch more versions.
+
+ **Response**:
+
+ :http:statuscode:`200 OK`:
+ The escrow provider responds with a RecoveryMetaSummary_ object.
+ :http:statuscode:`400 Bad request`:
+ The ``$ACCOUNT_PUB`` is not an EdDSA public key.
+ :http:statuscode:`402 Payment Required`:
+ The account's balance is too low for the specified operation.
+ See the Taler payment protocol specification for how to pay.
+ :http:statuscode:`404 Not found`:
+ The requested resource was not found.
+
+ **Details:**
+
+ .. _RecoveryMetaSummary:
+ .. ts:def:: RecoveryMetaSummary
+
+ interface RecoveryMetaSummary {
+ // Version numbers as a string (!) are used as keys,
+ // the value being the base32-encoded encrypted meta data
+ // for that version. A value can be NULL if the document
+ // exists but no meta data was provided.
+ "$VERSION": EncryptedMetaData;
+ }
+
.. http:get:: /policy/$ACCOUNT_PUB[?version=$NUMBER]
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`_.
:http:statuscode:`402 Payment Required`:
The account's balance is too low for the specified operation.
See the Taler payment protocol specification for how to pay.
- :http:statuscode:`403 Forbidden`:
- The required account signature was invalid.
:http:statuscode:`404 Not found`:
The requested resource was not found.