Skip to content

Expand docs #150

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 20 commits into from
Apr 26, 2023
Merged

Expand docs #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d8da487
rename api page in preperation for adding docs
skysomorphic Mar 28, 2023
27bb9d1
use fira code because fira code looks nice
skysomorphic Mar 28, 2023
ef75516
add redirect to new url to avoid breaking links
skysomorphic Mar 29, 2023
2dc554b
split api docs into individual pages
skysomorphic Mar 30, 2023
dca575e
add side navbar for api docs
skysomorphic Mar 31, 2023
5854a54
small change
skysomorphic Mar 31, 2023
87d4aed
add json schemas for tossups and bonuses
skysomorphic Apr 1, 2023
77fc971
fix typo
skysomorphic Apr 1, 2023
63745b4
add object schemas page in api docs
skysomorphic Apr 1, 2023
14cbe6d
add refresh buttons to schemas page
skysomorphic Apr 1, 2023
b89b390
made name stylization consistent
skysomorphic Apr 2, 2023
8d99866
unwrap for readability
skysomorphic Apr 2, 2023
86d8cb0
rewrite all docs in new style
skysomorphic Apr 24, 2023
6b04f60
update docs with info from `617f5c3`
skysomorphic Apr 24, 2023
391d74a
resolve css merge conflicts
skysomorphic Apr 24, 2023
ce6866e
more updates i missed
skysomorphic Apr 24, 2023
90ada17
remove console.log
skysomorphic Apr 24, 2023
aea4df8
ONE CHARACTER
skysomorphic Apr 24, 2023
af0972e
update `queryString` return
geoffrey-wu Apr 26, 2023
98ee9c9
update `/api/query` handling of multiple values
geoffrey-wu Apr 26, 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
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 @@ -50,7 +50,7 @@
<a class="nav-link" href="/db">Database</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/api-info">API</a>
<a class="nav-link" href="/api-docs">API</a>
</li>
<li class="nav-item">
<a class="nav-link active" href="/about" aria-current="page">About</a>
Expand Down
170 changes: 170 additions & 0 deletions client/api-docs/check-answer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
<!doctype html>
<html lang="en">

<head>
<title>QB Reader</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="The API documentation for QB Reader.">

<link href="/apple-touch-icon.png" rel="apple-touch-icon">
<link href="/apple-touch-icon-precomposed.png" rel="apple-touch-icon-precomposed">
<link type="image/x-icon" href="/favicon.ico" rel="icon">

<link href="/bootstrap/dark.css" rel="stylesheet" id="custom-css">
<script>
if (localStorage.getItem('color-theme') === 'dark') {
document.querySelector('#custom-css').setAttribute('href', "/bootstrap/dark.css");
} else if (localStorage.getItem('color-theme') === 'light') {
document.querySelector('#custom-css').setAttribute('href', "/bootstrap/light.css");
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
// Get OS preferred color scheme
document.querySelector('#custom-css').setAttribute('href', "/bootstrap/dark.css");
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
document.querySelector('#custom-css').setAttribute('href', "/bootstrap/light.css");
}
</script>
</head>

<body>
<nav class="navbar navbar-light navbar-expand-lg bg-custom" id="navbar" style="z-index: 10">
<div class="container-fluid">
<a class="navbar-brand ms-1 py-0" id="logo" href="/">
<span class="logo-prefix">QB</span><span class="logo-suffix">Reader</span>
</a>
<button class="navbar-toggler" data-bs-target="#navbarSupportedContent" data-bs-toggle="collapse" type="button"
aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav me-auto mb-2 mb-lg-0">
<li class="nav-item">
<a class="nav-link" href="/tossups">Tossups</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/bonuses">Bonuses</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/multiplayer">Multiplayer</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/db">Database</a>
</li>
<li class="nav-item">
<a class="nav-link active" href="/api-docs" aria-current="page">API</a>
</li>
<li class="nav-item">
<a class="nav-link" href="/about">About</a>
</li>
</ul>
<div class="d-flex">
<ul class="navbar-nav mb-2 mb-lg-0">
<li class="nav-item">
<a class="nav-link p-1" id="toggle-dark-mode" href="#">
<img src="/dark-mode.png" width="28" height="28">
</a>
</li>
</ul>
</div>
</div>
</div>
</nav>

<div class="container-xl mt-3 mb-4 row">
<div class="col-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>
<ul class="navbar-nav me-auto mb-2 mb-lg-0">
<li class="nav-item">
<a href="/api-docs"><code>Overview</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/schemas"><code>Object Schemas</code></a>
</li>
<h5 class="mt-4 mb-2">Database</h5>
<li class="nav-item">
<a href="/api-docs/query"><code>query</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-question"><code>random-question</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/packet"><code>packet</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/packet-tossups"><code>packet-tossups</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/packet-bonuses"><code>packet-bonuses</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/num-packets"><code>num-packets</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/set-list"><code>set-list</code></a>
</li>
<h5 class="mt-4 mb-2">Multiplayer</h5>
<li class="nav-item">
<a href="/api-docs/multiplayer/room-list"><code>room-list</code></a>
</li>
<h5 class="mt-4 mb-2">Other</h5>
<li class="nav-item">
<a href="/api-docs/check-answer" class="active fw-semibold" aria-current="page"><code>check-answer</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/report-question"><code>report-question</code></a>
</li>
<li class="nav-item">
<a href="/api-docs/random-name"><code>random-name</code></a>
</li>
</ul>
</div>

<div class="col-9">
<h3 class="md-4"><div><code>GET</code> <code>qbreader.org/api/check-answer</code></div></h3>

<p>
Judge an answer to be correct, incorrect, or prompt. Directed prompts are supported.
</p>

<a href="#parameters" class="text-body">
<h4 class="mt-4 md-2" id="parameters">Parameters</h4>
</a>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code>answerline</code><code class="text-muted">: string</code>
<code class="text-muted float-end fw-semibold text-decoration-underline">required</code>
</div>
<div>
The answerline of the question.
Preferably including the HTML tags <code>&lt;b&gt;</code> and <code>&lt;u&gt;</code>, if they are present.
</div>
</li>
<li class="list-group-item">
<div>
<code>givenAnswer</code><code class="text-muted">: string</code>
<code class="text-muted float-end fw-semibold text-decoration-underline">required</code>
</div>
<div>
The answer to check.
</div>
</li>
</ul>

<a href="#returns" class="text-body">
<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>
</div>
</div>
</div>

<script src="/bootstrap/bootstrap.bundle.min.js"></script>
<script src="/script.js"></script>
</body>

</html>
Loading