Repository navigation
feat(gooddata-sdk): add workspace custom application settings methods #1930
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.
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
Merged
hkad98
merged 2 commits into
gooddata:master
from
hkad98:jkd/psdk-242-custom-application-settings
Nov 9, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
45 changes: 45 additions & 0 deletions
45
...t/en/latest/workspace/workspaces/create_or_update_custom_application_setting.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| title: "create_or_update_custom_application_setting" | ||
| linkTitle: "create_or_update_custom_application_setting" | ||
| weight: 320 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.create_or_update_custom_application_setting" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``create_or_update_custom_application_setting(workspace_id: str, custom_application_setting: CatalogCustomApplicationSetting)`` | ||
|
|
||
| Creates a new custom application setting or overwrites an existing one with the same id. | ||
|
|
||
| If the setting has no id, the server generates one. The generated id is not returned and is not assigned to the setting object, so calling the method again with the same id-less setting creates another setting. To update or delete the setting later, either supply an explicit id or look the generated id up with [list_custom_application_settings](../list_custom_application_settings/). | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{< parameter p_name="custom_application_setting" p_type="CatalogCustomApplicationSetting" >}} | ||
| Custom application setting object to be created or updated. `content` can be any JSON object. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" %}} | ||
| {{< parameter p_type="UpsertOutcome" >}} | ||
| CREATED if the setting did not exist yet, UPDATED if it did. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from gooddata_sdk import CatalogCustomApplicationSetting | ||
|
|
||
| setting = CatalogCustomApplicationSetting( | ||
| id="my_app_version", | ||
| application_name="my_app", | ||
| content={"version": "1.2.0"}, | ||
| ) | ||
| sdk.catalog_workspace.create_or_update_custom_application_setting( | ||
| workspace_id="demo", custom_application_setting=setting | ||
| ) | ||
| ``` |
39 changes: 39 additions & 0 deletions
39
docs/content/en/latest/workspace/workspaces/create_or_update_workspace_setting.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: "create_or_update_workspace_setting" | ||
| linkTitle: "create_or_update_workspace_setting" | ||
| weight: 220 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.create_or_update_workspace_setting" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``create_or_update_workspace_setting(workspace_id: str, workspace_setting: CatalogWorkspaceSetting)`` | ||
|
|
||
| Creates a new workspace setting or overwrites an existing workspace setting with the same id. | ||
|
|
||
| The setting must have an explicit id. Creating a setting whose id is left as the default `None` currently fails. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{< parameter p_name="workspace_setting" p_type="CatalogWorkspaceSetting" >}} | ||
| Workspace setting object to be created or updated. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" %}} | ||
| {{< parameter p_type="UpsertOutcome" >}} | ||
| CREATED if the setting did not exist yet, UPDATED if it did. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| from gooddata_sdk import CatalogWorkspaceSetting | ||
|
|
||
| setting = CatalogWorkspaceSetting(id="locale", setting_type="LOCALE", content={"value": "fr-FR"}) | ||
| sdk.catalog_workspace.create_or_update_workspace_setting(workspace_id="demo", workspace_setting=setting) | ||
| ``` | ||
31 changes: 31 additions & 0 deletions
31
docs/content/en/latest/workspace/workspaces/delete_custom_application_setting.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: "delete_custom_application_setting" | ||
| linkTitle: "delete_custom_application_setting" | ||
| weight: 330 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.delete_custom_application_setting" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``delete_custom_application_setting(workspace_id: str, custom_application_setting_id: str)`` | ||
|
|
||
| Deletes a custom application setting. Deleting a setting that does not exist does nothing. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{< parameter p_name="custom_application_setting_id" p_type="string" >}} | ||
| Custom application setting identification string e.g. "my_app_version" | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" None="yes" %}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| sdk.catalog_workspace.delete_custom_application_setting(workspace_id="demo", custom_application_setting_id="my_app_version") | ||
| ``` |
31 changes: 31 additions & 0 deletions
31
docs/content/en/latest/workspace/workspaces/delete_workspace_setting.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: "delete_workspace_setting" | ||
| linkTitle: "delete_workspace_setting" | ||
| weight: 230 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.delete_workspace_setting" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``delete_workspace_setting(workspace_id: str, workspace_setting_id: str)`` | ||
|
|
||
| Deletes a workspace setting. Deleting a setting that does not exist does nothing. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{< parameter p_name="workspace_setting_id" p_type="string" >}} | ||
| Workspace setting identification string e.g. "locale" | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" None="yes" %}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| sdk.catalog_workspace.delete_workspace_setting(workspace_id="demo", workspace_setting_id="locale") | ||
| ``` |
34 changes: 34 additions & 0 deletions
34
docs/content/en/latest/workspace/workspaces/get_custom_application_setting.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: "get_custom_application_setting" | ||
| linkTitle: "get_custom_application_setting" | ||
| weight: 310 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.get_custom_application_setting" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``get_custom_application_setting(workspace_id: str, custom_application_setting_id: str)`` | ||
|
|
||
| Gets an individual custom application setting. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{< parameter p_name="custom_application_setting_id" p_type="string" >}} | ||
| Custom application setting identification string e.g. "my_app_version" | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" %}} | ||
| {{< parameter p_type="CatalogCustomApplicationSetting" >}} | ||
| Custom application setting object. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| setting = sdk.catalog_workspace.get_custom_application_setting(workspace_id="demo", custom_application_setting_id="my_app_version") | ||
| ``` |
34 changes: 34 additions & 0 deletions
34
docs/content/en/latest/workspace/workspaces/get_workspace_setting.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: "get_workspace_setting" | ||
| linkTitle: "get_workspace_setting" | ||
| weight: 210 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.get_workspace_setting" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``get_workspace_setting(workspace_id: str, workspace_setting_id: str)`` | ||
|
|
||
| Gets an individual workspace setting. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{< parameter p_name="workspace_setting_id" p_type="string" >}} | ||
| Workspace setting identification string e.g. "locale" | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" %}} | ||
| {{< parameter p_type="CatalogWorkspaceSetting" >}} | ||
| Workspace setting object. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| setting = sdk.catalog_workspace.get_workspace_setting(workspace_id="demo", workspace_setting_id="locale") | ||
| ``` |
34 changes: 34 additions & 0 deletions
34
docs/content/en/latest/workspace/workspaces/list_custom_application_settings.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: "list_custom_application_settings" | ||
| linkTitle: "list_custom_application_settings" | ||
| weight: 300 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.list_custom_application_settings" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``list_custom_application_settings(workspace_id: str)`` | ||
|
|
||
| Lists the settings of all custom applications in a workspace. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" %}} | ||
| {{< parameter p_type="list[CatalogCustomApplicationSetting]" >}} | ||
| List of custom application settings. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| settings = sdk.catalog_workspace.list_custom_application_settings(workspace_id="demo") | ||
|
|
||
| # Keep only the settings of one application | ||
| my_app_settings = [s for s in settings if s.application_name == "my_app"] | ||
| ``` |
31 changes: 31 additions & 0 deletions
31
docs/content/en/latest/workspace/workspaces/list_workspace_settings.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: "list_workspace_settings" | ||
| linkTitle: "list_workspace_settings" | ||
| weight: 200 | ||
| superheading: "catalog_workspace." | ||
| api_ref: "CatalogWorkspaceService.list_workspace_settings" | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ``list_workspace_settings(workspace_id: str)`` | ||
|
|
||
| Lists all settings of a workspace. | ||
|
|
||
| {{% parameters-block title="Parameters" %}} | ||
| {{< parameter p_name="workspace_id" p_type="string" >}} | ||
| Workspace identification string e.g. "demo" | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| {{% parameters-block title="Returns" %}} | ||
| {{< parameter p_type="list[CatalogWorkspaceSetting]" >}} | ||
| List of workspace settings. | ||
| {{< /parameter >}} | ||
| {{% /parameters-block %}} | ||
|
|
||
| ## Example | ||
|
|
||
| ```python | ||
| settings = sdk.catalog_workspace.list_workspace_settings(workspace_id="demo") | ||
| ``` |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.