From: Raxel Gutierrez <raxel@google.com>
Date: Fri, 20 Aug 2021 04:50:30 +0000 (+0000)
Subject: docs: add release note for addressed/unaddressed comments
X-Git-Tag: v3.1.0~66
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c0bdc31638443229fb6fc458bb014665afafaec8;p=thirdparty%2Fpatchwork.git

docs: add release note for addressed/unaddressed comments

Signed-off-by: Raxel Gutierrez <raxel@google.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
---

diff --git a/releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml b/releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml
new file mode 100644
index 00000000..799fd879
--- /dev/null
+++ b/releasenotes/notes/comment-detail-endpoint-for-addressed-unaddressed-patch-comments-bfe71689b6f35a22.yaml
@@ -0,0 +1,18 @@
+---
+features:
+  - |
+    Patch comments and cover letter comments can be marked 'addressed' or 'unaddressed' to
+    reflect whether the comment has been addressed by the patch and cover letter submitter
+    or a reviewer. The current state of a comment is shown in the header when showing a
+    comment and users with edit permission can toggle the state using an adjacent button.
+api:
+  - |
+    The API version has been updated to v1.3.
+  - |
+    A new REST API endpoint is available at ``/api/covers/<cover_id>/comments/<comment_id>/``.
+    This can be used to retrieve and update (e.g. ``addressed`` state) details about a specific
+    cover comment.
+  - |
+    A new REST API endpoint is available at ``/api/patches/<patch_id>/comments/<comment_id>/``.
+    This can be used to retrieve and update (e.g. ``addressed`` state) details about a specific
+    patch comment.