summaryrefslogtreecommitdiff
path: root/core/api-sync.rst
diff options
context:
space:
mode:
Diffstat (limited to 'core/api-sync.rst')
-rw-r--r--core/api-sync.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/core/api-sync.rst b/core/api-sync.rst
index 51e429e4..c2c86c23 100644
--- a/core/api-sync.rst
+++ b/core/api-sync.rst
@@ -18,7 +18,7 @@
.. _sync-api:
======================================
-Backup and Synchronization Service API
+Backup and Synchronization RESTful API
======================================
The backup and synchronization service uses an EdDSA key
@@ -102,6 +102,9 @@ over TLS, and that the synchronization service is trusted to not build
user's location profiles by linking client IP addresses and client
keys.
+.. contents:: Table of Contents
+ :local:
+
.. include:: tos.rst
@@ -112,6 +115,7 @@ Receiving Configuration
.. http:get:: /config
Obtain the key configuration settings of the storage service.
+ This specification corresponds to ``current`` protocol being version **2**.
**Response:**
@@ -137,6 +141,10 @@ Receiving Configuration
// The format is "current:revision:age".
version: string;
+ // URN of the implementation (needed to interpret 'revision' in version).
+ // @since v2, may become mandatory in the future.
+ implementation?: string;
+
}
.. _sync: