From 8baa9d6f768ad2024dae6f93a5d792f4f3fc4f6b Mon Sep 17 00:00:00 2001
From: Veikkosuhonen <vesuvesuh@gmail.com>
Date: Mon, 29 Apr 2024 15:45:41 +0300
Subject: [PATCH] More api docs!

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

diff --git a/README.md b/README.md
index f8f3eac..07fc0a5 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ Jami API should now be available at http://localhost:3000/. Configure the port f
 
 ## API
 
-`POST /`
+### `POST /`
 
 - Body
 
@@ -51,7 +51,15 @@ Jami API should now be available at http://localhost:3000/. Configure the port f
 }
 ```
 
-`GET /:userId`
+### `POST /user-organisations`
+
+- Response
+
+```ts
+Array<Faculty>
+```
+
+### `GET /:userId`
 
 - Response
 
@@ -62,7 +70,7 @@ Jami API should now be available at http://localhost:3000/. Configure the port f
 }
 ```
 
-`GET /access-to-all`
+### `GET /access-to-all`
 
 - Response
 
@@ -85,11 +93,11 @@ Jami API should now be available at http://localhost:3000/. Configure the port f
 }
 ```
 
-`GET /organisation-data`
+### `GET /organisation-data`
 
 - Response: the FACULTIES object from [./src/organisation/faculties.ts](./src/organisation/faculties.ts)
 
-`GET /all-access`
+### `GET /all-access`
 
 - Response: all user's iam groups and their computed access rights:
 
@@ -116,7 +124,7 @@ Jami API should now be available at http://localhost:3000/. Configure the port f
   ]
 ```
 
-`GET /iam-groups`
+### `GET /iam-groups`
 
 - Response: all unique iam groups in Jami DB:
 
@@ -126,6 +134,4 @@ Jami API should now be available at http://localhost:3000/. Configure the port f
 
 ### Other routes
 
-`GET` `/ping`
-
-`POST` `user-organisations`
+`GET` `/ping` => `pong`