Added swagger info text.

RossBugginsNHS · Nov 23, 2023 · 217f464 · 217f464
1 parent af411d9
commit 217f464
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/commcheck-api/src/src/Program.cs b/commcheck-api/src/src/Program.cs
@@ -75,10 +75,17 @@ not use data sources directly.
 
         Available at the readme github repo is source for a cli tool for directly calling the api.
 
+        - GET /check/results provides a list of the last 100 queries
+        - GET /check/results/stream can be used to provide a realtime stream of requests.
 
-        GET /check/results provides a list of the last 100 queries
+        Notes for data payload:
+        - Relative Date - this is used to calculate any date spans, for example Age based on Date of birth. 
+        - Dob will be always set to first day of the month.
+        - Postcode will be set to first 4 characters of postcode.
 
-        GET /check/results/stream can be used to provide a realtime stream of requests.
+        Notes for API:
+        - The api is deterministic. It will always give the same result based on input data (as long as the rule set is the same)
+        - Metrics for the API can be found at GET /metrics endpoint.
         """;