Update Branding Management API Definition to Include restrictToPublished Query Paramater

[dhaura]

Purpose

A new query parameter (restrictToPublished) to the branding preference resolve GET endpoint is introduced, in order to enable the resolution of branding preferences using only published preferences. The purpose of this PR is to add this newly introduced query parameter into branding management API docs.

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:

curl --location '{base-url}/api/server/v1/branding-preference/resolve?locale={locale}&name={name}&type={branding-type}&restrictToPublished={true/false}' 

EX:

curl --location 'https://localhost:9443/t/carbon.super/api/server/v1/branding-preference/resolve?locale=en-US&name=e3548660-6ff9-4a39-acd6-d4071d6a6e69&type=APP&restrictToPublished=true' 

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.

Related Issues

• At Runtime, UI should Receive the Nearest Published Branding product-is#20769

Related PRs

• Implement Functionality to Resolve Branding Preferences using only Published Branding Preferences wso2-extensions/identity-branding-preference-management#43
• Add API Support to Resolve Branding Preferences only using Published Preferences identity-api-server#637
• Add restrictToPublished Param when Branding Resolver is Called carbon-identity-framework#5820
• Add Integration Tests to Support restrictedToPublished Query Param in Branding Resolver Endpoint product-is#20889

[himeshsiriwardana]

Suggested change

	Specifies whether to use only published branding preferences for resolving.
	Specifies whether to limit resolving to published branding preferences.

[dhaura]

Addressed with 169604e