aboutsummaryrefslogtreecommitdiff
path: root/app/flatpages/help/api.md
diff options
context:
space:
mode:
authorrubenwardy <rw@rubenwardy.com>2020-01-24 20:21:40 +0000
committerrubenwardy <rw@rubenwardy.com>2020-01-24 20:21:40 +0000
commit14faae3fd16520859d0ca6b371a86c54e91c6756 (patch)
tree1326c0c93c97ecd43fd91ea1178f9de4b0646c3a /app/flatpages/help/api.md
parent6f1472addb401bf21b0d4feb9dd755d6e8892f09 (diff)
downloadcheatdb-14faae3fd16520859d0ca6b371a86c54e91c6756.tar.xz
Add API to create releases
Diffstat (limited to 'app/flatpages/help/api.md')
-rw-r--r--app/flatpages/help/api.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/app/flatpages/help/api.md b/app/flatpages/help/api.md
index 95e23d2..c836153 100644
--- a/app/flatpages/help/api.md
+++ b/app/flatpages/help/api.md
@@ -23,6 +23,19 @@ You can use the `/api/whoami` to check authentication.
* GET `/api/packages/` - See [Package Queries](#package-queries)
* GET `/api/packages/<username>/<name>/`
+### Releases
+
+* GET `/api/packages/<username>/<name>/releases/`
+* POST `/api/packages/<username>/<name>/releases/`
+ * 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.
+
+
### Topics
* GET `/api/topics/` - Supports [Package Queries](#package-queries), and the following two options: