From 6ae5895736af8f0fd8a38178330617d1372684d3 Mon Sep 17 00:00:00 2001
From: Ajay Ramachandran <dev@ajay.app>
Date: Sun, 27 Jun 2021 19:23:57 -0400
Subject: [PATCH] Changes by blabdude - Add userID endpoint

---
 API-Docs.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/API-Docs.md b/API-Docs.md
index b391cd6..beb717a 100644
--- a/API-Docs.md
+++ b/API-Docs.md
@@ -435,6 +435,33 @@ __________________________________________________________________
 
 __________________________________________________________________
 
+##### **GET** `/api/userID`
+
+**Input** (URL Parameters):
+```js
+{
+  username: string, // search string for username
+  // minimum for non-exact search is 3 characters, maximum is 64 characters
+  exact: Boolean // if explicitly set to true, searches for exact username
+}
+```
+
+**Response**:
+```js
+[{ // Array of this object - maximum 10 results
+  userName: string,
+  userID: string
+}]
+```
+
+**Error codes**:
+
+400: Bad Request (Your inputs are wrong/impossible) or exceed the character limits
+
+404: Not Found
+
+__________________________________________________________________
+
 ### VIP Calls
 
 These can only be called by the users added to the VIP table.