From ff9dc0ad5aa9b79fb63164c6e43309751c7c4ce3 Mon Sep 17 00:00:00 2001
From: "Sky \"g3ner1c\" Hong" <g3ner1c-sky@pm.me>
Date: Thu, 1 Dec 2022 16:57:55 -0500
Subject: [PATCH] add api/query to documentation and fixed incorrect parameter
 name

---
 .vscode/settings.json |  5 ++-
 client/api-info.html  | 86 ++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 89 insertions(+), 2 deletions(-)

diff --git a/.vscode/settings.json b/.vscode/settings.json
index 2185be716..c927ed558 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -3,5 +3,8 @@
     "editor.codeActionsOnSave": {
         "source.fixAll.eslint": true
     },
-    "eslint.validate": ["javascript"]
+    "eslint.validate": ["javascript"],
+    "[html]": {
+        "editor.rulers": [120]
+    }
 }
diff --git a/client/api-info.html b/client/api-info.html
index 0a6166790..f995661a5 100644
--- a/client/api-info.html
+++ b/client/api-info.html
@@ -165,12 +165,96 @@
                     </li>
                 </ul>
             </li>
+            <li class="list-group-item">
+                <div>POST <code>qbreader.org/api/query</code></div>
+                <div>Parameters:</div>
+                <ul>
+                    <li>
+                        <code>questionType</code> - a <b>string</b> that either equals "tossup", "bonus", or "all".
+                        Otherwise, returns a <code>400 Bad Request</code> response.
+                    </li>
+                    <li>
+                        <code>searchType</code> - a <b>string</b> that either equals "tossup" or "bonus".
+                        Otherwise, returns a <code>400 Bad Request</code> response.
+                    </li>
+                    <li>
+                        [optional] <code>queryString</code> - a <b>string</b> that the query is searching for.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> it defaults to an empty string.</li>
+                        </ul>
+
+                    </li>
+                    <li>
+                        [optional] <code>regex</code> - a <b>boolean</b> that indicates whether <code>queryString</code>
+                        should be treated as a regular expression.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> it defaults to <code>false</code>.</li>
+                        </ul>
+                    </li>
+                    <li>
+                        [optional] <code>randomize</code> - a <b>boolean</b> that indicates whether the results should
+                        be in random order.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> it defaults to <code>false</code>.</li>
+                        </ul>
+                    </li>
+                    <li>
+                        [optional] <code>setName</code> - a <b>string</b> that is the name of the set to search in.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> then all sets are searched.</li>
+                        </ul>
+                    <li>
+                        [optional] <code>difficulties</code> - an <b>array of numbers</b> representing the valid
+                        possible difficulties.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> then all difficulties are allowed.</li>
+                            <li>Can also be a <b>string</b> or <b>number</b> if there is only 1 difficulty you want to
+                                select.</li>
+                        </ul>
+                    </li>
+                    <li>
+                        [optional] <code>categories</code> - an <b>array of strings</b> that contain the allowed
+                        categories.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> then all categories are allowed.</li>
+                            <li>Can also be a <b>string</b> if there is only 1 category.</li>
+                            <li>Take special care to ensure that the first letter of each word of the category is
+                                capitalized.</li>
+                        </ul>
+                    </li>
+                    <li>
+                        [optional] <code>subcategories</code> - an <b>array of strings</b> that contain the allowed
+                        subcategories.
+                        <ul>
+                            <li>If <b>undefined or omitted,</b> then all subcategories are allowed.</li>
+                            <li>Can also be a <b>string</b> if there is only 1 subcategory.</li>
+                            <li>Take special care to ensure that the first letter of each word of the subcategory is
+                                capitalized.</li>
+                            <li>This api endpoint does <b>not</b> check for consistency between categories and
+                                subcategories.</li>
+                            <li><i>For example, requesting the "history" and the "biology" and "chemistry" subcategories
+                                    will return no questions.</i></li>
+                        </ul>
+                    </li>
+                    <li>
+                        [optional] <code>maxQueryReturnLength</code> - a <b>number</b> that specifies the maximum number
+                        of questions to return
+                        <ul>
+                            <li>If <b>0, negative, undefined, or omitted,</b> then the default is 50.</li>
+                            <li>If <b>greater than 200,</b> the query will return no more than 200 questions.</li>
+                        </ul>
+                    </li>
+                    <li>
+                        <b>returns</b> - a <b>JSON object</b> of questions.
+                    </li>
+                </ul>
+            </li>
             <li class="list-group-item">
                 <div>POST <code>qbreader.org/api/random-question</code></div>
                 <div>Parameters:</div>
                 <ul>
                     <li>
-                        <code>type</code> - a string that either equals "tossup" or "bonus".
+                        <code>questionType</code> - a <b>string</b> that either equals "tossup" or "bonus".
                         Otherwise, returns a <code>400 Bad Request</code> response.
                     </li>
                     <li>