Skip to content

Improve API Consistency #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
geoffrey-wu merged 24 commits into from
Jun 17, 2023
Merged

Improve API Consistency #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d31204f
clean up `/api/multiplayer/room-list`
geoffrey-wu May 30, 2023
f447dfe
better backend organization
geoffrey-wu May 30, 2023
64b4319
add note that `formatted_answer(s)` are optional
geoffrey-wu May 30, 2023
7643add
add `packetName` and `setYear`
geoffrey-wu May 30, 2023
a1b8d45
update `/api/set-list`
geoffrey-wu May 30, 2023
4adb08c
update `/api/random-name`
geoffrey-wu May 30, 2023
fc980fc
update `/api/num-packets`
geoffrey-wu May 30, 2023
00bf855
clean up clientside `getNumPackets` logic
geoffrey-wu May 30, 2023
e41d881
update `/api/check-answer`
geoffrey-wu May 30, 2023
4552027
update random-bonus return type
geoffrey-wu May 30, 2023
f2c31e2
don't open links in new tab
geoffrey-wu May 30, 2023
87f4d63
remove unnecessary classes and links
geoffrey-wu May 30, 2023
7e21f2b
add `alternate_subcategory` to schema page
geoffrey-wu May 30, 2023
2db8788
remove `/api/random-question`
geoffrey-wu Jun 1, 2023
6502e21
better api display on small screens
geoffrey-wu Jun 1, 2023
602a445
remove `/api/random-question`
geoffrey-wu Jun 1, 2023
7893f61
better api display on small screens
geoffrey-wu Jun 1, 2023
2b17168
Merge remote-tracking branch 'origin/consistent-api' into consistent-api
geoffrey-wu Jun 1, 2023
6562ec0
cleanup random question methods
geoffrey-wu Jun 1, 2023
568aa59
organize constants into separate file
geoffrey-wu Jun 1, 2023
014aee9
increase `COOKIE_MAX_AGE` to 7 days
geoffrey-wu Jun 1, 2023
9257673
use esm instead of commonjs in backend
geoffrey-wu Jun 1, 2023
941f367
bump version number
geoffrey-wu Jun 1, 2023
dee03ab
Merge branch 'main' into consistent-api
geoffrey-wu Jun 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions bcolors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,24 @@



const bcolors = {
HEADER: '\x1b[95m',
OKBLUE: '\x1b[94m',
OKCYAN: '\x1b[96m',
OKGREEN: '\x1b[92m',
WARNING: '\x1b[93m',
FAIL: '\x1b[91m',
ENDC: '\x1b[0m',
BOLD: '\x1b[1m',
UNDERLINE: '\x1b[4m',
};
const HEADER = '\x1b[95m';
const OKBLUE = '\x1b[94m';
const OKCYAN = '\x1b[96m';
const OKGREEN = '\x1b[92m';
const WARNING = '\x1b[93m';
const FAIL = '\x1b[91m';
const ENDC = '\x1b[0m';
const BOLD = '\x1b[1m';
const UNDERLINE = '\x1b[4m';

module.exports = bcolors;
export {
HEADER,
OKBLUE,
OKCYAN,
OKGREEN,
WARNING,
FAIL,
ENDC,
BOLD,
UNDERLINE,
};
2 changes: 1 addition & 1 deletion client/about.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
</p>
<p>
Packets are collected from
<a href="https://quizbowlpackets.com/" target="_blank" rel="noopener noreferrer">quizbowlpackets.com</a>
<a href="https://quizbowlpackets.com/">quizbowlpackets.com</a>
and parsed into JSON files using a Python-based
<a href="https://github.com/geoffrey-wu/qb-packet-parser">quizbowl packet parser</a>.
If you notice any issues with packets or categorization, please report the question or contact me on discord at
Expand Down
22 changes: 15 additions & 7 deletions client/api-docs/check-answer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,7 +112,7 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<h3 class="md-4">
<div><code>GET</code> <code>qbreader.org/api/check-answer</code></div>
</h3>
Expand Down Expand Up @@ -153,9 +150,20 @@ <h4 class="mt-4 md-2" id="parameters">Parameters</h4>
<h4 class="mt-4 md-2" id="returns">Returns</h4>
</a>
<div>
An <code>array</code> of the form <code>[directive, directedPrompt]</code>.
<code class="text-muted">: ["accept" | "reject" | "prompt", string | null]</code>
A JSON <code>object</code> with the following properties:
</div>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code>directive</code><code class="text-muted">: "accept" | "reject" | "prompt"</code>
</div>
</li>
<li class="list-group-item">
<div>
<code>directedPrompt</code><code class="text-muted">: string | null</code>
</div>
</li>
</ul>
</div>
</div>

