]> git.lizzy.rs Git - cheatdb.git/commitdiff
Rename 'vcs' release-creation mode to 'git'
authorrubenwardy <rw@rubenwardy.com>
Fri, 24 Jan 2020 20:26:26 +0000 (20:26 +0000)
committerrubenwardy <rw@rubenwardy.com>
Fri, 24 Jan 2020 20:27:37 +0000 (20:27 +0000)
app/blueprints/api/endpoints.py
app/flatpages/help/api.md

index bd17bb5c0df6e6f73661457eb86cb2426157fd91..3cb2c178a6a81c04a0e8dc62e9be6b52ce69c802 100644 (file)
@@ -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"])
index c836153c4284e5dacbbeb3011263953d1aade6bf..b141f2c7772dac72d3867f1b7563af9ecabfdd32 100644 (file)
@@ -26,14 +26,14 @@ You can use the `/api/whoami` to check authentication.
 ### Releases
 
 * GET `/api/packages/<username>/<name>/releases/`
-* POST `/api/packages/<username>/<name>/releases/`
+* POST `/api/packages/<username>/<name>/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