Skip to content
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

Jump to bottom

Update Branding Management API Definition to Include restrictToPublished Query Paramater #4701

Merged
merged 2 commits into from
Sep 23, 2024
Merged

Update Branding Management API Definition to Include restrictToPublished Query Paramater #4701

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b52f463
Update branding management API specification to include restrictToPub…
dhaura Aug 9, 2024
169604e
Update restrictToPublished query param docs.
dhaura Sep 23, 2024
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
13 changes: 13 additions & 0 deletions en/asgardeo/docs/apis/organization-apis/restapis/branding-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ paths:
- $ref: '#/components/parameters/typeQueryParam'
- $ref: '#/components/parameters/nameQueryParam'
- $ref: '#/components/parameters/localeQueryParam'
- $ref: '#/components/parameters/restrictToPublishedQueryParam'
responses:
'200':
description: OK
Expand Down Expand Up @@ -463,6 +464,18 @@ components:
schema:
type: string
example: "login"
restrictToPublishedQueryParam:
in: query
name: restrictToPublished
required: false
description: |
Specifies whether to use only published branding preferences for resolving.
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed with 169604e

If set to true, branding preference will be resolved only using published branding preferences.
If set to false, branding preference will be resolved using both published and unpublished branding preferences.
schema:
type: boolean
default: false
example: true

schemas:
BrandingPreferenceModel:
Expand Down
13 changes: 13 additions & 0 deletions en/asgardeo/docs/apis/restapis/branding-preference.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ paths:
- $ref: '#/components/parameters/typeQueryParam'
- $ref: '#/components/parameters/nameQueryParam'
- $ref: '#/components/parameters/localeQueryParam'
- $ref: '#/components/parameters/restrictToPublishedQueryParam'
responses:
'200':
description: OK
Expand Down Expand Up @@ -537,6 +538,18 @@ components:
schema:
type: string
example: "login"
restrictToPublishedQueryParam:
in: query
name: restrictToPublished
required: false
description: |
Specifies whether to use only published branding preferences for resolving.
If set to true, branding preference will be resolved only using published branding preferences.
If set to false, branding preference will be resolved using both published and unpublished branding preferences.
schema:
type: boolean
default: false
example: true

schemas:
BrandingPreferenceModel:
Expand Down
13 changes: 13 additions & 0 deletions en/identity-server/next/docs/apis/organization-apis/restapis/branding-management.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ paths:
- $ref: '#/components/parameters/typeQueryParam'
- $ref: '#/components/parameters/nameQueryParam'
- $ref: '#/components/parameters/localeQueryParam'
- $ref: '#/components/parameters/restrictToPublishedQueryParam'
responses:
'200':
description: OK
Expand Down Expand Up @@ -467,6 +468,18 @@ components:
schema:
type: string
example: "login"
restrictToPublishedQueryParam:
in: query
name: restrictToPublished
required: false
description: |
Specifies whether to use only published branding preferences for resolving.
If set to true, branding preference will be resolved only using published branding preferences.
If set to false, branding preference will be resolved using both published and unpublished branding preferences.
schema:
type: boolean
default: false
example: true

schemas:
BrandingPreferenceModel:
Expand Down
13 changes: 13 additions & 0 deletions en/identity-server/next/docs/apis/restapis/branding-preference.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ paths:
- $ref: '#/components/parameters/typeQueryParam'
- $ref: '#/components/parameters/nameQueryParam'
- $ref: '#/components/parameters/localeQueryParam'
- $ref: '#/components/parameters/restrictToPublishedQueryParam'
responses:
'200':
description: OK
Expand Down Expand Up @@ -541,6 +542,18 @@ components:
schema:
type: string
example: "login"
restrictToPublishedQueryParam:
in: query
name: restrictToPublished
required: false
description: |
Specifies whether to use only published branding preferences for resolving.
If set to true, branding preference will be resolved only using published branding preferences.
If set to false, branding preference will be resolved using both published and unpublished branding preferences.
schema:
type: boolean
default: false
example: true

schemas:
BrandingPreferenceModel:
Expand Down