Expand Down
19 changes: 11 additions & 8 deletions client/api-docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,7 +112,7 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<p class="lead">The API documentation for QB Reader.</p>
<p>
<b>Base URL:</b> <code>https://www.qbreader.org/api</code>
Expand Down Expand Up @@ -150,10 +147,16 @@ <h5 class="mt-4 md-2">Database</h5>
<div>Query the database.</div>
</li>
<li class="list-group-item">
<a href="/api-docs/random-question">
<div><code>POST</code> <code>/random-question</code></div>
<a href="/api-docs/random-bonus">
<div><code>GET</code> <code>/random-bonus</code></div>
</a>
<div>Get random bonuses from the database.</div>
</li>
<li class="list-group-item">
<a href="/api-docs/random-tossup">
<div><code>GET</code> <code>/random-tossup</code></div>
</a>
<div>Get random questions from the database.</div>
<div>Get random tossups from the database.</div>
</li>
<li class="list-group-item">
<a href="/api-docs/packet">
Expand Down
21 changes: 11 additions & 10 deletions client/api-docs/multiplayer/room-list.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,13 +112,13 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<h3 class="md-4">
<div><code>GET</code> <code>qbreader.org/api/room-list</code></div>
</h3>

<p>
Get public rooms.
Get a list of public rooms.
</p>

<a href="#parameters" class="text-body">
Expand All @@ -142,12 +139,16 @@ <h4 class="mt-4 md-2" id="returns">Returns</h4>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code class="fst-italic">&lt;room name&gt;</code><code class="text-muted">: [number, number, boolean]</code>
<code>roomList</code><code class="text-muted">: Object[]</code>
</div>
<div>
An array of the form
<code>[<i>&lt;number of players&gt;</i>, <i>&lt;number of active players&gt;</i>,
<i>&lt;if the room is permanent&gt;</i>]</code>.
<p>An array of <code>objects</code> with the following properties:</p>
<pre class="bg-dark p-3 rounded"><code>{
roomName: string
playerCount: number
onlineCount: number
isPermanent: boolean
}</code></pre>
</div>
</li>
</ul>
Expand Down
21 changes: 15 additions & 6 deletions client/api-docs/num-packets.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,7 +112,7 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<h3 class="md-4">
<div><code>GET</code> <code>qbreader.org/api/num-packets</code></div>
</h3>
Expand Down Expand Up @@ -143,8 +140,20 @@ <h4 class="mt-4 md-2" id="parameters">Parameters</h4>
<h4 class="mt-4 md-2" id="returns">Returns</h4>
</a>
<div>
The <code>number</code> of packets in the set.
A JSON <code>object</code> with the following properties:
</div>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code>numPackets</code><code class="text-muted">: number</code>
</div>
<div>
The <code>number</code> of packets in the set.
If a set with the given name does not exist, this will be <code>0</code>,
and a <code>404</code> error will be returned.
</div>
</li>
</ul>
</div>
</div>

