Update API docs

This commit is contained in:
rubenwardy 2021-02-03 12:50:16 +00:00
parent 21cf5b57c1
commit 0c08738a66
2 changed files with 5 additions and 3 deletions

View File

@ -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,

View File

@ -40,6 +40,7 @@ Tokens can be attained by visiting [Settings > API Tokens](/user/tokens/).
* See [Package Queries](#package-queries)
* GET `/api/packages/<username>/<name>/` (Read)
* PUT `/api/packages/<author>/<name>/` (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.