Skip to content

Commit

Permalink
Clarify that filters are additive (#114)
Browse files Browse the repository at this point in the history
The documentation on ResourceRef for both List{Commits,Labels} is
phrased in a way that could be confused to mean the endpoint always
returns the specified results, but that doesn't make sense because there
are additional filtering fields on each of these RPCs.

This PR updates the documentation to clarify that filter fields are
additive (i.e. ANDed together) to the resource_ref filter.

Slack discussion:
https://bufprivate.slack.com/archives/C02KXVDB23B/p1717182975280679
  • Loading branch information
nicksnyder authored Jun 3, 2024
1 parent 8e23155 commit 3a0f505
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion buf/registry/module/v1/commit_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ message ListCommitsRequest {
//
// See the documentation on Ref for resource resolution details.
//
// Once the resource is resolved, the following Commits are listed:
// Once the resource is resolved, the following Commits are listed (subject to any additional filters in the request):
// - If a Module is referenced, all Commits for the Module are returned.
// - If a Label is referenced, the Commit the Label points to is returned.
// Use ListLabelHistory to get the history of Commits for a Label.
Expand Down
2 changes: 1 addition & 1 deletion buf/registry/module/v1/label_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ message ListLabelsRequest {
//
// See the documentation on Ref for resource resolution details.
//
// Once the resource is resolved, the following Labels are listed:
// Once the resource is resolved, the following Labels are listed (subject to any additional filters in the request):
// - If a Module is referenced, all Labels for the Module are returned.
// - If a Label is referenced, this Label is returned.
// - If a Commit is referenced, all Labels that currently point to the Commit are returned. Note that
Expand Down
2 changes: 1 addition & 1 deletion buf/registry/module/v1beta1/commit_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ message ListCommitsRequest {
//
// See the documentation on Ref for resource resolution details.
//
// Once the resource is resolved, the following Commits are listed:
// Once the resource is resolved, the following Commits are listed (subject to any additional filters in the request):
// - If a Module is referenced, all Commits for the Module are returned.
// - If a Label is referenced, the Commit the Label points to is returned.
// Use ListLabelHistory to get the history of Commits for a Label.
Expand Down
2 changes: 1 addition & 1 deletion buf/registry/module/v1beta1/label_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ message ListLabelsRequest {
//
// See the documentation on Ref for resource resolution details.
//
// Once the resource is resolved, the following Labels are listed:
// Once the resource is resolved, the following Labels are listed (subject to any additional filters in the request):
// - If a Module is referenced, all Labels for the Module are returned.
// - If a Label is referenced, this Label is returned.
// - If a Commit is referenced, all Labels that currently point to the Commit are returned. Note that
Expand Down

0 comments on commit 3a0f505

Please sign in to comment.