From beb9c0e959d092c3faa54483acdd47c6ec678c3c Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Fri, 24 Jan 2020 20:26:26 +0000 Subject: [PATCH] Rename 'vcs' release-creation mode to 'git' --- app/blueprints/api/endpoints.py | 4 ++-- app/flatpages/help/api.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/app/blueprints/api/endpoints.py b/app/blueprints/api/endpoints.py index bd17bb5..3cb2c17 100644 --- a/app/blueprints/api/endpoints.py +++ b/app/blueprints/api/endpoints.py @@ -139,7 +139,7 @@ def create_release(token, package): return error(400, option + " is required in the POST data") - if json["method"].lower() != "vcs": - return error(400, "Release-creation methods other than VCS are not supported") + if json["method"].lower() != "git": + return error(400, "Release-creation methods other than git are not supported") return handleCreateRelease(token, package, json["title"], json["ref"]) diff --git a/app/flatpages/help/api.md b/app/flatpages/help/api.md index c836153..b141f2c 100644 --- a/app/flatpages/help/api.md +++ b/app/flatpages/help/api.md @@ -26,14 +26,14 @@ You can use the `/api/whoami` to check authentication. ### Releases * GET `/api/packages///releases/` -* POST `/api/packages///releases/` +* POST `/api/packages///releases/new/` * Requires authentication. * `title`: human-readable name of the release. - * `method`: Must be `vcs`. - * `min_protocol`: minimum Minetest protocol version. See [Minetest](#minetest). - * `min_protocol`: maximum Minetest protocol version. See [Minetest](#minetest). - * If `vcs` release-creation method: - * `ref` - git reference. + * `method`: Release-creation method, only `git` is supported. + * `min_protocol`: (Optional) minimum Minetest protocol version. See [Minetest](#minetest). + * `min_protocol`: (Optional) maximum Minetest protocol version. See [Minetest](#minetest). + * If `git` release-creation method: + * `ref` - git reference, eg: `master`. ### Topics