Mirrorlandia_minetest/contentdb
1
0
Fork 0
mirror of https://github.com/minetest/contentdb.git synced 2025-03-27 20:32:37 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update topic queries API doc

Browse Source
This commit is contained in:
rubenwardy
2021-11-25 15:48:23 +00:00
parent 10cfbc6e45
commit c13b13268b
2 changed files with 6 additions and 7 deletions
app
flatpages/help
api.md
querybuilder.py

11
app/flatpages/help/api.md

@ -264,21 +264,20 @@ Example:
## Topics ## Topics
* GET `/api/topics/` ([View](/api/topics/)): Supports [Package Queries](#package-queries), and the following two options: * GET `/api/topics/` ([View](/api/topics/))
* `show_added`: Show topics which exist as packages, default true. * See [Topic Queries](#topic-queries)
* `show_discarded`: Show topics which have been marked as outdated, default false.
### Topic Queries ### Topic Queries
Example: Example:
/api/topics/?q=mobs /api/topics/?q=mobs&type=mod&type=game
Supported query parameters: Supported query parameters:
* `q`: Query string. * `q`: Query string.
* `sort`: Sort by (`name`, `views`, `date`). * `type`: Package types (`mod`, `game`, `txp`).
* `order`: Sort ascending (`asc`) or descending (`desc`). * `sort`: Sort by (`name`, `views`, `created_at`).
* `show_added`: Show topics that have an existing package. * `show_added`: Show topics that have an existing package.
* `show_discarded`: Show topics marked as discarded. * `show_discarded`: Show topics marked as discarded.
* `limit`: Return at most `limit` topics. * `limit`: Return at most `limit` topics.

2
app/querybuilder.py

@ -37,7 +37,7 @@ class QueryBuilder:
self.random = "random" in args self.random = "random" in args
self.lucky = "lucky" in args self.lucky = "lucky" in args
self.limit = 1 if self.lucky else None self.limit = 1 if self.lucky else args.get("limit")
self.order_by = args.get("sort") self.order_by = args.get("sort")
self.order_dir = args.get("order") or "desc" self.order_dir = args.get("order") or "desc"