Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/lookup-server.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjoern Schiessle <bjoern@schiessle.org>2017-06-22 18:53:04 +0300
committerBjoern Schiessle <bjoern@schiessle.org>2017-06-22 18:53:04 +0300
commitad2808c70b4bc7cce9d66b4b77690d5c61f9d1db (patch)
tree17f56a42101e25fdf919f50ab8539a8af92598a6
parentf79f34ef1327a88bcce35df25b0d6ca1c2f11903 (diff)
update documentation with the additional search parameters
Signed-off-by: Bjoern Schiessle <bjoern@schiessle.org>
-rwxr-xr-xdoc/architecture.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/architecture.md b/doc/architecture.md
index 2a39f09..1c47e69 100755
--- a/doc/architecture.md
+++ b/doc/architecture.md
@@ -113,6 +113,15 @@ This call can be used to search for a user in a fuzzy way
Example:
curl -X GET http://dev/nextcloud/lookup-server/server/users?search=searchstring
+Add a additional parameter to search for an exact match, for example:
+curl -X GET http://dev/nextcloud/lookup-server/server/users?search=searchstring&exact=1
+
+If you want to limit the exact search to a specific parameter, e.g the email address you can do following:
+curl -X GET http://dev/nextcloud/lookup-server/server/users?search=searchstring&exact=1&keys=["email"]
+
+To get the verification result of a users Twitter account or email address we can search for a specific users cloud ID:
+curl -X GET http://dev/nextcloud/lookup-server/server/users?search=<federated-cloud-id>&exactCloudId=1
+
### Get replication log
This call is used for master-master replication between different nodes.
Example: