summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2019-12-11 14:34:09 +0100
committerChristian Grothoff <christian@grothoff.org>2019-12-11 14:34:09 +0100
commite3a6f4fde54052f9b4e6f959fe5e94cbc96ffe51 (patch)
tree2e600b5a705ac386e0e3c78e3f1721688617c254 /core
parent44d7b29a9554f3a359a57c3fafc6702f212456ee (diff)
downloaddocs-e3a6f4fde54052f9b4e6f959fe5e94cbc96ffe51.tar.gz
docs-e3a6f4fde54052f9b4e6f959fe5e94cbc96ffe51.tar.bz2
docs-e3a6f4fde54052f9b4e6f959fe5e94cbc96ffe51.zip
document /privacy, and missing Etag case
Diffstat (limited to 'core')
-rw-r--r--core/api-exchange.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 13c35d5..5fa7fe7 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -56,6 +56,25 @@ possibly by using HTTPS.
to detect if the terms of service have changed. If not, a
"204 Not Modified" response will be returned.
+ If the "Etag" is missing, the client should not cache the response and instead prompt the user again at the next opportunity. This is usually only the case if the terms of service were not configured correctly.
+
+
+ .. http:get:: /privacy
+
+ Get the privacy policy of the exchange.
+ The exchange will consider the "Accept" and "Accept-Language" and
+ "Accept-Encoding" headers when generating a response. Specifically,
+ it will try to find a response with an acceptable mime-type, then
+ pick the version in the most preferred language of the user, and
+ finally apply compression if that is allowed by the client and
+ deemed beneficial.
+
+ The exchange will set an "Etag", and subsequent requests of the
+ same client should provide the tag in an "If-None-Match" header
+ to detect if the privacy policy has changed. If not, a
+ "204 Not Modified" response will be returned.
+
+ If the "Etag" is missing, the client should not cache the response and instead prompt the user again at the next opportunity. This is usually only the case if the privacy policy was not configured correctly.
.. http:get:: /keys