From 0c08738a66a2dc8ccdf79450cc32350edd0b08d3 Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Wed, 3 Feb 2021 12:50:16 +0000 Subject: [PATCH] Update API docs --- app/blueprints/api/support.py | 7 ++++--- app/flatpages/help/api.md | 1 + 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/app/blueprints/api/support.py b/app/blueprints/api/support.py index e29d13e..0f09b99 100644 --- a/app/blueprints/api/support.py +++ b/app/blueprints/api/support.py @@ -44,7 +44,7 @@ def api_create_vcs_release(token: APIToken, package: Package, title: str, ref: s reason += ", token=" + token.name - rel = guard(do_create_vcs_release)(token.owner, package, title, ref, None, None, reason) + rel = guard(do_create_vcs_release)(token.owner, package, title, ref, min_v, max_v, reason) return jsonify({ "success": True, @@ -53,13 +53,14 @@ def api_create_vcs_release(token: APIToken, package: Package, title: str, ref: s }) -def api_create_zip_release(token: APIToken, package: Package, title: str, file, reason="API"): +def api_create_zip_release(token: APIToken, package: Package, title: str, file, + min_v: MinetestRelease = None, max_v: MinetestRelease = None, reason="API"): if not token.canOperateOnPackage(package): error(403, "API token does not have access to the package") reason += ", token=" + token.name - rel = guard(do_create_zip_release)(token.owner, package, title, file, None, None, reason) + rel = guard(do_create_zip_release)(token.owner, package, title, file, min_v, max_v, reason) return jsonify({ "success": True, diff --git a/app/flatpages/help/api.md b/app/flatpages/help/api.md index f3aae9e..c1eaff9 100644 --- a/app/flatpages/help/api.md +++ b/app/flatpages/help/api.md @@ -40,6 +40,7 @@ Tokens can be attained by visiting [Settings > API Tokens](/user/tokens/). * See [Package Queries](#package-queries) * GET `/api/packages///` (Read) * PUT `/api/packages///` (Update) + * Requires authentication. * JSON dictionary with any of these keys (all are optional, null to delete Nullables): * `type`: One of `GAME`, `MOD`, `TXP`. * `title`: Human-readable title.