Skip to content

feat: deprecate selector body field #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: deprecate selector body field #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions protobuf/flagd/sync/v1/sync.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ message SyncFlagsRequest {
// flag configurations from a collection, select the source of the flag or combine this to any desired underlying
// filtering mechanism.
// ex:- selector: 'source=database,app=weatherapp'
string selector = 2;
string selector = 2 [deprecated = true]; // remember to reserve field number 2 if this is removed;
Copy link

@gemini-code-assist gemini-code-assist bot Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The comment explaining the deprecation could be more helpful to users of this API. It's good practice to mention what should be used as a replacement. The information about reserving the field is a good implementation detail for maintainers, but guiding users is more important for a deprecation message.

Suggested change
string selector = 2 [deprecated = true]; // remember to reserve field number 2 if this is removed;
string selector = 2 [deprecated = true]; // Deprecated: Use the 'Flagd-Selector' header instead.

}

// SyncFlagsResponse is the server response containing feature flag configurations and the state
Expand All @@ -54,7 +54,7 @@ message FetchAllFlagsRequest {
// flag configurations from a collection, select the source of the flag or combine this to any desired underlying
// filtering mechanism.
// ex:- selector: 'source=database,app=weatherapp'
string selector = 2;
string selector = 2 [deprecated = true]; // remember to reserve field number 2 if this is removed;
Copy link

@gemini-code-assist gemini-code-assist bot Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The comment explaining the deprecation could be more helpful to users of this API. It's good practice to mention what should be used as a replacement. The information about reserving the field is a good implementation detail for maintainers, but guiding users is more important for a deprecation message.

Suggested change
string selector = 2 [deprecated = true]; // remember to reserve field number 2 if this is removed;
string selector = 2 [deprecated = true]; // Deprecated: Use the 'Flagd-Selector' header instead.

}

// FetchAllFlagsResponse is the server response containing feature flag configurations
Expand Down
Loading