diff options
author | rubenwardy <rw@rubenwardy.com> | 2020-07-10 22:32:52 +0100 |
---|---|---|
committer | rubenwardy <rw@rubenwardy.com> | 2020-07-10 22:32:54 +0100 |
commit | c3d96c745924f458846f08d90f48be0c1a4cc0ed (patch) | |
tree | 502d8c2cf583aacf440ac2f62b19b40cb3489ef9 /app/flatpages/help/api.md | |
parent | b9386d5a47aace49afa99d4f3a36a895bea40697 (diff) | |
download | cheatdb-c3d96c745924f458846f08d90f48be0c1a4cc0ed.tar.xz |
Add more sort options to package API, correct documentation
Fixes #204
Diffstat (limited to 'app/flatpages/help/api.md')
-rw-r--r-- | app/flatpages/help/api.md | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/app/flatpages/help/api.md b/app/flatpages/help/api.md index 893d3b0..fd00693 100644 --- a/app/flatpages/help/api.md +++ b/app/flatpages/help/api.md @@ -60,9 +60,29 @@ Example: Supported query parameters: * `type` - Package types (`mod`, `game`, `txp`). -* `q` - Query string +* `q` - Query string. +* `author` - Filter by author. +* `tag` - Filter by tags. * `random` - When present, enable random ordering and ignore `sort`. +* `limit` - Return at most `limit` packages. * `hide` - Hide content based on [Content Flags](/help/content_flags/). -* `sort` - Sort by (`name`, `views`, `date`, `score`). -* `order` - Sort ascending (`Asc`) or descending (`desc`). +* `sort` - Sort by (`name`, `title`, `score`, `downloads`, `created_at`). +* `order` - Sort ascending (`asc`) or descending (`desc`). * `protocol_version` - Only show packages supported by this Minetest protocol version. +* `engine_version` - Only show packages supported by this Minetest engine version, eg: `5.3.0`. + + +## Topic Queries + +Example: + + /api/topics/?q=mobs + +Supported query parameters: + +* `q` - Query string. +* `sort` - Sort by (`name`, `views`, `date`). +* `order` - Sort ascending (`asc`) or descending (`desc`). +* `show_added` - Show topics that have an existing package. +* `show_discarded` - Show topics marked as discarded. +* `limit` - Return at most `limit` topics. |