summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/releases/img/upcoming_release.pngbin0 -> 22635 bytes
-rw-r--r--doc/api/releases/index.md8
2 files changed, 7 insertions, 1 deletions
diff --git a/doc/api/releases/img/upcoming_release.png b/doc/api/releases/img/upcoming_release.png
new file mode 100644
index 00000000000..8bd8573ce84
--- /dev/null
+++ b/doc/api/releases/img/upcoming_release.png
Binary files differ
diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md
index 73a0b81b34a..a7f040ecbf4 100644
--- a/doc/api/releases/index.md
+++ b/doc/api/releases/index.md
@@ -6,7 +6,7 @@
## List Releases
-Paginated list of Releases, sorted by `created_at`.
+Paginated list of Releases, sorted by `released_at`.
```
GET /projects/:id/releases
@@ -488,3 +488,9 @@ Example response:
}
}
```
+
+## Upcoming Releases
+
+A release with a `released_at` in the future will be labeled an "Upcoming Release" in the UI:
+
+![Upcoming release](img/upcoming_release.png)