Expand Down
15 changes: 4 additions & 11 deletions client/api-docs/packet-bonuses.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,7 +112,7 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<h3 class="md-4">
<div><code>GET</code> <code>qbreader.org/api/packet-bonuses</code></div>
</h3>
Expand Down Expand Up @@ -157,14 +154,10 @@ <h4 class="mt-4 md-2" id="returns">Returns</h4>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code>bonuses</code><code
class="text-muted">: <a href="/api-docs/schemas#bonus" target="_blank" class="text-muted">Bonus</a>[]</code>
<code>bonuses</code><code class="text-muted">: Bonus[]</code>
</div>
<div>
An array of
<a href="/api-docs/schemas#bonus" target="_blank" class="link-primary">
<code>Bonuses</code>
</a> that are in the packet.
An array of <a href="/api-docs/schemas#bonus"><code>Bonuses</code></a> in the packet.
</div>
</li>
</ul>
Expand Down
15 changes: 4 additions & 11 deletions client/api-docs/packet-tossups.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,7 +112,7 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<h3 class="md-4">
<div><code>GET</code> <code>qbreader.org/api/packet-tossups</code></div>
</h3>
Expand Down Expand Up @@ -157,14 +154,10 @@ <h4 class="mt-4 md-2" id="returns">Returns</h4>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code>tossups</code><code
class="text-muted">: <a href="/api-docs/schemas#tossup" target="_blank" class="text-muted">Tossup</a>[]</code>
<code>tossups</code><code class="text-muted">: Tossup[]</code>
</div>
<div>
An array of
<a href="/api-docs/schemas#tossup" target="_blank" class="link-primary">
<code>Tossups</code>
</a> that are in the packet.
An array of <a href="/api-docs/schemas#tossup"><code>Tossups</code></a> in the packet.
</div>
</li>
</ul>
Expand Down
21 changes: 6 additions & 15 deletions client/api-docs/packet.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-1"></div> <!-- empty column for some left margin -->
<div class="col-md-1"></div> <!-- empty column for some left margin -->
<!-- docs sidebar -->
<div class="d-none d-md-block col-2 h-100" id="docsSidebar">
<h4 class="offcanvas-title" id="docsSidebarLabel">API Reference</h4>
Expand All @@ -77,9 +77,6 @@ <h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/random-bonus"><code>random-bonus</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question (deprecated)</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-tossup"><code>random-tossup</code></a>
</li>
Expand Down Expand Up @@ -115,7 +112,7 @@ <h5 class="mt-4 mb-2">Other</h5>
</ul>
</div>

<div class="col-9">
<div class="col-12 col-md-9">
<h3 class="md-4">
<div><code>GET</code> <code>qbreader.org/api/packet</code></div>
</h3>
Expand Down Expand Up @@ -158,25 +155,19 @@ <h4 class="mt-4 md-2" id="returns">Returns</h4>
<li class="list-group-item">
<div>
<code>tossups</code><code
class="text-muted">: <a href="/api-docs/schemas#tossup" target="_blank" class="text-muted">Tossup</a>[]</code>
class="text-muted">: <a href="/api-docs/schemas#tossup" class="text-muted">Tossup</a>[]</code>
</div>
<div>
An array of
<a href="/api-docs/schemas#tossup" target="_blank" class="link-primary">
<code>Tossups</code>
</a> that are in the packet.
An array of <a href="/api-docs/schemas#tossup"><code>Tossups</code></a> in the packet.
</div>
</li>
<li class="list-group-item">
<div>
<code>bonuses</code><code
class="text-muted">: <a href="/api-docs/schemas#bonus" target="_blank" class="text-muted">Bonus</a>[]</code>
class="text-muted">: <a href="/api-docs/schemas#bonus" class="text-muted">Bonus</a>[]</code>
</div>
<div>
An array of
<a href="/api-docs/schemas#bonus" target="_blank" class="link-primary">
<code>Bonuses</code>
</a> that are in the packet.
An array of <a href="/api-docs/schemas#bonus"><code>Bonuses</code></a> in the packet.
</div>
</li>
</ul>
Expand Down
Loading