From ad0c60cc4f0a6fd22f82deff67e8cf7ffd4314a0 Mon Sep 17 00:00:00 2001
From: valentinkolb <valentin.kolb@uni-ulm.de>
Date: Wed, 27 Mar 2024 18:18:43 +0100
Subject: [PATCH] docs(Readme.md): Update Readme

---
 Readme.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

diff --git a/Readme.md b/Readme.md
index e1b222d..59689e5 100644
--- a/Readme.md
+++ b/Readme.md
@@ -216,6 +216,87 @@ Es wird überprüft, ob der User der das GET Request schickt in der `LDAP_ADMIN_
 curl -X GET https://it.stuve.uni-ulm.de/api/ldap/search -d '{"baseDN": "ou=useraccounts,ou=user,dc=stuve,dc=uni-ulm,dc=de", "filter": "(cn=vorname.nachname)"}'
 ```
 
+Als return wir ein JSON Objekt nach folgendem Schema zurückgegeben:
+
+```json
+{
+  "Entries": [
+    {
+      "DN": "CN=vorname.nachname,OU=UserAccounts,OU=User,DC=stuve,DC=uni-ulm,DC=de",
+      "Attributes": [
+        {
+          "Name": "cn",
+          "Values": [
+            "vorname.nachname"
+          ],
+          "ByteValues": [
+            "xxxxxxxxxxxxxxx"
+          ]
+        }
+      ]
+    }
+  ],
+  "Referrals": [],
+  "Controls": []
+}
+```
+
+Json Schemata:
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "Entries": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "DN": {
+            "type": "string"
+          },
+          "Attributes": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "Name": {
+                  "type": "string"
+                },
+                "Values": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "ByteValues": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "required": ["Name", "Values", "ByteValues"]
+            }
+          }
+        },
+        "required": ["DN", "Attributes"]
+      }
+    },
+    "Referrals": {
+      "type": "array",
+      "items": {}
+    },
+    "Controls": {
+      "type": "array",
+      "items": {}
+    }
+  },
+  "required": ["Entries", "Referrals", "Controls"]
+}
+```
+
 ### LDAP Sync
 
 Dieses Package ist das umfangreichste Package und synchronisiert