Merge pull request #293 from overmindtech/document_filtering

(maint) add explanation to ChangeFiltersRequest
overmindtech · Dec 6, 2024 · 9357c3a · 9357c3a
2 parents 40c6b17 + 3f1b6d4
commit 9357c3a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/changes.proto b/changes.proto
@@ -272,6 +272,9 @@ message ListHomeChangesRequest {
   optional ChangeFiltersRequest filters = 2;
 }
 
+// ChangeFiltersRequest is used for filtering on the changes page.
+// Repeated entries of the same type are used to represent OR conditions. eg if repo is ["a", "b"] then the filter is (repo == "a" OR repo == "b")
+// The filters are ANDed together. eg if repo is ["a", "b"] and author is ["c"] then the filter is (repo == "a" OR repo == "b") AND author == "c"
 message ChangeFiltersRequest {
   repeated string repos = 1;
   map<string, string> tags = 2;