Skip to content

Replace queryString with q #521

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

Open
btfcookies wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Replace queryString with q #521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c749cf
feat: replace queryString param with q
btfcookies Jun 26, 2026
e3068e6
fix: changes wording of queryString in api docs
btfcookies Jun 26, 2026
a796181
feat: support legacy queryString param as fallback for q
btfcookies Jun 26, 2026
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
4 changes: 2 additions & 2 deletions client/db/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ function QueryForm () {
subcategories: initialParams.get('subcategories') ? initialParams.get('subcategories').split(',') : [],
alternateSubcategories: initialParams.get('alternateSubcategories') ? initialParams.get('alternateSubcategories').split(',') : []
});
const [queryString, setQueryString] = React.useState(initialParams.get('queryString') ?? '');
const [queryString, setQueryString] = React.useState(initialParams.get('q') ?? initialParams.get('queryString') ?? '');
const [maxReturnLength, setMaxReturnLength] = React.useState(initialParams.get('maxReturnLength') ?? '');
const [setName, setSetName] = React.useState(initialParams.get('setName') ?? '');
const [searchType, setSearchType] = React.useState(initialParams.get('searchType') ?? 'all');
Expand Down Expand Up @@ -133,7 +133,7 @@ function QueryForm () {
}

const unfilteredParams = {
queryString,
q: queryString,
...categoryManager.export(),
difficulties: getDropdownValues('difficulties'),
maxReturnLength,
Expand Down
4 changes: 2 additions & 2 deletions client/tools/api-docs/query.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h4 class="mt-4 md-2" id="parameters">Parameters</h4>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<div>
<code>queryString</code><code class="text-muted">: string</code>
<code>q</code><code class="text-muted">: string</code>
<code class="text-muted float-end fw-semibold">default: ""</code>
</div>
<div>
Expand Down Expand Up @@ -336,7 +336,7 @@ <h4 class="mt-4 md-2" id="returns">Returns</h4>
</div>
<div>
The exact string used to search the MongoDB database.
This may differ from the queryString passed in as a parameter:
This may differ from the queryString (q) passed in as a parameter:
<ul>
<li>If <code>regex</code> is <code>false</code>, then regex characters are escaped.</li>
</ul>
Expand Down
2 changes: 2 additions & 0 deletions routes/api/query.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ router.get('/', async (req, res) => {
req.query = validateInt.tossupPagination(req.query);
req.query = validateCategoryBundle(req.query);

req.query.queryString = req.query.q ?? req.query.queryString;

if (req.query.setName) {
req.query.setName = req.query.setName.split(',').map(s => s.trim());
}
Expand Down
Loading