diff --git a/docs/content/en/latest/administration/notification-channels/get_declarative_notification_channels.md b/docs/content/en/latest/administration/notification-channels/get_declarative_notification_channels.md index c31b6343a..549f3fe1c 100644 --- a/docs/content/en/latest/administration/notification-channels/get_declarative_notification_channels.md +++ b/docs/content/en/latest/administration/notification-channels/get_declarative_notification_channels.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_organization." --- - - -``get_declarative_notification_channels()`` - -Get all declarative notification channels in the current organization. - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="list[CatalogDeclarativeNotificationChannel]" >}} -List of declarative notification channels. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogOrganizationService.get_declarative_notification_channels" >}} ## Example diff --git a/docs/content/en/latest/administration/notification-channels/put_declarative_notification_channels.md b/docs/content/en/latest/administration/notification-channels/put_declarative_notification_channels.md index da1c086ee..1dca935dc 100644 --- a/docs/content/en/latest/administration/notification-channels/put_declarative_notification_channels.md +++ b/docs/content/en/latest/administration/notification-channels/put_declarative_notification_channels.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_organization." --- - - -``put_declarative_notification_channels(notification_channels: list[CatalogDeclarativeNotificationChannel])`` - -Put declarative notification channels in the current organization. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="notification_channels" p_type="list[CatalogDeclarativeNotificationChannel]" >}} -List of declarative notification channels. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogOrganizationService.put_declarative_notification_channels" >}} ## Example diff --git a/docs/content/en/latest/administration/organization/create_or_update_jwk.md b/docs/content/en/latest/administration/organization/create_or_update_jwk.md index 8e0581c64..64556f493 100644 --- a/docs/content/en/latest/administration/organization/create_or_update_jwk.md +++ b/docs/content/en/latest/administration/organization/create_or_update_jwk.md @@ -5,16 +5,4 @@ superheading: "catalog_organization." weight: 100 --- -``create_or_update_jwk( jwk: CatalogJwk ) -> None`` - -Create a new jwk or overwrite an existing jwk with the same id. - -## Parameters - -| name | type | description | -| -- | -- | -- | -| jwk | CatalogJwk | Catalog Jwk object to be created or updated. | - -## Returns - -_None_ +{{< api-ref "sdk.CatalogOrganizationService.create_or_update_jwk" >}} diff --git a/docs/content/en/latest/administration/organization/delete_jwk.md b/docs/content/en/latest/administration/organization/delete_jwk.md index 0146ca036..818e6d2da 100644 --- a/docs/content/en/latest/administration/organization/delete_jwk.md +++ b/docs/content/en/latest/administration/organization/delete_jwk.md @@ -5,16 +5,4 @@ superheading: "catalog_organization." weight: 100 --- -``delete_jwk( jwk_id: str ) -> None`` - -Delete a jwk. - -## Parameters - -| name | type | description | -| -- | -- |-----------------------------------------| -| jwk_id | str | Jwk identification string e.g. "demo" | - -## Returns - -_None_ +{{< api-ref "sdk.CatalogOrganizationService.delete_jwk" >}} diff --git a/docs/content/en/latest/administration/organization/get_jwk.md b/docs/content/en/latest/administration/organization/get_jwk.md index a6a3186a8..faceae35c 100644 --- a/docs/content/en/latest/administration/organization/get_jwk.md +++ b/docs/content/en/latest/administration/organization/get_jwk.md @@ -5,19 +5,4 @@ superheading: "catalog_organization." weight: 100 --- -``get_jwk( jwk_id: str ) -> CatalogJwk`` - -Get an individual jwk. - -## Parameters - -|name | type| description | -| --- | --- | --- | -| jwk_id | str | Jwk identification string e.g. "demo"| - - -## Returns - -| type | description | -| --- |-----------------------------------------------------| -| CatalogJwk | Catalog jwk object containing structure of the jwk. | +{{< api-ref "sdk.CatalogOrganizationService.get_jwk" >}} diff --git a/docs/content/en/latest/administration/organization/list_jwks.md b/docs/content/en/latest/administration/organization/list_jwks.md index 3569210ff..31f3de15a 100644 --- a/docs/content/en/latest/administration/organization/list_jwks.md +++ b/docs/content/en/latest/administration/organization/list_jwks.md @@ -5,16 +5,4 @@ superheading: "catalog_organization." weight: 100 --- -``list_jwks( ) -> List[CatalogJwk]`` - -Returns a list of all jwks in the current organization. - -## Parameters - -_None_ - -## Returns - -| type | description | -| -- | -- | -| List[CatalogJwk] | List of jwks in the current organization. | +{{< api-ref "sdk.CatalogOrganizationService.list_jwks" >}} diff --git a/docs/content/en/latest/administration/organization/update_name.md b/docs/content/en/latest/administration/organization/update_name.md index 90b2fbb61..a18abc8ba 100644 --- a/docs/content/en/latest/administration/organization/update_name.md +++ b/docs/content/en/latest/administration/organization/update_name.md @@ -6,21 +6,7 @@ no_list: true superheading: "catalog_organization." --- - - -``update_name(name: str)`` - -Updates the name of the organization. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="name" p_type="string" >}} -New name of the organization -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogOrganizationService.update_name" >}} ## Example diff --git a/docs/content/en/latest/administration/organization/update_oidc_parameters.md b/docs/content/en/latest/administration/organization/update_oidc_parameters.md index c3f1e82c8..023da430c 100644 --- a/docs/content/en/latest/administration/organization/update_oidc_parameters.md +++ b/docs/content/en/latest/administration/organization/update_oidc_parameters.md @@ -6,33 +6,7 @@ no_list: true superheading: "catalog_organization." --- - - -``update_oidc_parameters(oauth_issuer_location: Optional[str] = None, oauth_client_id: Optional[str] = None, oauth_client_secret: Optional[str] = None)`` - -Updates the OIDC parameters for a given users. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="oauth_issuer_location" p_type="Optional[string]" >}} -Issuer location. Defaults to None. -{{< /parameter >}} -{{< parameter p_name="oauth_client_id" p_type="Optional[string]" >}} -Public client identifier. Defaults to None. -{{< /parameter >}} -{{< parameter p_name="oauth_client_secret" p_type="Optional[string]" >}} -Client secret. Defaults to None. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - -{{% parameters-block title="Raises"%}} -{{< parameter p_name="ValueError" >}} -Parameters were not strictly all none or all string. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogOrganizationService.update_oidc_parameters" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/get_declarative_organization_permissions.md b/docs/content/en/latest/administration/permissions/get_declarative_organization_permissions.md index 9ebc43666..5902a3ad6 100644 --- a/docs/content/en/latest/administration/permissions/get_declarative_organization_permissions.md +++ b/docs/content/en/latest/administration/permissions/get_declarative_organization_permissions.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``get_declarative_organization_permissions()`` - -Gets the current set of permissions of the workspace in a declarative form. - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="List[CatalogDeclarativeOrganizationPermission]" >}} -List of Objects Containing Organization Permissions. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.get_declarative_organization_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/get_declarative_permissions.md b/docs/content/en/latest/administration/permissions/get_declarative_permissions.md index f0c36515d..9ec479c42 100644 --- a/docs/content/en/latest/administration/permissions/get_declarative_permissions.md +++ b/docs/content/en/latest/administration/permissions/get_declarative_permissions.md @@ -6,23 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``get_declarative_permissions(workspace_id: str)`` - -Gets the current set of permissions of the workspace in a declarative form. - -{{% 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="CatalogDeclarativeWorkspacePermissions" >}} -Object Containing Workspace Permissions. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.get_declarative_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/list_available_assignees.md b/docs/content/en/latest/administration/permissions/list_available_assignees.md index 70200410a..33e6fc32c 100644 --- a/docs/content/en/latest/administration/permissions/list_available_assignees.md +++ b/docs/content/en/latest/administration/permissions/list_available_assignees.md @@ -6,28 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``list_available_assignees(workspace_id: str, dashboard_id: str) -> CatalogAvailableAssignees`` - -Provide list of users and groups available to assign some dashboard permission - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="workspace_id" p_type="str" >}} -Workspace identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="dashboard_id" p_type="str" >}} -Dashboard identification string. e.g. "campaign" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} - -{{< parameter p_type="CatalogAvailableAssignees" >}} -Object containing users and user groups -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.list_available_assignees" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/list_dashboard_permissions.md b/docs/content/en/latest/administration/permissions/list_dashboard_permissions.md index b1ecf3415..f51894aff 100644 --- a/docs/content/en/latest/administration/permissions/list_dashboard_permissions.md +++ b/docs/content/en/latest/administration/permissions/list_dashboard_permissions.md @@ -6,28 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``list_dashboard_permissions(workspace_id: str, dashboard_id: str) -> CatalogDashboardPermissions`` - -Provide list of users and user groups with granted dashboard permissions for particular dashboard - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="workspace_id" p_type="str" >}} -Workspace identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="dashboard_id" p_type="str" >}} -Dashboard identification string. e.g. "campaign" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} - -{{< parameter p_type="CatalogDashboardPermissions" >}} -Object containing users and user groups and granted dashboard permissions and any permission rules in effect. -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.list_dashboard_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/manage_dashboard_permissions.md b/docs/content/en/latest/administration/permissions/manage_dashboard_permissions.md index 271d2db5e..9ce38e6ef 100644 --- a/docs/content/en/latest/administration/permissions/manage_dashboard_permissions.md +++ b/docs/content/en/latest/administration/permissions/manage_dashboard_permissions.md @@ -6,26 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``manage_dashboard_permissions(workspace_id: str, dashboard_id: str, permissions_for_assignee: List[Union[CatalogPermissionsForAssigneeIdentifier, CatalogPermissionsForAssigneeRule]] ) -> None`` - -Provide managing dashboard permissions for user and user groups. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="workspace_id" p_type="str" >}} -Workspace identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="dashboard_id" p_type="str" >}} -Dashboard identification string. e.g. "campaign" -{{< /parameter >}} -{{< parameter p_name="permissions_for_assignee" p_type="List[Union[CatalogPermissionsForAssigneeIdentifier, CatalogPermissionsForAssigneeRule]]" >}} -Object containing list of users, user groups, or rules and desired dashboard permissions. Set empty list permissions for user/user group means remove dashboard permissions. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.manage_dashboard_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/manage_organization_permissions.md b/docs/content/en/latest/administration/permissions/manage_organization_permissions.md index 96676fbf9..1198cb892 100644 --- a/docs/content/en/latest/administration/permissions/manage_organization_permissions.md +++ b/docs/content/en/latest/administration/permissions/manage_organization_permissions.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``manage_organization_permissions(organization_permission_assignments: List[CatalogOrganizationPermissionAssignment])`` - -Manage the permissions of the whole organization. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="organization_permission_assignments" p_type="List[CatalogOrganizationPermissionAssignment]" >}} -List of Organization Permission Assignments. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.manage_organization_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/put_declarative_organization_permissions.md b/docs/content/en/latest/administration/permissions/put_declarative_organization_permissions.md index adb4e4b51..098292155 100644 --- a/docs/content/en/latest/administration/permissions/put_declarative_organization_permissions.md +++ b/docs/content/en/latest/administration/permissions/put_declarative_organization_permissions.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``put_declarative_organization_permissions(org_permissions: List[CatalogDeclarativeOrganizationPermission])`` - -Sets the permissions for the whole organization. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="org_permissions" p_type="List[CatalogDeclarativeOrganizationPermission]" >}} -List of Organization Permissions. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.put_declarative_organization_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/permissions/put_declarative_permissions.md b/docs/content/en/latest/administration/permissions/put_declarative_permissions.md index 3a0d47c30..6914c29fd 100644 --- a/docs/content/en/latest/administration/permissions/put_declarative_permissions.md +++ b/docs/content/en/latest/administration/permissions/put_declarative_permissions.md @@ -6,23 +6,7 @@ no_list: true superheading: "catalog_permission." --- - - -``put_declarative_permissions(workspace_id: str, declarative_workspace_permissions: CatalogDeclarativeWorkspacePermissions)`` - -Sets the permissions for the workspace. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="declarative_workspace_permissions" p_type="CatalogDeclarativeWorkspacePermissions" >}} -Object Containing Workspace Permissions. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogPermissionService.put_declarative_permissions" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/create_or_update_user_group.md b/docs/content/en/latest/administration/user-groups/create_or_update_user_group.md index 5ca57dc14..49041f529 100644 --- a/docs/content/en/latest/administration/user-groups/create_or_update_user_group.md +++ b/docs/content/en/latest/administration/user-groups/create_or_update_user_group.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``create_or_update_user_group(user_group: CatalogUserGroup)`` - -Creates a new user group or overwrites an existing user group. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_group" p_type="CatalogUserGroup" >}} -User group entity object. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.create_or_update_user_group" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/delete_user_group.md b/docs/content/en/latest/administration/user-groups/delete_user_group.md index 22f8b8fa0..6e2125086 100644 --- a/docs/content/en/latest/administration/user-groups/delete_user_group.md +++ b/docs/content/en/latest/administration/user-groups/delete_user_group.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``delete_user_group(user_group_id: str)`` - -Deletes user group using user group id. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_group_id" p_type="string" >}} -User group identification string. e.g. "123" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.delete_user_group" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/get_declarative_user_groups.md b/docs/content/en/latest/administration/user-groups/get_declarative_user_groups.md index 6ce63227e..15e7af661 100644 --- a/docs/content/en/latest/administration/user-groups/get_declarative_user_groups.md +++ b/docs/content/en/latest/administration/user-groups/get_declarative_user_groups.md @@ -6,19 +6,7 @@ no_list: true superheading: "catalog_user." --- -``get_declarative_user_groups()`` - -Gets all user groups in a declarative form. - - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeUserGroups" >}} -Declarative User groups object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.get_declarative_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/get_user_group.md b/docs/content/en/latest/administration/user-groups/get_user_group.md index 01105feb0..77ea46892 100644 --- a/docs/content/en/latest/administration/user-groups/get_user_group.md +++ b/docs/content/en/latest/administration/user-groups/get_user_group.md @@ -6,23 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``get_user_group(user_group_id: str)`` - -Gets an individual user group using user group id. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="user_group_id" p_type="string" >}} -User Group identification string. e.g. "123" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogUserGroup" >}} -User group entity object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.get_user_group" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/list_user_groups.md b/docs/content/en/latest/administration/user-groups/list_user_groups.md index 02469bab8..f230c7304 100644 --- a/docs/content/en/latest/administration/user-groups/list_user_groups.md +++ b/docs/content/en/latest/administration/user-groups/list_user_groups.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``list_user_groups()`` - -Gets a list of all existing user groups. - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="List[CatalogUserGroup]" >}} -List of all user groups as user group entity object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.list_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/load_and_put_declarative_user_groups.md b/docs/content/en/latest/administration/user-groups/load_and_put_declarative_user_groups.md index ef7281638..bfc3b835f 100644 --- a/docs/content/en/latest/administration/user-groups/load_and_put_declarative_user_groups.md +++ b/docs/content/en/latest/administration/user-groups/load_and_put_declarative_user_groups.md @@ -6,21 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``load_and_put_declarative_user_groups(layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_user_groups](../load_declarative_user_groups/) and [put_declarative_user_groups](../put_declarative_user_groups/) methods to load and -set user groups stored using [store_declarative_user_groups](../store_declarative_user_groups/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.load_and_put_declarative_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/load_declarative_user_groups.md b/docs/content/en/latest/administration/user-groups/load_declarative_user_groups.md index 7b1ef3d47..b0faf711c 100644 --- a/docs/content/en/latest/administration/user-groups/load_declarative_user_groups.md +++ b/docs/content/en/latest/administration/user-groups/load_declarative_user_groups.md @@ -6,23 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``load_declarative_user_groups(layout_root_path: Path = Path.cwd())`` - -Loads the declarative users groups layout, which was stored using [store_declarative_user_groups](../store_declarative_user_groups/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeUserGroups" >}} -Declarative user groups object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.load_declarative_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/put_declarative_user_groups.md b/docs/content/en/latest/administration/user-groups/put_declarative_user_groups.md index 04e6802b7..0d61004b1 100644 --- a/docs/content/en/latest/administration/user-groups/put_declarative_user_groups.md +++ b/docs/content/en/latest/administration/user-groups/put_declarative_user_groups.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``put_declarative_user_groups(user_groups: CatalogDeclarativeUserGroups)`` - -Sets all user groups eventually with their parents. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="user_groups" p_type="CatalogDeclarativeUserGroups" >}} -Declarative User Groups object. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.put_declarative_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/user-groups/store_declarative_user_groups.md b/docs/content/en/latest/administration/user-groups/store_declarative_user_groups.md index 278bd65c1..ce8f69328 100644 --- a/docs/content/en/latest/administration/user-groups/store_declarative_user_groups.md +++ b/docs/content/en/latest/administration/user-groups/store_declarative_user_groups.md @@ -6,25 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``store_declarative_user_groups(layout_root_path: Path = Path.cwd())`` - -Stores all the user groups in a directory hierarchy. - - gooddata_layouts - └── organization_id - └── user_groups - └── user_groups.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.store_declarative_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/users-and-user-groups/get_declarative_users_user_groups.md b/docs/content/en/latest/administration/users-and-user-groups/get_declarative_users_user_groups.md index 3208ee81a..85d99e552 100644 --- a/docs/content/en/latest/administration/users-and-user-groups/get_declarative_users_user_groups.md +++ b/docs/content/en/latest/administration/users-and-user-groups/get_declarative_users_user_groups.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``get_declarative_users_user_groups()`` - -Gets all users and user groups in a declarative form. - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeUsersUserGroups" >}} -Declarative users and user Groups object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.get_declarative_users_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/users-and-user-groups/load_and_put_declarative_users_user_groups.md b/docs/content/en/latest/administration/users-and-user-groups/load_and_put_declarative_users_user_groups.md index 62ad8c76c..aedc0c36d 100644 --- a/docs/content/en/latest/administration/users-and-user-groups/load_and_put_declarative_users_user_groups.md +++ b/docs/content/en/latest/administration/users-and-user-groups/load_and_put_declarative_users_user_groups.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``load_and_put_declarative_users_user_groups(layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_users_user_groups](../load_declarative_users_user_groups/) and [put_declarative_users_user_groups](../put_declarative_users_user_groups/) methods to load and -set users and user groups stored using [store_declarative_users_user_groups](../store_declarative_users_user_groups/). - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.load_and_put_declarative_users_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/users-and-user-groups/load_declarative_users_user_groups.md b/docs/content/en/latest/administration/users-and-user-groups/load_declarative_users_user_groups.md index d217662a1..faf0ee042 100644 --- a/docs/content/en/latest/administration/users-and-user-groups/load_declarative_users_user_groups.md +++ b/docs/content/en/latest/administration/users-and-user-groups/load_declarative_users_user_groups.md @@ -6,22 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``load_declarative_users_user_groups(layout_root_path: Path = Path.cwd())`` - -Loads declarative users and user groups layout, which was stored using [store_declarative_users_user_groups](../store_declarative_users_user_groups/). - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDeclarativeUsersUserGroups" >}} -Declarative users and user Groups object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.load_declarative_users_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/users-and-user-groups/put_declarative_users_user_groups.md b/docs/content/en/latest/administration/users-and-user-groups/put_declarative_users_user_groups.md index 017705d85..144f961ee 100644 --- a/docs/content/en/latest/administration/users-and-user-groups/put_declarative_users_user_groups.md +++ b/docs/content/en/latest/administration/users-and-user-groups/put_declarative_users_user_groups.md @@ -6,19 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``put_declarative_users_user_groups(users_user_groups: CatalogDeclarativeUsersUserGroups)`` - -Sets all users and user groups. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="users" p_type="CatalogDeclarativeUsersUserGroups" >}} -Declarative users and user groups object. -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.put_declarative_users_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/users-and-user-groups/store_declarative_users_user_groups.md b/docs/content/en/latest/administration/users-and-user-groups/store_declarative_users_user_groups.md index cfd07c66c..fdb5a5ea1 100644 --- a/docs/content/en/latest/administration/users-and-user-groups/store_declarative_users_user_groups.md +++ b/docs/content/en/latest/administration/users-and-user-groups/store_declarative_users_user_groups.md @@ -6,26 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``store_declarative_users_user_groups(layout_root_path: Path = Path.cwd())`` - -Stores all the users and user groups in a directory hierarchy. - - gooddata_layouts - └── organization_id - ├── users - │ └── users.yaml - └── user_groups - └── user_groups.yaml - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.store_declarative_users_user_groups" >}} ## Example diff --git a/docs/content/en/latest/administration/users/create_or_update_user.md b/docs/content/en/latest/administration/users/create_or_update_user.md index 33bc25538..8867e0f86 100644 --- a/docs/content/en/latest/administration/users/create_or_update_user.md +++ b/docs/content/en/latest/administration/users/create_or_update_user.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``create_or_update_user(user: CatalogUser)`` - -Creates a new user or overwrites an existing user. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user" p_type="CatalogUser" >}} -User entity object. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.create_or_update_user" >}} ## Example diff --git a/docs/content/en/latest/administration/users/create_user_api_token.md b/docs/content/en/latest/administration/users/create_user_api_token.md index 3e7c4c334..3fb21672c 100644 --- a/docs/content/en/latest/administration/users/create_user_api_token.md +++ b/docs/content/en/latest/administration/users/create_user_api_token.md @@ -6,26 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``create_user_api_token(user_id: str, api_token_id: str)`` - -Create a new user api token. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_id" p_type="string" >}} -User identification string. e.g. "admin" -{{< /parameter >}} -{{< parameter p_name="api_token_id" p_type="string" >}} -API token identification string. e.g. "admin_token" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogApiToken" >}} -Instance of CatalogApiToken holding the information about API token (its id, and bearer token). -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.create_user_api_token" >}} ## Example diff --git a/docs/content/en/latest/administration/users/delete_user.md b/docs/content/en/latest/administration/users/delete_user.md index 3a400c89d..f49c796ee 100644 --- a/docs/content/en/latest/administration/users/delete_user.md +++ b/docs/content/en/latest/administration/users/delete_user.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``delete_user(user_id: str)`` - -Deletes user using user id. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_id" p_type="string" >}} -User identification string. e.g. "123" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.delete_user" >}} ## Example diff --git a/docs/content/en/latest/administration/users/delete_user_api_token.md b/docs/content/en/latest/administration/users/delete_user_api_token.md index 76bb9122c..e02e0beed 100644 --- a/docs/content/en/latest/administration/users/delete_user_api_token.md +++ b/docs/content/en/latest/administration/users/delete_user_api_token.md @@ -6,23 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``delete_user_api_token(user_id: str, api_token_id: str)`` - -Delete user api token. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_id" p_type="string" >}} -User identification string. e.g. "admin" -{{< /parameter >}} -{{< parameter p_name="api_token_id" p_type="string" >}} -API token identification string. e.g. "admin_token" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.delete_user_api_token" >}} ## Example diff --git a/docs/content/en/latest/administration/users/get_declarative_users.md b/docs/content/en/latest/administration/users/get_declarative_users.md index b220593b4..243370630 100644 --- a/docs/content/en/latest/administration/users/get_declarative_users.md +++ b/docs/content/en/latest/administration/users/get_declarative_users.md @@ -6,22 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``get_declarative_users()`` - - -Gets all users including authentication properties. - - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeUsers" >}} -Declarative users object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.get_declarative_users" >}} ## Example diff --git a/docs/content/en/latest/administration/users/get_user.md b/docs/content/en/latest/administration/users/get_user.md index c4f1984c0..5c5b4a215 100644 --- a/docs/content/en/latest/administration/users/get_user.md +++ b/docs/content/en/latest/administration/users/get_user.md @@ -6,23 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``get_user(user_id: str)`` - -Gets an individual user using user id. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_id" p_type="string" >}} -User identification string. e.g. "123" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogUser" >}} -user entity object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.get_user" >}} ## Example diff --git a/docs/content/en/latest/administration/users/get_user_api_token.md b/docs/content/en/latest/administration/users/get_user_api_token.md index fc5193a05..89f20a5dc 100644 --- a/docs/content/en/latest/administration/users/get_user_api_token.md +++ b/docs/content/en/latest/administration/users/get_user_api_token.md @@ -6,27 +6,8 @@ no_list: true superheading: "catalog_user." --- +{{< api-ref "sdk.CatalogUserService.get_user_api_token" >}} - -``get_user_api_token(user_id: str, api_token_id: str)`` - -Get user api token. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_id" p_type="string" >}} -User identification string. e.g. "admin" -{{< /parameter >}} -{{< parameter p_name="api_token_id" p_type="string" >}} -API token identification string. e.g. "admin_token" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogApiToken" >}} -Instance of CatalogApiToken holding the information about API token. -Note that the bearer token is not returned. It will always be None. -{{< /parameter >}} -{{% /parameters-block %}} ## Example ```python diff --git a/docs/content/en/latest/administration/users/list_user_api_tokens.md b/docs/content/en/latest/administration/users/list_user_api_tokens.md index 6c4dad769..9a6e59c1b 100644 --- a/docs/content/en/latest/administration/users/list_user_api_tokens.md +++ b/docs/content/en/latest/administration/users/list_user_api_tokens.md @@ -6,24 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``list_user_api_tokens(user_id: str)`` - -List all user API tokens. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="user_id" p_type="string" >}} -User identification string. e.g. "admin" -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="list[CatalogApiToken]" >}} -List of CatalogApiToken instances holding the information about users API tokens. -Note that the bearer token is not returned. It will always be None. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.list_user_api_tokens" >}} ## Example diff --git a/docs/content/en/latest/administration/users/list_users.md b/docs/content/en/latest/administration/users/list_users.md index 6d362e4f6..df79f6c55 100644 --- a/docs/content/en/latest/administration/users/list_users.md +++ b/docs/content/en/latest/administration/users/list_users.md @@ -6,20 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``list_users()`` - -Gets a list of all existing users. - -{{% parameters-block title="Parameters" None="yes"%}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="List[CatalogUser]" >}} -List of all Users as User entity objects. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.list_users" >}} ## Example diff --git a/docs/content/en/latest/administration/users/load_and_put_declarative_users.md b/docs/content/en/latest/administration/users/load_and_put_declarative_users.md index 730b11f0f..7935f6257 100644 --- a/docs/content/en/latest/administration/users/load_and_put_declarative_users.md +++ b/docs/content/en/latest/administration/users/load_and_put_declarative_users.md @@ -6,19 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``load_and_put_declarative_users(layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_users](../load_declarative_users/) and [put_declarative_users](../put_declarative_users/) methods to load and set users stored using [store_declarative_users](../store_declarative_users/). - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.load_and_put_declarative_users" >}} ## Example diff --git a/docs/content/en/latest/administration/users/load_declarative_users.md b/docs/content/en/latest/administration/users/load_declarative_users.md index c1ae510de..ca2a7d9d6 100644 --- a/docs/content/en/latest/administration/users/load_declarative_users.md +++ b/docs/content/en/latest/administration/users/load_declarative_users.md @@ -6,22 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``load_declarative_users(layout_root_path: Path = Path.cwd())`` - -Loads declarative users layout, which was stored using [store_declarative_users](../store_declarative_users/). - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDeclarativeUsers" >}} -Declarative users object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.load_declarative_users" >}} ## Example diff --git a/docs/content/en/latest/administration/users/put_declarative_users.md b/docs/content/en/latest/administration/users/put_declarative_users.md index d9816ae3d..2c004c848 100644 --- a/docs/content/en/latest/administration/users/put_declarative_users.md +++ b/docs/content/en/latest/administration/users/put_declarative_users.md @@ -6,19 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``put_declarative_users(users: CatalogDeclarativeUsers)`` - -Sets all users and their authentication properties. - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="users" p_type="CatalogDeclarativeUsers" >}} -Declarative users object, incuding authetication properties. -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.put_declarative_users" >}} ## Example diff --git a/docs/content/en/latest/administration/users/store_declarative_users.md b/docs/content/en/latest/administration/users/store_declarative_users.md index 88c727dca..d555fbf2e 100644 --- a/docs/content/en/latest/administration/users/store_declarative_users.md +++ b/docs/content/en/latest/administration/users/store_declarative_users.md @@ -6,24 +6,7 @@ no_list: true superheading: "catalog_user." --- - - -``store_declarative_users(layout_root_path: Path = Path.cwd())`` - -Stores the users in directory hierarchy. - - gooddata_layouts - └── organization_id - └── users - └── users.yaml - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory.. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogUserService.store_declarative_users" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/create_or_update_data_source.md b/docs/content/en/latest/data/data-source/create_or_update_data_source.md index 7a47347f3..33c29dcea 100644 --- a/docs/content/en/latest/data/data-source/create_or_update_data_source.md +++ b/docs/content/en/latest/data/data-source/create_or_update_data_source.md @@ -5,24 +5,9 @@ weight: 10 superheading: "catalog_data_source." --- +{{< api-ref "sdk.CatalogDataSourceService.create_or_update_data_source" >}} - -``create_or_update_data_source(data_source: CatalogDataSource)`` - -Pushes the data source to the GoodData environment. Automatically decides, whether to create or update. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source" p_type="CatalogDataSource" >}} -Catalog data source object -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - -### Example +## Example ```python # PostgreSQL example diff --git a/docs/content/en/latest/data/data-source/delete_data_source.md b/docs/content/en/latest/data/data-source/delete_data_source.md index 79ec7818a..30f1048f3 100644 --- a/docs/content/en/latest/data/data-source/delete_data_source.md +++ b/docs/content/en/latest/data/data-source/delete_data_source.md @@ -5,24 +5,9 @@ weight: 30 superheading: "catalog_data_source." --- +{{< api-ref "sdk.CatalogDataSourceService.delete_data_source" >}} - -``delete_data_source(data_source_id: str)`` - -Deletes data source using data source id. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string e.g. "demo" -{{< /parameter >}} - -{{< /parameters-block >}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - -### Example +## Example ```python # Delete a data source via source id. diff --git a/docs/content/en/latest/data/data-source/generate_logical_model.md b/docs/content/en/latest/data/data-source/generate_logical_model.md index db1d8b038..bb24ac17d 100644 --- a/docs/content/en/latest/data/data-source/generate_logical_model.md +++ b/docs/content/en/latest/data/data-source/generate_logical_model.md @@ -5,31 +5,7 @@ weight: 170 superheading: "catalog_data_source." --- - - -``generate_logical_model(data_source_id: str, generate_ldm_request: CatalogGenerateLdmRequest)`` - -Generates logical data model for a data source. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string e.g. "demo" -{{< /parameter >}} - -{{< parameter p_name="generate_ldm_request" p_type="Optional[CatalogGenerateLdmRequest]" >}} -LDM options. Defaults to CatalogGenerateLdmRequest(separator="__", wdf_prefix="wdf") -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} - -{{< parameter p_type="CatalogDeclarativeModel" >}} -Object Containing declarative Logical Data Model -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.generate_logical_model" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/get_data_source.md b/docs/content/en/latest/data/data-source/get_data_source.md index 113f1ed3a..afde71a7c 100644 --- a/docs/content/en/latest/data/data-source/get_data_source.md +++ b/docs/content/en/latest/data/data-source/get_data_source.md @@ -5,27 +5,7 @@ weight: 20 superheading: "catalog_data_source." --- - - -``get_data_source(data_source_id: str)`` - -Gets data source using data source id. - - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="str" >}} -Data source identification string e.g. "demo" -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDataSource" >}} -Data source object. -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.get_data_source" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/get_declarative_data_sources.md b/docs/content/en/latest/data/data-source/get_declarative_data_sources.md index 12c16eb90..c31cb9224 100644 --- a/docs/content/en/latest/data/data-source/get_declarative_data_sources.md +++ b/docs/content/en/latest/data/data-source/get_declarative_data_sources.md @@ -5,21 +5,7 @@ weight: 70 superheading: "catalog_data_source." --- - - -``get_declarative_data_sources()`` - - -Gets all data sources, including their related physical data model. - - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDeclarativeDataSources" >}} -Data source object, including physical data model. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.get_declarative_data_sources" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/list_data_sources.md b/docs/content/en/latest/data/data-source/list_data_sources.md index 6167cb4ae..2787a76e3 100644 --- a/docs/content/en/latest/data/data-source/list_data_sources.md +++ b/docs/content/en/latest/data/data-source/list_data_sources.md @@ -5,43 +5,4 @@ weight: 50 superheading: "catalog_data_source." --- - - -``list_data_sources()`` - -Lists all data sources. - - -{{% parameters-block title="Parameters" None="yes"%}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} - -{{% parameter p_type="List[CatalogDataSource]" %}} -List of all data sources in the whole organization. -{{% /parameter %}} - -{{% /parameters-block %}} - -```python -# List all data sources -data_sources = sdk.catalog_data_source.list_data_sources() - - -# [ -# CatalogDataSource( -# id='demo-test-ds', -# name='demo-test-ds', -# type='POSTGRESQL', -# schema='demo', -# url='jdbc:postgresql://localhost:5432/demo', -# cache_path=None, -# parameters=None, -# decoded_parameters=None, -# db_vendor='postgresql', -# db_specific_attributes=None, -# url_params=None -# ), -# ... -# ] -``` +{{< api-ref "sdk.CatalogDataSourceService.list_data_sources" >}} diff --git a/docs/content/en/latest/data/data-source/load_and_put_declarative_data_sources.md b/docs/content/en/latest/data/data-source/load_and_put_declarative_data_sources.md index 38d2bee0c..d8c589b72 100644 --- a/docs/content/en/latest/data/data-source/load_and_put_declarative_data_sources.md +++ b/docs/content/en/latest/data/data-source/load_and_put_declarative_data_sources.md @@ -5,28 +5,7 @@ weight: 110 superheading: "catalog_data_source." --- - - -``load_and_put_declarative_data_sources(layout_root_path: Path = Path.cwd(), credentials_path: Optional[Path] = None, test_data_sources: bool = False)`` - -This method combines [load_declarative_data_sources](../load_and_put_declarative_data_sources/) and [put_declarative_data_sources](../put_declarative_data_sources/) methods to load and set layouts stored using [store_declarative_data_sources](../store_declarative_data_sources/). - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="layout_root_path" p_type="CatalogDeclarativeDataSources" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{< parameter p_name="credentials_path" p_type="Optional[Path]" >}} -Path to the credentials. Defaults to Path.cwd(). -{{< /parameter >}} -{{< parameter p_name="test_data_sources" p_type="Optional[Bool]" >}} -If True, the connection of data sources is tested. Defaults to False. -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.load_and_put_declarative_data_sources" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/load_declarative_data_sources.md b/docs/content/en/latest/data/data-source/load_declarative_data_sources.md index d3eba2c98..0f732a71d 100644 --- a/docs/content/en/latest/data/data-source/load_declarative_data_sources.md +++ b/docs/content/en/latest/data/data-source/load_declarative_data_sources.md @@ -5,29 +5,7 @@ weight: 100 superheading: "catalog_data_source." --- - - -``load_declarative_data_sources(layout_root_path: Path = Path.cwd())`` - -Loads declarative data sources layout, which was stored using [store_declarative_data_sources](../store_declarative_data_sources/). - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="declarative_data_sources" p_type="CatalogDeclarativeDataSources" >}} - Declarative data sources object -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} - -{{< parameter p_type="CatalogDeclarativeDataSources" >}} -Declarative data sources object -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.load_declarative_data_sources" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/patch_data_source_attributes.md b/docs/content/en/latest/data/data-source/patch_data_source_attributes.md index bdd946ca8..a41636c1b 100644 --- a/docs/content/en/latest/data/data-source/patch_data_source_attributes.md +++ b/docs/content/en/latest/data/data-source/patch_data_source_attributes.md @@ -5,27 +5,7 @@ weight: 40 superheading: "catalog_data_source." --- - - -``patch_data_source_attributes(data_source_id: str, attributes: dict)`` - -Applies changes to the specified data source. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string e.g. "demo" -{{< /parameter >}} - -{{< parameter p_name="attributes" p_type="dictionary" >}} -A dictionary containing attributes of the data source to be changed. -{{< /parameter >}} - -{{% /parameters-block %}} - - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.patch_data_source_attributes" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/put_declarative_data_sources.md b/docs/content/en/latest/data/data-source/put_declarative_data_sources.md index 4658aa369..174187a18 100644 --- a/docs/content/en/latest/data/data-source/put_declarative_data_sources.md +++ b/docs/content/en/latest/data/data-source/put_declarative_data_sources.md @@ -5,30 +5,8 @@ weight: 80 superheading: "catalog_data_source." --- +{{< api-ref "sdk.CatalogDataSourceService.put_declarative_data_sources" >}} - -``put_declarative_data_sources(declarative_data_sources: CatalogDeclarativeDataSources, credentials_path: Optional[Path] = None, test_data_sources: bool = False)`` - -Sets all data sources, including their related physical data model. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="declarative_data_sources" p_type="CatalogDeclarativeDataSources" >}} -Declarative data source object. Can be retrieved by get_declarative_data_sources. -{{< /parameter >}} - -{{< parameter p_name="credentials_path" p_type="Optional[Path]" >}} -Path to the Credentials. Optional, defaults to None. -{{< /parameter >}} - -{{< parameter p_name="test_data_sources" p_type="Optional[bool]" >}} -If True, the connection of data sources is tested. Defaults to False. -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} ## Example ```python diff --git a/docs/content/en/latest/data/data-source/register_upload_notification.md b/docs/content/en/latest/data/data-source/register_upload_notification.md index d40aff752..2b2311aa7 100644 --- a/docs/content/en/latest/data/data-source/register_upload_notification.md +++ b/docs/content/en/latest/data/data-source/register_upload_notification.md @@ -5,22 +5,7 @@ weight: 180 superheading: "catalog_data_source." --- - - -``register_upload_notification(data_source_id: str)`` - -Forces the recomputation of analytics by invalidating the cache of the computed reports. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.register_upload_notification" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/scan_data_source.md b/docs/content/en/latest/data/data-source/scan_data_source.md index 6dc011b90..b396bb2bb 100644 --- a/docs/content/en/latest/data/data-source/scan_data_source.md +++ b/docs/content/en/latest/data/data-source/scan_data_source.md @@ -5,39 +5,7 @@ weight: 190 superheading: "catalog_data_source." --- -``scan_data_source(data_source_id: str, scan_request: CatalogScanModelRequest = CatalogScanModelRequest(), report_warnings: bool = False)`` - -Scans the data source specified by its id and optionally by specified scan request. - -*CatalogScanResultPdm* contains PDM and warnings. Warnings contain information about columns which were not added to the PDM because their data types are not supported. - -Additional parameter *report_warnings* can be passed to suppress or to report warnings. - -By default warnings are returned but not reported to STDOUT. If you set *report_warnings* to True, warnings are reported to STDOUT. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} - -{{< parameter p_name="scan_request" p_type="Optional[CatalogScanModelRequest]" >}} -Options for the Scan Request. Defaults to CatalogScanModelRequest(). -{{< /parameter >}} - -{{< parameter p_name="report_warnings" p_type="Optional[bool]" >}} -Switch to turn on warnings. Defaults to False. -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} - -{{< parameter p_type="CatalogScanResultPdm" >}} -Physical Data Model scan result object. -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.scan_data_source" >}} ## Example ```python diff --git a/docs/content/en/latest/data/data-source/scan_schemata.md b/docs/content/en/latest/data/data-source/scan_schemata.md index bdaae2948..8c0a00b4b 100644 --- a/docs/content/en/latest/data/data-source/scan_schemata.md +++ b/docs/content/en/latest/data/data-source/scan_schemata.md @@ -5,29 +5,7 @@ weight: 210 superheading: "catalog_data_source." --- - - -``scan_schemata(data_source_id: str)`` - -Returns a list of schemas that exist in the database and can be configured in the data source entity. - -Data source managers like Dremio or Drill can work with multiple schemas and schema names can be injected into scan_request to filter out tables stored in the different schemas. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} - -{{< parameter p_type="list[string]" >}} -List of schema names for the given data source specified by its id. -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.scan_schemata" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/scan_sql.md b/docs/content/en/latest/data/data-source/scan_sql.md index ac789c09d..3fe75901f 100644 --- a/docs/content/en/latest/data/data-source/scan_sql.md +++ b/docs/content/en/latest/data/data-source/scan_sql.md @@ -5,31 +5,7 @@ weight: 210 superheading: "catalog_data_source." --- - - -``scan_sql(data_source_id: str, sql_request: ScanSqlRequest)`` - -Analyze SELECT SQL query in a given request. Return description of SQL result-set as list of column names with GoodData data types and list of example data returned by SELECT query. - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} - -{{< parameter p_name="sql_request" p_type="ScanSqlRequest" >}} -SELECT SQL query to analyze. -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} - -{{< parameter p_type="ScanSqlResponse" >}} -SELECT query analysis result. -{{< /parameter >}} - -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.scan_sql" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/store_declarative_data_sources.md b/docs/content/en/latest/data/data-source/store_declarative_data_sources.md index 18cfee10f..067cb83b8 100644 --- a/docs/content/en/latest/data/data-source/store_declarative_data_sources.md +++ b/docs/content/en/latest/data/data-source/store_declarative_data_sources.md @@ -5,33 +5,7 @@ weight: 90 superheading: "catalog_data_source." --- -``store_declarative_data_sources(layout_root_path: Path = Path.cwd())`` - -Stores the data sources layouts in a directory hierarchy. - - gooddata_layouts - └── organization_id - └── data_sources - ├── data_source_a - │ ├── pdm - │ │ ├── table_A.yaml - │ │ └── table_B.yaml - │ └── data_source_a.yaml - └── data_source_b - └── pdm - │ ├── table_X.yaml - │ └── table_Y.yaml - └── data_source_b.yaml - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="layout_root_path" p_type="Path" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} - -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.store_declarative_data_sources" >}} ## Example diff --git a/docs/content/en/latest/data/data-source/test_data_sources_connection.md b/docs/content/en/latest/data/data-source/test_data_sources_connection.md index b5bfc2f9f..22e77917c 100644 --- a/docs/content/en/latest/data/data-source/test_data_sources_connection.md +++ b/docs/content/en/latest/data/data-source/test_data_sources_connection.md @@ -5,40 +5,7 @@ weight: 220 superheading: "catalog_data_source." --- - - -``test_data_sources_connection(declarative_data_sources: CatalogDeclarativeDataSources, credentials_path: Optional[Path] = None)`` - -Tests connection to declarative data sources. If *credentials_path* is omitted then the connection is tested with empty credentials. - -In case some connection failed the ValueError is raised with information about why the connection to the data source failed, e.g. host unreachable or invalid login or password. - -Example of credentials YAML file: - - data_sources: - demo-test-ds: "demopass" - demo-bigquery-ds: "~/home/secrets.json" - -{{% parameters-block title="Parameters"%}} - -{{< parameter p_name="declarative_data_sources" p_type="CatalogDeclarativeDataSources" >}} -Declarative data sources object -{{< /parameter >}} -{{< parameter p_name="credentials_path" p_type="Optional[Path]" >}} -Path to the credentials. Defaults to None. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Raises"%}} - -{{< parameter p_type="ValueError" >}} -Check API references for possible errors of data source connections. -{{< /parameter >}} -{{% /parameters-block %}} - +{{< api-ref "sdk.CatalogDataSourceService.test_data_sources_connection" >}} ## Example diff --git a/docs/content/en/latest/data/physical-data-model/load_pdm_from_disk.md b/docs/content/en/latest/data/physical-data-model/load_pdm_from_disk.md index 4790ea80e..b8f88a190 100644 --- a/docs/content/en/latest/data/physical-data-model/load_pdm_from_disk.md +++ b/docs/content/en/latest/data/physical-data-model/load_pdm_from_disk.md @@ -5,22 +5,7 @@ weight: 140 superheading: "catalog_data_source." --- -``load_pdm_from_disk(path: Path = Path.cwd())`` - -This method is used to load pdm stored to disk using method [store_pdm_to_disk](../store_pdm_to_disk/). - - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="path" p_type="Optiona[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeTables" >}} -Physical Data Model object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.load_pdm_from_disk" >}} ## Example diff --git a/docs/content/en/latest/data/physical-data-model/store_pdm_to_disk.md b/docs/content/en/latest/data/physical-data-model/store_pdm_to_disk.md index 263be9b18..dca7f1410 100644 --- a/docs/content/en/latest/data/physical-data-model/store_pdm_to_disk.md +++ b/docs/content/en/latest/data/physical-data-model/store_pdm_to_disk.md @@ -5,29 +5,7 @@ weight: 140 superheading: "catalog_data_source." --- - - -``store_pdm_to_disk(data_source_id: str, path: Path = Path.cwd())`` - -Stores the physical data model layout in the directory for a given data source. -The directory structure below shows the output for the path set to `Path("pdm_location")`. - - pdm_location - └── pdm - ├── table_A.yaml - └── table_B.yaml - -{{% parameters-block title="Parameters"%}} -{{< parameter p_name="data_source_id" p_type="string" >}} -Data source identification string. e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd().(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogDataSourceService.store_pdm_to_disk" >}} ## Example diff --git a/docs/content/en/latest/execution/exports/export_pdf.md b/docs/content/en/latest/execution/exports/export_pdf.md index 685efea59..2906f0b09 100644 --- a/docs/content/en/latest/execution/exports/export_pdf.md +++ b/docs/content/en/latest/execution/exports/export_pdf.md @@ -5,49 +5,7 @@ weight: 110 superheading: "export." --- -``export_pdf(workspace_id: str, - dashboard_id: str, - file_name: str, - store_path: Union[str, Path] = Path.cwd(), - timeout: float = 60.0, - retry: float = 0.2, - max_retry: float = 5.0, - metadata: Optional[Dict[str, Any]] = None, - )`` - -Export a PDF of the specified GoodData Dashboard and save it to the specified file path. - - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the GoodData Workspace. -{{< /parameter >}} -{{< parameter p_name="dashboard_id" p_type="string" >}} -The ID of the GoodData Dashboard. -{{< /parameter >}} -{{< parameter p_name="file_name" p_type="String" >}} -The name of the PDF file (excluding the file extension). -{{< /parameter >}} -{{< parameter p_name="store_path" p_type="Union[String, Path]" >}} -The name of the PDF file (excluding the file extension). -{{< /parameter >}} -{{< parameter p_name="timeout" p_type="float" >}} -The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0. -{{< /parameter >}} -{{< parameter p_name="retry" p_type="float" >}} -Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2. -{{< /parameter >}} -{{< parameter p_name="max_retry" p_type="float" >}} -The maximum retry wait time (in seconds). Defaults to 5.0. -{{< /parameter >}} -{{< parameter p_name="metadata" p_type="Optional[Dict[str, Any]]" >}} -Specify the metadata for the export. Specific metadata can override filtering. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="true"%}} -{{% /parameters-block %}} - +{{< api-ref "sdk.ExportService.export_pdf" >}} ## Example diff --git a/docs/content/en/latest/execution/exports/export_tabular.md b/docs/content/en/latest/execution/exports/export_tabular.md index e9ce3898c..be2cbc0ec 100644 --- a/docs/content/en/latest/execution/exports/export_tabular.md +++ b/docs/content/en/latest/execution/exports/export_tabular.md @@ -5,42 +5,7 @@ weight: 110 superheading: "export." --- -``export_tabular(workspace_id: str, - export_request: ExportRequest, - file_name: str, - store_path: Union[str, Path] = Path.cwd(), - timeout: float = 60.0, - retry: float = 0.2, - max_retry: float = 5.0, - )`` - - Export Tabular (CSV, XLSX) data from the specified GoodData Dashboard report, saved to the specified file path. - - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the GoodData Workspace. -{{< /parameter >}} -{{< parameter p_name="export_request" p_type="ExportRequest" >}} -An instance of ExportRequest containing the required information for the tabular export. -{{< /parameter >}} -{{< parameter p_name="store_path" p_type="Union[String, Path]" >}} -The path to save the exported tabular data. Defaults to Path.cwd(). -{{< /parameter >}} -{{< parameter p_name="timeout" p_type="float" >}} -The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0. -{{< /parameter >}} -{{< parameter p_name="retry" p_type="float" >}} -Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2. -{{< /parameter >}} -{{< parameter p_name="max_retry" p_type="float" >}} -The maximum retry wait time (in seconds). Defaults to 5.0. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="true"%}} -{{% /parameters-block %}} - +{{< api-ref "sdk.ExportService.export_tabular" >}} ## Example diff --git a/docs/content/en/latest/execution/exports/export_tabular_by_visualization_id.md b/docs/content/en/latest/execution/exports/export_tabular_by_visualization_id.md index 3d849983a..8853992a6 100644 --- a/docs/content/en/latest/execution/exports/export_tabular_by_visualization_id.md +++ b/docs/content/en/latest/execution/exports/export_tabular_by_visualization_id.md @@ -5,55 +5,7 @@ weight: 110 superheading: "export." --- -``export_tabular_by_visualization_id( - workspace_id: str, - visualization_id: str, - file_format: str, - file_name: Optional[str] = None, - settings: Optional[ExportSettings] = None, - store_path: Union[str, Path] = Path.cwd(), - timeout: float = 60.0, - retry: float = 0.2, - max_retry: float = 5.0, - )`` - - Exports the tabular data for an visualization by its ID. - - - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the GoodData Workspace. -{{< /parameter >}} -{{< parameter p_name="visualization_id" p_type="string" >}} -The ID of the GoodData visualization. -{{< /parameter >}} -{{< parameter p_name="file_format" p_type="string" >}} -The format of the file to be exported. -{{< /parameter >}} -{{< parameter p_name="file_name" p_type="String" >}} -The name which the exported file should have. Defaults to None. -{{< /parameter >}} -{{< parameter p_name="settings" p_type="Optional[ExportSettings]" >}} -Any additional settings for the export. Defaults to None. -{{< /parameter >}} -{{< parameter p_name="store_path" p_type="Union[String, Path]" >}} -The path to store the exported file. Defaults to Path.cwd(). -{{< /parameter >}} -{{< parameter p_name="timeout" p_type="float" >}} -The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0. -{{< /parameter >}} -{{< parameter p_name="retry" p_type="float" >}} -Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2. -{{< /parameter >}} -{{< parameter p_name="max_retry" p_type="float" >}} -The maximum retry wait time (in seconds). Defaults to 5.0. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="true" %}} -{{% /parameters-block %}} - +{{< api-ref "sdk.ExportService.export_tabular_by_visualization_id" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/get_declarative_analytics_model.md b/docs/content/en/latest/workspace-content/analytics-model/get_declarative_analytics_model.md index c065ff8c4..c6aea437b 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/get_declarative_analytics_model.md +++ b/docs/content/en/latest/workspace-content/analytics-model/get_declarative_analytics_model.md @@ -5,27 +5,7 @@ weight: 110 superheading: "catalog_workspace_content." --- -``get_declarative_analytics_model(workspace_id: str, exclude: Optional[list[str]])`` - -Gets an analytics model layout. - - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="exclude" p_type="Optional[list[str]]" >}} -Defines properties which should not be included in the payload. -E.g.: ["ACTIVITY_INFO"] -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeAnalytics" >}} -Object Containing declarative Analytical Model. -{{< /parameter >}} -{{% /parameters-block %}} - +{{< api-ref "sdk.CatalogWorkspaceContentService.get_declarative_analytics_model" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/load_analytics_model_from_disk.md b/docs/content/en/latest/workspace-content/analytics-model/load_analytics_model_from_disk.md index 089105ea6..dfa8f1da9 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/load_analytics_model_from_disk.md +++ b/docs/content/en/latest/workspace-content/analytics-model/load_analytics_model_from_disk.md @@ -5,21 +5,7 @@ weight: 132 superheading: "catalog_workspace_content." --- -``load_analytics_model_from_disk(path: Path = Path.cwd())`` - -Loads the analytics model stored to disk using [store_analytics_model_to_disk](../store_analytics_model_to_disk/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeAnalytics" >}} -Object Containing declarative Analytical Model -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.load_analytics_model_from_disk" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/load_and_put_declarative_analytics_model.md b/docs/content/en/latest/workspace-content/analytics-model/load_and_put_declarative_analytics_model.md index d833708e5..9d31110fc 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/load_and_put_declarative_analytics_model.md +++ b/docs/content/en/latest/workspace-content/analytics-model/load_and_put_declarative_analytics_model.md @@ -5,23 +5,7 @@ weight: 150 superheading: "catalog_workspace_content." --- - - -``load_and_put_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_analytics_model](../load_declarative_analytics_model/) and [put_declarative_analytics_model](../put_declarative_analytics_model/) methods to load and set layouts stored using [store_declarative_analytics_model](../store_declarative_analytics_model/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.load_and_put_declarative_analytics_model" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/load_declarative_analytics_model.md b/docs/content/en/latest/workspace-content/analytics-model/load_declarative_analytics_model.md index 142373558..e8392c65f 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/load_declarative_analytics_model.md +++ b/docs/content/en/latest/workspace-content/analytics-model/load_declarative_analytics_model.md @@ -5,26 +5,7 @@ weight: 140 superheading: "catalog_workspace_content." --- - - -``load_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -Loads declarative analytics layout, which was stored using [store_declarative_analytics_model](../store_declarative_analytics_model/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeAnalytics" >}} -Object Containing declarative Analytical Model -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.load_declarative_analytics_model" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/put_declarative_analytics_model.md b/docs/content/en/latest/workspace-content/analytics-model/put_declarative_analytics_model.md index 3f114fd50..e4abd5aad 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/put_declarative_analytics_model.md +++ b/docs/content/en/latest/workspace-content/analytics-model/put_declarative_analytics_model.md @@ -5,21 +5,7 @@ weight: 120 superheading: "catalog_workspace_content." --- -``put_declarative_analytics_model(workspace_id: str, analytics_model: CatalogDeclarativeAnalytics)`` - -Sets the declarative analytics model for a given workspace. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="analytics_model" p_type="CatalogDeclarativeAnalytics" >}} -Object Containing declarative Analytical Model -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.put_declarative_analytics_model" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/store_analytics_model_to_disk.md b/docs/content/en/latest/workspace-content/analytics-model/store_analytics_model_to_disk.md index 63e7327e2..ff7b0e369 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/store_analytics_model_to_disk.md +++ b/docs/content/en/latest/workspace-content/analytics-model/store_analytics_model_to_disk.md @@ -5,36 +5,7 @@ weight: 131 superheading: "catalog_workspace_content." --- -``store_analytics_model_to_disk(workspace_id: str, path: Path = Path.cwd())`` - -Stores analytics model for a given workspace in directory hierarchy.This method does not tie the declarative analytics model to the workspace and organization, thus it is recommended for migration between workspaces. If you want to backup analytics model between workspaces or organizations, use [store_analytics_model_to_disk](../store_analytics_model_to_disk/). - -The directory structure below shows the output for the path set to `Path("analytics_model_location")`. - - analytics_model_location - └── analytics_model - ├── analytical_dashboards - │ └── analytical_dashboard.yaml - ├── dashboard_plugins - │ └── dashboard_plugin.yaml - ├── filter_contexts - │ └── filter_context.yaml - ├── metrics - │ └── metric.yaml - └── visualization_objects - └── visualization_object.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="str" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.store_analytics_model_to_disk" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/analytics-model/store_declarative_analytics_model.md b/docs/content/en/latest/workspace-content/analytics-model/store_declarative_analytics_model.md index 69408105a..31e99fb86 100644 --- a/docs/content/en/latest/workspace-content/analytics-model/store_declarative_analytics_model.md +++ b/docs/content/en/latest/workspace-content/analytics-model/store_declarative_analytics_model.md @@ -5,41 +5,7 @@ weight: 130 superheading: "catalog_workspace_content." --- - - -``store_declarative_analytics_model(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -Stores declarative analytics model for a given workspace in directory hierarchy. This method ties the declarative analytics model to the workspace and organization, thus it is recommended for backups. If you want to move declarative analytics model between workspaces or organizations, use [store_analytics_model_to_disk](../store_analytics_model_to_disk/). - -Store declarative analytics model layout in directory hierarchy. - - gooddata_layouts - └── organization_id - └── workspaces - └── workspace_id - └── analytics_model - ├── analytical_dashboards - │ └── analytical_dashboard.yaml - ├── dashboard_plugins - │ └── dashboard_plugin.yaml - ├── filter_contexts - │ └── filter_context.yaml - ├── metrics - │ └── metric.yaml - └── visualization_objects - └── visualization_object.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="str" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.store_declarative_analytics_model" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/localization/add_metadata_locale.md b/docs/content/en/latest/workspace-content/localization/add_metadata_locale.md index 2709b8a0f..101ace41f 100644 --- a/docs/content/en/latest/workspace-content/localization/add_metadata_locale.md +++ b/docs/content/en/latest/workspace-content/localization/add_metadata_locale.md @@ -5,27 +5,7 @@ weight: 25 superheading: "catalog_workspace." --- -``add_metadata_locale(workspace_id: str, target_language: str, translator_func: Callable, set_locale: bool = True) -> None`` - -Add and optionally set the metadata localization for a workspace in a target language. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the workspace. -{{< /parameter >}} -{{< parameter p_name="target_language" p_type="string" >}} -The target language for the metadata localization. -{{< /parameter >}} -{{< parameter p_name="translator_func" p_type="Callable" >}} -A function to translate the source text. -{{< /parameter >}} -{{< parameter p_name="set_locale" p_type="bool" >}} -Flag to indicate if the locale settings should be updated in the workspace. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.add_metadata_locale" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/localization/clean_metadata_localization.md b/docs/content/en/latest/workspace-content/localization/clean_metadata_localization.md index caad71e87..1facbc658 100644 --- a/docs/content/en/latest/workspace-content/localization/clean_metadata_localization.md +++ b/docs/content/en/latest/workspace-content/localization/clean_metadata_localization.md @@ -5,27 +5,7 @@ weight: 55 superheading: "catalog_workspace." --- -``add_metadata_locale(workspace_id: str, target_language: str, translator_func: Callable, set_locale: bool = True) -> None`` - -Add and optionally set the metadata localization for a workspace in a target language. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the workspace. -{{< /parameter >}} -{{< parameter p_name="target_language" p_type="string" >}} -The target language for the metadata localization. -{{< /parameter >}} -{{< parameter p_name="translator_func" p_type="Callable" >}} -A function to translate the source text. -{{< /parameter >}} -{{< parameter p_name="set_locale" p_type="bool" >}} -Flag to indicate if the locale settings should be updated in the workspace. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.clean_metadata_localization" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/localization/get_metadata_localization.md b/docs/content/en/latest/workspace-content/localization/get_metadata_localization.md index c192d7ace..9485fe268 100644 --- a/docs/content/en/latest/workspace-content/localization/get_metadata_localization.md +++ b/docs/content/en/latest/workspace-content/localization/get_metadata_localization.md @@ -5,24 +5,7 @@ weight: 52 superheading: "catalog_workspace." --- -``get_metadata_localization(workspace_id: str, target_language: str) -> bytes`` - -Retrieve the metadata localization for a workspace. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the workspace for which to retrieve the metadata localization. -{{< /parameter >}} -{{< parameter p_name="target_language" p_type="string" >}} -The target language code for the localization. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="bytes" >}} -Object Containing declarative Analytical Model. -{{< /parameter >}}The encoded metadata localization in the target language. -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.get_metadata_localization" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/localization/save_metadata_locale_to_disk.md b/docs/content/en/latest/workspace-content/localization/save_metadata_locale_to_disk.md index 4f878e0bc..092cd489d 100644 --- a/docs/content/en/latest/workspace-content/localization/save_metadata_locale_to_disk.md +++ b/docs/content/en/latest/workspace-content/localization/save_metadata_locale_to_disk.md @@ -5,24 +5,7 @@ weight: 56 superheading: "catalog_workspace." --- -``save_metadata_locale_to_disk(workspace_id: str, target_language: str, file_path: Path) -> None`` - -Save the metadata localization for a workspace to a file. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the workspace. -{{< /parameter >}} -{{< parameter p_name="target_language" p_type="string" >}} -The target language for the metadata localization. -{{< /parameter >}} -{{< parameter p_name="file_path" p_type="Path" >}} -The path to the file where the XLIFF content will be saved. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.save_metadata_locale_to_disk" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/localization/set_metadata_locale_from_disk.md b/docs/content/en/latest/workspace-content/localization/set_metadata_locale_from_disk.md index 514d29009..e5dadce36 100644 --- a/docs/content/en/latest/workspace-content/localization/set_metadata_locale_from_disk.md +++ b/docs/content/en/latest/workspace-content/localization/set_metadata_locale_from_disk.md @@ -5,21 +5,7 @@ weight: 57 superheading: "catalog_workspace." --- -``set_metadata_locale_from_disk(workspace_id: str, file_path: Path) -> None`` - -Load and set the metadata localization for a workspace from a file. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the workspace to which the metadata localization applies. -{{< /parameter >}} -{{< parameter p_name="file_path" p_type="Path" >}} -The path to the file containing the encoded XML metadata. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.set_metadata_locale_from_disk" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/localization/set_metadata_localization.md b/docs/content/en/latest/workspace-content/localization/set_metadata_localization.md index 7260b85cc..1c7aeae45 100644 --- a/docs/content/en/latest/workspace-content/localization/set_metadata_localization.md +++ b/docs/content/en/latest/workspace-content/localization/set_metadata_localization.md @@ -5,21 +5,7 @@ weight: 53 superheading: "catalog_workspace." --- -``set_metadata_localization(workspace_id: str, encoded_xml: bytes) -> None`` - -Set the metadata localization for a workspace. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -The ID of the workspace to which the metadata localization applies. -{{< /parameter >}} -{{< parameter p_name="encoded_xml" p_type="bytes" >}} -The encoded XML metadata to be set. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.set_metadata_localization" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/get_declarative_ldm.md b/docs/content/en/latest/workspace-content/logical-data-model/get_declarative_ldm.md index dfec36ff9..463ae8d62 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/get_declarative_ldm.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/get_declarative_ldm.md @@ -5,25 +5,7 @@ weight: 80 superheading: "catalog_workspace_content." --- - - -``get_declarative_ldm(workspace_id: str)`` - -Gets a logical model layout. - -On CatalogDeclarativeModel user can call ``modify_mapped_data_source(data_source_mapping: dict)`` method, which substitutes data source id in datasets. - -{{% 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="CatalogDeclarativeModel" >}} -Object Containing declarative Logical Data Model -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_declarative_ldm" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/load_and_put_declarative_ldm.md b/docs/content/en/latest/workspace-content/logical-data-model/load_and_put_declarative_ldm.md index e605ba05b..96107a11a 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/load_and_put_declarative_ldm.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/load_and_put_declarative_ldm.md @@ -5,26 +5,7 @@ weight: 120 superheading: "catalog_workspace_content." --- - - -``load_and_put_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd(), validator: Optional[DataSourceValidator])`` - -This method combines [load_declarative_ldm](../load_declarative_ldm/) and [put_declarative_ldm](../get_declarative_ldm/) methods to load and set layouts stored using [store_declarative_ldm](../store_declarative_ldm/). You can pass an additional validator parameter which checks that for every data source id in the logical data model the corresponding data source exists. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{< parameter p_name="validator" p_type="Optional[DataSourceValidator]" >}} -Object that manages validation, whether each data_source_id in LDM corresponds to existing data source. Defaults to None. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.load_and_put_declarative_ldm" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/load_declarative_ldm.md b/docs/content/en/latest/workspace-content/logical-data-model/load_declarative_ldm.md index f74393912..733c44d00 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/load_declarative_ldm.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/load_declarative_ldm.md @@ -5,26 +5,7 @@ weight: 110 superheading: "catalog_workspace_content." --- - - -``load_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -Loads declarative LDM layout, which was stored using [store_declarative_ldm](../store_declarative_ldm/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeModel" >}} -Object Containing declarative Logical Data Model -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.load_declarative_ldm" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/load_ldm_from_disk.md b/docs/content/en/latest/workspace-content/logical-data-model/load_ldm_from_disk.md index c4fb5249c..9ebe73743 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/load_ldm_from_disk.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/load_ldm_from_disk.md @@ -5,21 +5,7 @@ weight: 101 superheading: "catalog_workspace_content." --- -``load_ldm_from_disk( path: Path = Path.cwd())`` - -Loads the logical data model stored to disk using [store_ldm_to_disk](../store_ldm_to_disk/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeModel" >}} -Object Containing declarative Logical Data Model. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.load_ldm_from_disk" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/put_declarative_ldm.md b/docs/content/en/latest/workspace-content/logical-data-model/put_declarative_ldm.md index 7c7e290ab..66e96ce58 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/put_declarative_ldm.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/put_declarative_ldm.md @@ -5,28 +5,7 @@ weight: 90 superheading: "catalog_workspace_content." --- - - -``put_declarative_ldm(workspace_id: str, ldm: CatalogDeclarativeModel, validator: Optional[DataSourceValidator])`` - -Puts a logical data model into a given workspace. - -Optional validator checks that for every data_source_id in the logical data model there exists corresponding data source. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{< parameter p_name="ldm" p_type="CatalogDeclarativeModel" >}} -Object Containing declarative Logical Data Model -{{< /parameter >}} -{{< parameter p_name="validator" p_type="Optional[DataSourceValidator]" >}} -Object that manages validation, whether each data_source_id in LDM corresponds to existing data source. Defaults to None. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.put_declarative_ldm" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/store_declarative_ldm.md b/docs/content/en/latest/workspace-content/logical-data-model/store_declarative_ldm.md index 3968f82b0..02b59ae79 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/store_declarative_ldm.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/store_declarative_ldm.md @@ -5,34 +5,7 @@ weight: 100 superheading: "catalog_workspace_content." --- - - -``store_declarative_ldm(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -Stores the declarative logical data model for a given workspace in directory hierarchy. This method ties the LDM to the workspace and organization, thus it is recommended for backups. If you want to move LDM between workspaces or organizations, use [store_ldm_to_disk](../store_ldm_to_disk/). - - gooddata_layouts - └── organization_id - └── workspaces - └── workspace_id - └── analytics_model - └── ldm - ├── datasets - │ └── dataset.yaml - └── date_instances - └── date_instance.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.store_declarative_ldm" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/logical-data-model/store_ldm_to_disk.md b/docs/content/en/latest/workspace-content/logical-data-model/store_ldm_to_disk.md index 0c4a36679..1de049c92 100644 --- a/docs/content/en/latest/workspace-content/logical-data-model/store_ldm_to_disk.md +++ b/docs/content/en/latest/workspace-content/logical-data-model/store_ldm_to_disk.md @@ -5,31 +5,7 @@ weight: 100 superheading: "catalog_workspace_content." --- - -``store_ldm_to_disk(workspace_id: str, path: Path = Path.cwd())`` - -Stores the declarative logical data model for a given workspace in directory hierarchy. This method does not tie the LDM to the workspace and organization, thus it is recommended for migration between organizations. If you want to backup LDM use [store_declarative_ldm](../store_declarative_ldm/). - -The directory structure below shows the output for the path set to `Path("ldm_location")`. - - ldm_location - └── ldm - ├── datasets - │ └── dataset.yaml - └── date_instances - └── date_instance.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.store_ldm_to_disk" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/for_items.md b/docs/content/en/latest/workspace-content/workspace-content/for_items.md index a8bb60309..b7aaeb5f7 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/for_items.md +++ b/docs/content/en/latest/workspace-content/workspace-content/for_items.md @@ -5,29 +5,7 @@ weight: 11 superheading: "tables." --- - - -``for_items(workspace_id: str, items: list[Union[Attribute, Metric]], filters: Optional[list[Filter]] = None)`` - -Gets data as an ExecutionTable from the given list of attributes/metrics, and filters. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="items" p_type="list[Union[Attribute, Metric]]" >}} -Attributes and Metrics bundled together. -{{< /parameter >}} -{{< parameter p_name="filters" p_type="Optional[list[Filter]]" >}} -List of filters to be applied. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="ExecutionTable" >}} -Visualization data wrapper object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "dataframe.DataFrameFactory.for_items" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/for_visualization.md b/docs/content/en/latest/workspace-content/workspace-content/for_visualization.md index 9fc68ab92..aa49ff24f 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/for_visualization.md +++ b/docs/content/en/latest/workspace-content/workspace-content/for_visualization.md @@ -5,26 +5,7 @@ weight: 10 superheading: "tables." --- - - -``for_visualization(workspace_id: str, visualization: Visualization)`` - -Get data as an ExecutionTable from the given visualization. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="visualization" p_type="Visualization" >}} -Visualization object, representing a visualization. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="ExecutionTable" >}} -Visualization data wrapper object. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "dataframe.DataFrameFactory.for_visualization" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_attributes_catalog.md b/docs/content/en/latest/workspace-content/workspace-content/get_attributes_catalog.md index 2cbf79aa2..7dac9ad5a 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_attributes_catalog.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_attributes_catalog.md @@ -5,23 +5,7 @@ weight: 50 superheading: "catalog_workspace_content." --- - - -``get_attributes_catalog(workspace_id: str)`` - -Gets all attributes in a given 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[CatalogAttribute]" >}} -List of all attributes in a given workspace. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_attributes_catalog" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph.md b/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph.md index 9b3f005ce..7b4b3c2c8 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph.md @@ -5,31 +5,7 @@ weight: 90 superheading: "catalog_workspace_content." --- - - -``get_dependent_entities_graph(workspace_id: str)`` - -Gets the dependent entities graph for a given workspace. - -There are dependencies among all catalog objects, the chain is the following: - -`fact/attribute/label → dataset → metric → visualization → dashboard` - -Some steps can be skipped, e.g. `fact → visualization` - -We do not support `table → dataset` dependency yet. - -{{% 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="CatalogDependentEntitiesResponse" >}} -Dependent entities graph containing nodes and edges. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_dependent_entities_graph" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph_from_entry_points.md b/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph_from_entry_points.md index e7e4823cc..ad82692d5 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph_from_entry_points.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_dependent_entities_graph_from_entry_points.md @@ -5,26 +5,7 @@ weight: 100 superheading: "catalog_workspace_content." --- - - -``get_dependent_entities_graph_from_entry_points(workspace_id: str, dependent_entities_request: CatalogDependentEntitiesRequest)`` - -Extends the [get_dependent_entities_graph](../get_dependent_entities_graph/) with the entry point from which the graph is created. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="dependent_entities_request" p_type="CatalogDependentEntitiesRequest" >}} -Entry points for the dependent entities graph -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDependentEntitiesResponse" >}} -Dependent entities graph containing nodes and edges. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_dependent_entities_graph_from_entry_points" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_facts_catalog.md b/docs/content/en/latest/workspace-content/workspace-content/get_facts_catalog.md index 5bdb07e6c..5328064bd 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_facts_catalog.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_facts_catalog.md @@ -5,23 +5,7 @@ weight: 40 superheading: "catalog_workspace_content." --- - - -``get_facts_catalog(workspace_id: str)`` - -Gets all facts in a given 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[CatalogFact]" >}} -List of all facts in a given workspace. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_facts_catalog" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_full_catalog.md b/docs/content/en/latest/workspace-content/workspace-content/get_full_catalog.md index ecf1a66e0..d52bb3157 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_full_catalog.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_full_catalog.md @@ -5,23 +5,7 @@ weight: 20 superheading: "catalog_workspace_content." --- - - -``get_full_catalog(workspace_id: str)`` - -Gets catalog for a workspace. Catalog contains all data sets and metrics defined in that 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="CatalogWorkspaceContent" >}} -Object containing all data sets and metrics. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_full_catalog" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_labels_catalog.md b/docs/content/en/latest/workspace-content/workspace-content/get_labels_catalog.md index 456c615c8..d80fd4b4c 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_labels_catalog.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_labels_catalog.md @@ -5,23 +5,7 @@ weight: 60 superheading: "catalog_workspace_content." --- - - -``get_labels_catalog(workspace_id: str)`` - -Gets all labels in a given 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[CatalogLabel]" >}} -List of all labels in a given workspace. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_labels_catalog" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_metrics_catalog.md b/docs/content/en/latest/workspace-content/workspace-content/get_metrics_catalog.md index 48572af2a..6c1d3c1b8 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_metrics_catalog.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_metrics_catalog.md @@ -5,23 +5,7 @@ weight: 30 superheading: "catalog_workspace_content." --- - - -``get_metrics_catalog(workspace_id: str)`` - -Gets all metrics for 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[CatalogMetric]" >}} -List of all metrics in a given workspace. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceContentService.get_metrics_catalog" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_visualization.md b/docs/content/en/latest/workspace-content/workspace-content/get_visualization.md index 667ef2454..71b848399 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_visualization.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_visualization.md @@ -5,32 +5,7 @@ weight: 15 superheading: "visualizations." --- - - -``get_visualization(workspace_id: str, visualization_id: str, timeout: Optional[Union[int, float, Tuple]] = None)`` - -Get a single visualization from a workspace. - - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="visualization_id" p_type="string" >}} -Visualization identifier string e.g. "bikes" -{{< /parameter >}} -{{< parameter p_name="timeout" p_type="Optional[Union[int, float, Tuple]]" >}} -Timeout in seconds for the request. If a tuple is provided, the first element is the connect timeout -and the second element is the read timeout. If a single value is provided, it is used as both connect -and read timeout. If None, the default timeout is used. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="Visualization" >}} -A single Visualization object contains side loaded metadata about the entities it references -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.VisualizationService.get_visualization" >}} ## Example diff --git a/docs/content/en/latest/workspace-content/workspace-content/get_visualizations.md b/docs/content/en/latest/workspace-content/workspace-content/get_visualizations.md index 6ee8f4921..0a5c23113 100644 --- a/docs/content/en/latest/workspace-content/workspace-content/get_visualizations.md +++ b/docs/content/en/latest/workspace-content/workspace-content/get_visualizations.md @@ -5,21 +5,7 @@ weight: 15 superheading: "visualizations." --- -``get_visualizations(workspace_id: str)`` - -Get a list of visualization objects. - -{{% 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[Visualization]" >}} -All available visualizations, each visualization will contain side loaded metadata about the entities it references -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.VisualizationService.get_visualizations" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspace-data-filters/get_declarative_workspace_data_filters.md b/docs/content/en/latest/workspace/workspace-data-filters/get_declarative_workspace_data_filters.md index 8b50eb4fe..c77ad96f8 100644 --- a/docs/content/en/latest/workspace/workspace-data-filters/get_declarative_workspace_data_filters.md +++ b/docs/content/en/latest/workspace/workspace-data-filters/get_declarative_workspace_data_filters.md @@ -5,18 +5,7 @@ weight: 140 superheading: "catalog_workspace." --- -``get_declarative_workspace_data_filters()`` - -Gets a workspace data filers layout. - -{{% parameters-block title="Parameters" None="yes"%}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeWorkspaceDataFilters" >}} -Object containing List of declarative workspace data filters. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.get_declarative_workspace_data_filters" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspace-data-filters/load_and_put_declarative_workspace_data_filters.md b/docs/content/en/latest/workspace/workspace-data-filters/load_and_put_declarative_workspace_data_filters.md index 2980cf5d9..9ae7a8dc0 100644 --- a/docs/content/en/latest/workspace/workspace-data-filters/load_and_put_declarative_workspace_data_filters.md +++ b/docs/content/en/latest/workspace/workspace-data-filters/load_and_put_declarative_workspace_data_filters.md @@ -5,21 +5,7 @@ weight: 180 superheading: "catalog_workspace." --- - - -``load_and_put_declarative_workspace_data_filters(layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_workspace_data_filters](../load_declarative_workspace_data_filters/) and [put_declarative_workspace_data_filters](../put_declarative_workspace_data_filters/) methods to load and set layouts stored using [store_declarative_workspace_data_filters](../store_declarative_workspace_data_filters/). - - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.load_and_put_declarative_workspace_data_filters" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspace-data-filters/load_declarative_workspace_data_filters.md b/docs/content/en/latest/workspace/workspace-data-filters/load_declarative_workspace_data_filters.md index 7188ead32..fdf132533 100644 --- a/docs/content/en/latest/workspace/workspace-data-filters/load_declarative_workspace_data_filters.md +++ b/docs/content/en/latest/workspace/workspace-data-filters/load_declarative_workspace_data_filters.md @@ -5,23 +5,7 @@ weight: 170 superheading: "catalog_workspace." --- - - -``load_declarative_workspace_data_filters(layout_root_path: Path = Path.cwd())`` - -Loads the declarative workspaces layout, which was stored using [store_declarative_workspace_data_filters](../store_declarative_workspace_data_filters/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeWorkspaceDataFilters" >}} -Object containing List of declarative workspace data filters. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.load_declarative_workspace_data_filters" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspace-data-filters/put_declarative_workspace_data_filters.md b/docs/content/en/latest/workspace/workspace-data-filters/put_declarative_workspace_data_filters.md index 868008851..27eb1c2ae 100644 --- a/docs/content/en/latest/workspace/workspace-data-filters/put_declarative_workspace_data_filters.md +++ b/docs/content/en/latest/workspace/workspace-data-filters/put_declarative_workspace_data_filters.md @@ -5,20 +5,7 @@ weight: 150 superheading: "catalog_workspace." --- - - -``put_declarative_workspace_data_filters(workspace_data_filters: CatalogDeclarativeWorkspaceDataFilters)`` - -Sets a workspace data filter layout. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_data_filters" p_type="CatalogDeclarativeWorkspaceDataFilters" >}} -Object containing List of declarative workspace data filters. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.put_declarative_workspace_data_filters" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspace-data-filters/store_declarative_workspace_data_filters.md b/docs/content/en/latest/workspace/workspace-data-filters/store_declarative_workspace_data_filters.md index d8bfb8174..2aa0dda2a 100644 --- a/docs/content/en/latest/workspace/workspace-data-filters/store_declarative_workspace_data_filters.md +++ b/docs/content/en/latest/workspace/workspace-data-filters/store_declarative_workspace_data_filters.md @@ -5,27 +5,7 @@ weight: 160 superheading: "catalog_workspace." --- - - -``store_declarative_workspace_data_filters(layout_root_path: Path = Path.cwd())`` - -Stores workspace data filters in directory hierarchy. - - gooddata_layouts - └── organization_id - └── workspaces_data_filters - ├── filter_1.yaml - └── filter_2.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} - +{{< api-ref "sdk.CatalogWorkspaceService.store_declarative_workspace_data_filters" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/clone_workspace.md b/docs/content/en/latest/workspace/workspaces/clone_workspace.md index 94baf9f46..4febe86de 100644 --- a/docs/content/en/latest/workspace/workspaces/clone_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/clone_workspace.md @@ -5,46 +5,7 @@ weight: 21 superheading: "catalog_workspace." --- - - -``clone_workspace(source_workspace_id: str, target_workspace_id: Optional[str] = None, target_workspace_name: Optional[str] = None, overwrite_existing: Optional[bool] = None, data_source_mapping: Optional[dict] = None, upper_case: Optional[bool] = True )`` - -Clone workspace from existing workspace. - -Clones complete workspace content - LDM, ADM, permissions. If the target workspace already exists, it's content is overwritten. - -This can be useful when testing changes in the clone - once you are satisfied, you can clone it back to the origin workspace. - -For the safety, you have to enforce this behavior by the dedicated input argument `overwrite_existing`. Beware of workspace data filters - after the clone you have to set WDF value for the new workspace. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="source_workspace_id" p_type="string" >}} -Source workspace ID, from which we wanna create a clone -{{< /parameter >}} -{{< parameter p_name="target_workspace_id" p_type="Optional[string]" >}} -Target workspace ID, where we wanna clone the source workspaceOptional, if empty, we generate _clone -{{< /parameter >}} -{{< parameter p_name="target_workspace_name" p_type="Optional[string]" >}} - Target workspace name, if empty, we generate (Clone) -{{< /parameter >}} -{{< parameter p_name="overwrite_existing" p_type="bool" >}} -Overwrite existing workspace. -{{< /parameter >}} -{{< parameter p_name="data_source_mapping" p_type="Optional[dict]" >}} -Optional, allows users to map LDM to different data source ID -{{< /parameter >}} -{{< parameter p_name="upper_case" p_type="Optional[bool]" >}} -Optional, allows users to change the case of all physical object IDs (table names, columns names) - -**True** changes it to upper-case, **False** to lower-case, None(default) is noop - - -Useful when migrating to Snowflake, which is the only DB with upper-case default. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.clone_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/create_or_update.md b/docs/content/en/latest/workspace/workspaces/create_or_update.md index 4e94a1897..26688ceff 100644 --- a/docs/content/en/latest/workspace/workspaces/create_or_update.md +++ b/docs/content/en/latest/workspace/workspaces/create_or_update.md @@ -5,22 +5,7 @@ weight: 10 superheading: "catalog_workspace." --- -``create_or_update(workspace: CatalogWorkspace)`` - -Creates a new workspace or overwrite an existing workspace with the same id. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace" p_type="CatalogWorkspace" >}} -Data source Object, including physical data model. -{{< /parameter >}} -{{% /parameters-block %}} -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} -{{% parameters-block title="Raises" %}} -{{< parameter p_type="Value Error" >}} -Workspace parent can not be updated. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.create_or_update" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/delete_workspace.md b/docs/content/en/latest/workspace/workspaces/delete_workspace.md index 03ccceb7c..cc5fa7630 100644 --- a/docs/content/en/latest/workspace/workspaces/delete_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/delete_workspace.md @@ -5,31 +5,7 @@ weight: 30 superheading: "catalog_workspace." --- - - -``delete_workspace(workspace_id: str)`` - -Deletes a workspace with all its content - logical model and analytics model. - -This method is implemented according to our implementation of delete workspace, which returns HTTP 204 no matter if the workspace_id exists. - -{{% 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" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Raises" %}} -{{< parameter p_type="Value Error" >}} -Workspace does not exist. -{{< /parameter >}} -{{< parameter p_type="Value Error" >}} -Workspace is a parent of a workspace. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.delete_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/get_declarative_automations.md b/docs/content/en/latest/workspace/workspaces/get_declarative_automations.md index 072d1062a..0d58182a4 100644 --- a/docs/content/en/latest/workspace/workspaces/get_declarative_automations.md +++ b/docs/content/en/latest/workspace/workspaces/get_declarative_automations.md @@ -5,21 +5,7 @@ weight: 50 superheading: "catalog_workspace." --- -``get_declarative_automations(workspace_id: str)`` - -Gets the layout of all workspaces and their hierarchy. - -{{% 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[CatalogDeclarativeAutomation]" >}} -Retrieve a list of declarative automations. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.get_declarative_automations" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/get_declarative_workspace.md b/docs/content/en/latest/workspace/workspaces/get_declarative_workspace.md index 87b5c059e..5937d6ec2 100644 --- a/docs/content/en/latest/workspace/workspaces/get_declarative_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/get_declarative_workspace.md @@ -5,29 +5,7 @@ weight: 100 superheading: "catalog_workspace." --- - -``get_declarative_workspace(workspace_id: str, exclude: Optional[list[str]])`` - -Get all workspaces in the current organization in a declarative form. -This method combines -`sdk.catalog_workspace_content.get_declarative_ldm` and `sdk.catalog_workspace_content.get_declarative_analytics_model` -methods and returns a declarative workspace object. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="exclude" p_type="Optional[list[str]]" >}} -Defines properties which should not be included in the payload. -E.g.: ["ACTIVITY_INFO"] -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeWorkspaces" >}} -Declarative Workspaces object including all the workspaces for given organization. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.get_declarative_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/get_declarative_workspaces.md b/docs/content/en/latest/workspace/workspaces/get_declarative_workspaces.md index 690c084da..482a2518a 100644 --- a/docs/content/en/latest/workspace/workspaces/get_declarative_workspaces.md +++ b/docs/content/en/latest/workspace/workspaces/get_declarative_workspaces.md @@ -5,18 +5,7 @@ weight: 50 superheading: "catalog_workspace." --- -``get_declarative_workspaces()`` - -Gets the layout of all workspaces and their hierarchy. - -{{% parameters-block title="Parameters" None="yes" %}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="CatalogDeclarativeWorkspaces" >}} -Declarative Workspaces object including all the workspaces for given organization. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.get_declarative_workspaces" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/get_workspace.md b/docs/content/en/latest/workspace/workspaces/get_workspace.md index 1dc543478..af6218934 100644 --- a/docs/content/en/latest/workspace/workspaces/get_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/get_workspace.md @@ -5,23 +5,7 @@ weight: 20 superheading: "catalog_workspace." --- - - -``get_workspace(workspace_id: str)`` - -Gets an individual 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="CatalogWorkspace" >}} -Catalog workspace object containing structure of the workspace. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.get_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/list_workspaces.md b/docs/content/en/latest/workspace/workspaces/list_workspaces.md index 24704d30b..8d1bb2b51 100644 --- a/docs/content/en/latest/workspace/workspaces/list_workspaces.md +++ b/docs/content/en/latest/workspace/workspaces/list_workspaces.md @@ -5,20 +5,7 @@ weight: 40 superheading: "catalog_workspace." --- - - -``list_workspaces()`` - -Gets a list of all existing workspaces. - -{{% parameters-block title="Parameters" None="yes"%}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" %}} -{{< parameter p_type="List[CatalogWorkspace]" >}} -List of workspaces in the current organization. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.list_workspaces" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspace.md b/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspace.md index f9aa5adcf..aa710031a 100644 --- a/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspace.md @@ -5,24 +5,7 @@ weight: 130 superheading: "catalog_workspace." --- - - -``load_and_put_declarative_workspace(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_workspace](../load_declarative_workspace/) and [put_declarative_workspace](../put_declarative_workspace/) methods to load and -set layouts stored using [store_declarative_workspace](../store_declarative_workspace/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.load_and_put_declarative_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspaces.md b/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspaces.md index edfcadcf2..e4705c49a 100644 --- a/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspaces.md +++ b/docs/content/en/latest/workspace/workspaces/load_and_put_declarative_workspaces.md @@ -5,21 +5,7 @@ weight: 90 superheading: "catalog_workspace." --- - - -``load_and_put_declarative_workspaces(layout_root_path: Path = Path.cwd())`` - -This method combines [load_declarative_workspaces](../load_declarative_workspaces/) and [put_declarative_workspaces](../put_declarative_workspaces/) methods to load and -set layouts stored using [store_declarative_workspaces](../store_declarative_workspaces/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes"%}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.load_and_put_declarative_workspaces" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/load_declarative_workspace.md b/docs/content/en/latest/workspace/workspaces/load_declarative_workspace.md index 85d996e01..0068ec468 100644 --- a/docs/content/en/latest/workspace/workspaces/load_declarative_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/load_declarative_workspace.md @@ -5,26 +5,8 @@ weight: 120 superheading: "catalog_workspace." --- +{{< api-ref "sdk.CatalogWorkspaceService.load_declarative_workspace" >}} - -``load_declarative_workspace(workspace_id: str, layout_root_path: Path = Path.cwd())`` - -Loads declarative workspaces layout, which was stored using [store_declarative_workspace](../store_declarative_workspace/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDeclarativeWorkspaceModel" >}} -Object Containing declarative Logical Data Model and declarative Analytical Model. -{{< /parameter >}} -{{% /parameters-block %}} ## Example ```python diff --git a/docs/content/en/latest/workspace/workspaces/load_declarative_workspaces.md b/docs/content/en/latest/workspace/workspaces/load_declarative_workspaces.md index d3f495964..f55763930 100644 --- a/docs/content/en/latest/workspace/workspaces/load_declarative_workspaces.md +++ b/docs/content/en/latest/workspace/workspaces/load_declarative_workspaces.md @@ -5,23 +5,7 @@ weight: 80 superheading: "catalog_workspace." --- - - -``load_declarative_workspaces(layout_root_path: Path = Path.cwd())`` - -Loads declarative workspaces layout, which was stored using [store_declarative_workspaces](../store_declarative_workspaces/). - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns"%}} -{{< parameter p_type="CatalogDeclarativeWorkspaceModel" >}} -Object Containing declarative Logical Data Model and declarative Analytical Model. -{{< /parameter >}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.load_declarative_workspaces" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/put_declarative_automations.md b/docs/content/en/latest/workspace/workspaces/put_declarative_automations.md index 97434f595..d1bbd3e5d 100644 --- a/docs/content/en/latest/workspace/workspaces/put_declarative_automations.md +++ b/docs/content/en/latest/workspace/workspaces/put_declarative_automations.md @@ -5,21 +5,7 @@ weight: 50 superheading: "catalog_workspace." --- -``put_declarative_automations(workspace_id: str, automations: list[CatalogDeclarativeAutomation])`` - -Set automations for the workspace. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="automations" p_type="list[CatalogDeclarativeAutomation]" >}} -List of declarative automations. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.put_declarative_automations" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/put_declarative_workspace.md b/docs/content/en/latest/workspace/workspaces/put_declarative_workspace.md index d6509efbe..3adf72cb0 100644 --- a/docs/content/en/latest/workspace/workspaces/put_declarative_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/put_declarative_workspace.md @@ -5,23 +5,7 @@ weight: 110 superheading: "catalog_workspace." --- - - -``put_declarative_workspace(workspace_id: str, workspace: CatalogDeclarativeWorkspaceModel)`` - -Sets a workspace layout. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="workspace" p_type="CatalogDeclarativeWorkspaceModel" >}} -Object Containing declarative Logical Data Model and declarative Analytical Model. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.put_declarative_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/put_declarative_workspaces.md b/docs/content/en/latest/workspace/workspaces/put_declarative_workspaces.md index f74c1a6aa..f6bd0359d 100644 --- a/docs/content/en/latest/workspace/workspaces/put_declarative_workspaces.md +++ b/docs/content/en/latest/workspace/workspaces/put_declarative_workspaces.md @@ -5,18 +5,7 @@ weight: 60 superheading: "catalog_workspace." --- -``put_declarative_workspaces(workspace: CatalogDeclarativeWorkspaces)`` - -Sets the layout of all workspaces and their hierarchy. - -{{% parameters-block title="Parameters" %}} -{{< parameter p_type="CatalogDeclarativeWorkspaces" p_name="workspace" >}} -Declarative Workspaces object including all the workspaces for given organization. -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.put_declarative_workspaces" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/store_declarative_workspace.md b/docs/content/en/latest/workspace/workspaces/store_declarative_workspace.md index 715f0e903..10486b1df 100644 --- a/docs/content/en/latest/workspace/workspaces/store_declarative_workspace.md +++ b/docs/content/en/latest/workspace/workspaces/store_declarative_workspace.md @@ -5,44 +5,7 @@ weight: 115 superheading: "catalog_workspace." --- - - -`store_declarative_workspace(workspace_id: str, layout_root_path: Path = Path.cwd())` - -Stores the workspace layout in a directory hierarchy. - - gooddata_layouts - └── organization_id - └── workspaces - └── workspace_a - ├── analytics_model - │ ├── analytical_dashboards - │ │ └── analytical_dashboard.yaml - │ ├── dashboard_plugins - │ │ └── dashboard_plugin.yaml - │ ├── filter_contexts - │ │ └── filter_context.yaml - │ ├── metrics - │ │ └── metric.yaml - │ └── visualization_objects - │ └── visualization_object.yaml - └── ldm - ├── datasets - │ └── dataset.yaml - └── date_instances - └── date_instance.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="workspace_id" p_type="string" >}} -Workspace identification string e.g. "demo" -{{< /parameter >}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.store_declarative_workspace" >}} ## Example diff --git a/docs/content/en/latest/workspace/workspaces/store_declarative_workspaces.md b/docs/content/en/latest/workspace/workspaces/store_declarative_workspaces.md index a4aac72f4..22a8506a9 100644 --- a/docs/content/en/latest/workspace/workspaces/store_declarative_workspaces.md +++ b/docs/content/en/latest/workspace/workspaces/store_declarative_workspaces.md @@ -5,48 +5,7 @@ weight: 70 superheading: "catalog_workspace." --- - - -``store_declarative_workspaces(layout_root_path: Path = Path.cwd())`` - -Stores declarative workspaces in a given path, as folder hierarchy. - - gooddata_layouts - └── organization_id - ├── workspaces - │ ├── workspace_a - │ │ ├── analytics_model - │ │ │ ├── analytical_dashboards - │ │ │ │ └── analytical_dashboard.yaml - │ │ │ ├── dashboard_plugins - │ │ │ │ └── dashboard_plugin.yaml - │ │ │ ├── filter_contexts - │ │ │ │ └── filter_context.yaml - │ │ │ ├── metrics - │ │ │ │ └── metric.yaml - │ │ │ └── visualization_objects - │ │ │ └── visualization_object.yaml - │ │ ├── ldm - │ │ │ ├── datasets - │ │ │ │ └── dataset.yaml - │ │ │ └── date_instances - │ │ │ └── date_instance.yaml - │ │ └── workspace_a.yaml - │ └── workspace_b - │ └── ... - │ - └── workspaces_data_filters - ├── filter_1.yaml - └── filter_2.yaml - -{{% parameters-block title="Parameters" %}} -{{< parameter p_name="layout_root_path" p_type="Optional[Path]" >}} -Path to the root of the layout directory. Defaults to Path.cwd(). -{{< /parameter >}} -{{% /parameters-block %}} - -{{% parameters-block title="Returns" None="yes" %}} -{{% /parameters-block %}} +{{< api-ref "sdk.CatalogWorkspaceService.store_declarative_workspaces" >}} ## Example