feat(schemas): Add SDK API request and response schemas #155
+413
−32
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #155 +/- ##
==========================================
+ Coverage 95.48% 95.67% +0.19%
==========================================
Files 83 85 +2
Lines 2767 2891 +124
==========================================
+ Hits 2642 2766 +124
Misses 125 125 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
khvn26
force-pushed
the
feat/api-schemas
branch
from
b9c7f52 to
6921024
Compare
emyller
reviewed
Jan 9, 2026
Contributor
emyller
left a comment
emyller
left a comment
There was a problem hiding this comment.
Added a few edit suggestions. None blocking.
Comment on lines
+56
to
+57
| priority: int | None | ||
| """The priority of this segment feature override. Lower numbers indicate stronger priority. If null or not set, the weakest priority is assumed.""" |
Comment on lines
+93
to
+97
| property_: str | ||
| """The property (context key) this condition applies to. May be `None` for the `PERCENTAGE_SPLIT` operator. | ||
|
|
||
| Named `property_` for legacy reasons. | ||
| """ |
Contributor
There was a problem hiding this comment.
Maybe worth introducing a new attribute context_key and have property_ aliasing to it for backwards compatibility?
|
|
||
|
|
||
| class Segment(TypedDict): | ||
| """Represents a Flagsmith segment. Carries rules, feature overrides, and segment rules.""" |
Contributor
There was a problem hiding this comment.
Suggested change
| """Represents a Flagsmith segment. Carries rules, feature overrides, and segment rules.""" | |
| """Represents a dynamic group of identities matching the set of `rules`, which will be applied all overrides from `feature_states`.""" |
|
|
||
|
|
||
| class Project(TypedDict): | ||
| """Represents data about a Flagsmith project. For SDKs, this is mainly used to convey segment data.""" |
Contributor
There was a problem hiding this comment.
Suggested change
| """Represents data about a Flagsmith project. For SDKs, this is mainly used to convey segment data.""" | |
| """Represents a Flagsmith project. For SDKs, this is mainly used to convey segment data.""" |
|
|
||
|
|
||
| class MultivariateFeatureStateValue(TypedDict): | ||
| """Represents a multivariate feature state value.""" |
Contributor
There was a problem hiding this comment.
Suggested change
| """Represents a multivariate feature state value.""" | |
| """Represents a feature override that will apply to identities falling into the specified percentage of matched identities.""" |
| mv_fs_value_uuid: UUIDStr | None | ||
| """The UUID for this multivariate feature state value. Should be used for multivariate bucketing if `id` is null.""" | ||
| percentage_allocation: float | ||
| """The percentage allocation for this multivariate feature state value. Should be between or equal to 0 and 100.""" |
Contributor
There was a problem hiding this comment.
Suggested change
| """The percentage allocation for this multivariate feature state value. Should be between or equal to 0 and 100.""" | |
| """The percentage allocation for this multivariate feature state value. Should be between or equal to 0 and 100; total percentage allocation of grouped `MultivariateFeatureStateValue` must not exceed 100.""" |
Comment on lines
+33
to
+37
| class MultivariateFeatureOption(TypedDict): | ||
| """Represents a single multivariate feature option in the Flagsmith UI.""" | ||
|
|
||
| value: str | ||
| """The feature state value that should be served when this option's parent multivariate feature state is selected by the engine.""" |
Contributor
There was a problem hiding this comment.
This is out of scope, but is worth a note: I think this entity makes no sense in the API. I understand this represents the data model, but it also makes the API schema slightly harder to grasp as it adds hierarchy with no value.
|
|
||
|
|
||
| class FeatureState(TypedDict): | ||
| """Used to define the state of a feature for an environment, segment overrides, and identity overrides.""" |
Contributor
There was a problem hiding this comment.
Suggested change
| """Used to define the state of a feature for an environment, segment overrides, and identity overrides.""" | |
| """A feature override for an environment, a segment, or an identity.""" |
|
|
||
|
|
||
| class SegmentRule(TypedDict): | ||
| """Represents a rule within a segment used by Flagsmith engine.""" |
Contributor
There was a problem hiding this comment.
Suggested change
| """Represents a rule within a segment used by Flagsmith engine.""" | |
| """Represents a group of logic conditions to match identities with; root segment rules may contain sub rules.""" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contributes to Flagsmith/flagsmith#6341.
In this PR, we add types representing the SDK API request and response bodies to be used as
The types are accompanied by docstrings carrying user-facing API documentation.