feat(api): Refactor subscription model and add API placeholders #2042
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
This commit introduces two main changes to improve the robustness of the user subscription feature and prepare for future API expansion. **Forward-Compatible Subscription Triggers** To prevent errors when a subscription trigger is deprecated or removed, the data model has been refactored to be forward-compatible. - The OpenAPI specification now uses a `SubscriptionTriggerResponseItem` schema. This object returns the trigger's `value` and an optional `raw_value`. - If a trigger stored in the database is no longer a valid API enum, its `value` is now set to 'unknown', and the original database string is preserved in `raw_value`. This ensures the API does not fail when encountering old data. - The backend adapter and its tests have been updated to handle this new structure. **API Endpoint Placeholders** As part of the effort to split up a large pull request (#2041), this commit adds placeholder paths to `openapi.yaml` for future subscription management endpoints. These paths are for planning purposes and do not have functional implementations in this change: - `/v1/users/me/subscriptions` - `/v1/users/me/subscriptions/{subscription_id}` **Other Changes** - A specific error for unauthorized subscription creation attempts has been added.
jrobbins
approved these changes
Nov 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit introduces two main changes to improve the robustness of the user subscription feature and prepare for future API expansion.
Forward-Compatible Subscription Triggers
To prevent errors when a subscription trigger is deprecated or removed, the data model has been refactored to be forward-compatible.
SubscriptionTriggerResponseItemschema. This object returns the trigger'svalueand an optionalraw_value.valueis now set to 'unknown', and the original database string is preserved inraw_value. This ensures the API does not fail when encountering old data.API Endpoint Placeholders
As part of the effort to split up a large pull request (#2041), this commit adds placeholder paths to
openapi.yamlfor future subscription management endpoints. These paths are for planning purposes and do not have functional implementations in this change:/v1/users/me/subscriptions/v1/users/me/subscriptions/{subscription_id}Other Changes