From fad984032292f3dd55412dcd7787ffc4544e316e Mon Sep 17 00:00:00 2001
From: Dan Jones <dan.jones@noc.ac.uk>
Date: Mon, 14 Nov 2022 17:08:39 +0000
Subject: [PATCH] docs: explain auth placeholder code

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index e64b191..b6c2374 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,15 @@ decided what the infrastructure looks like.
 There is a parallel flow when a client sends to `client-a-notify` in which case the 
 messages are delivered through the broadcast exchange to all clients `client-x-inbox`.
 
+### Auth placeholder 
+
+As a proxy for proper authentication, when you post a client a random secret is 
+returned in the response. To send to / receive from the bus you then call the API
+with the client_id and secret and it checks they match. The client_id determines 
+which queues it reads from. 
+
+Subsequent requests to the client endpoint return the client_id but not the secret.
+
 ### Setup 
 
 ```
-- 
GitLab