Add API Support to Resolve Branding Preferences only using Published Preferences #637
Conversation
This file contains 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
AnuradhaSK
reviewed
Jul 29, 2024
| @@ -181,6 +181,7 @@ paths: | |||
| - $ref: '#/components/parameters/typeQueryParam' | |||
| - $ref: '#/components/parameters/nameQueryParam' | |||
| - $ref: '#/components/parameters/localeQueryParam' | |||
| - $ref: '#/components/parameters/restrictToPublishedQueryParam' | |||
There was a problem hiding this comment.
Don't we need to support this query param in branding-preference/text/resolve API as well?
There was a problem hiding this comment.
Fix for text customizations is tracked by wso2/product-is#20858
There was a problem hiding this comment.
Please update the yaml in docs as well
There was a problem hiding this comment.
AnuradhaSK
previously approved these changes
Aug 9, 2024
|
PR builder started |
|
PR builder completed |
jenkins-is-staging
approved these changes
Aug 12, 2024
There was a problem hiding this comment.
Approving the pull request based on the successful pr build https://github.com/wso2/product-is/actions/runs/10345827643
AnuradhaSK
approved these changes
Aug 12, 2024
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.
Purpose
This PR introduces a new query parameter to the branding preference resolve GET endpoint, enabling the resolution of branding preferences using only published preferences.
By adding the restrictToPublished query parameter, users can specify whether to retrieve branding preferences only from published sources or from both published and unpublished preferences.
Example Usage:
EX:
Parameter Behavior of restrictToPublished
true: Returns resolved branding preferences considering only published preferences.false: Returns resolved branding preferences considering both published and unpublished preferences.Not set: Defaults to false, considering both published and unpublished preferences.When should this PR be merged
Related Issues