Add REST API endpoints to mark a change as ignored/unignored
Gerrit already allows a user to ignore changes (changes will be excluded
from incoming dashboards and email notification suppressed) but it is
not very accessible. The implementation makes use of the user stars API,
using a star with a specific label, "ignore". There is no UI for it, and
to ignore or unignore a change one must construct a PUT request with the
necessary input and manually send it by curl (or other means).
The new endpoints wrap the existing star endpoint, making it easier for
users to (un)ignore changes by a simple PUT, without input, rather than
having to construct a PUT request with the necessary stars input.
The endpoints also provide "Ignore" and "Unignore" buttons on the UI.
The buttons are not displayed for own changes.
Change-Id: Icbb226d7f5333a78fae27f2a4e5e6c86afd1f419
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt
index c6d051d..87ad26b 100644
--- a/Documentation/rest-api-changes.txt
+++ b/Documentation/rest-api-changes.txt
@@ -2148,6 +2148,33 @@
If the change was already not private, the response is "`409 Conflict`".
+[[ignore]]
+=== Ignore
+--
+'PUT /changes/link:#change-id[\{change-id\}]/ignore'
+--
+
+Marks a change as ignored. The change will not be shown in the incoming
+reviews dashboard, and email notifications will be suppressed.
+
+.Request
+----
+ PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/ignore HTTP/1.0
+----
+
+[[unignore]]
+=== Unignore
+--
+'PUT /changes/link:#change-id[\{change-id\}]/unignore'
+--
+
+Un-marks a change as ignored.
+
+.Request
+----
+ PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/unignore HTTP/1.0
+----
+
[[edit-endpoints]]
== Change Edit Endpoints
