From 394e261b9155ab702efd41dbc22dddd5b5389eee Mon Sep 17 00:00:00 2001
From: "Welter, Felix" <felix.welter@studium.uni-hamburg.de>
Date: Mon, 31 Aug 2020 13:05:27 +0200
Subject: [PATCH] Add first draft of the request convention.
---
REQUEST_FORMAT.md | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
create mode 100644 REQUEST_FORMAT.md
diff --git a/REQUEST_FORMAT.md b/REQUEST_FORMAT.md
new file mode 100644
index 0000000..b5f8a0e
--- /dev/null
+++ b/REQUEST_FORMAT.md
@@ -0,0 +1,20 @@
+# Request format
+All micro services for the related items system adhere to the following conventions.
+
+The micro service is queried via the POST endpoint: `/search`.
+The request contains the POST params `term` and `context`.
+
+The micro service returns a json object containing the response `type`
+and type-dependent data. e.g.
+```
+{
+ "type": "image",
+ "path": "/path/to/image"
+}
+```
+
+```
+{
+ "type": "miss"
+}
+```
--
GitLab