From 057f4af1263197c0fd6c90945a4c0d5a3eb64a00 Mon Sep 17 00:00:00 2001 From: Jan Kadlec Date: Sat, 14 Mar 2026 21:06:42 +0100 Subject: [PATCH] fix(gooddata-sdk): fix copyright year and docs format in appearance service Update copyright from 2024 to 2026 in all new appearance module files. Migrate documentation from markdown tables to Hugo shortcodes (parameters-block/parameter) to match the existing documentation style. jira: trivial risk: nonprod --- .../appearance/create_color_palette.md | 15 +++++----- .../administration/appearance/create_theme.md | 15 +++++----- .../appearance/delete_color_palette.md | 29 +++++++++---------- .../administration/appearance/delete_theme.md | 29 +++++++++---------- .../appearance/get_color_palette.md | 20 ++++++------- .../administration/appearance/get_theme.md | 20 ++++++------- .../appearance/list_color_palettes.md | 15 +++++----- .../administration/appearance/list_themes.md | 15 +++++----- .../appearance/update_color_palette.md | 29 +++++++++---------- .../administration/appearance/update_theme.md | 29 +++++++++---------- .../catalog/appearance/__init__.py | 2 +- .../appearance/entity_model/__init__.py | 2 +- .../appearance/entity_model/color_palette.py | 2 +- .../catalog/appearance/entity_model/theme.py | 2 +- .../catalog/appearance/service.py | 2 +- 15 files changed, 109 insertions(+), 117 deletions(-) diff --git a/docs/content/en/latest/administration/appearance/create_color_palette.md b/docs/content/en/latest/administration/appearance/create_color_palette.md index 5b206ec1b..3679a83b1 100644 --- a/docs/content/en/latest/administration/appearance/create_color_palette.md +++ b/docs/content/en/latest/administration/appearance/create_color_palette.md @@ -9,12 +9,11 @@ weight: 220 Create a new color palette. -## Parameters +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="color_palette" p_type="CatalogColorPalette" >}} +A catalog color palette object to be created. +{{< /parameter >}} +{{% /parameters-block %}} -| parameter | type | description | -| -- | -- | -- | -| color_palette | CatalogColorPalette | A catalog color palette object to be created. | - -## Returns - -_None_ +{{% parameters-block title="Returns" None="yes"%}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/create_theme.md b/docs/content/en/latest/administration/appearance/create_theme.md index 54b7fe0dd..2d6b277e4 100644 --- a/docs/content/en/latest/administration/appearance/create_theme.md +++ b/docs/content/en/latest/administration/appearance/create_theme.md @@ -9,12 +9,11 @@ weight: 120 Create a new theme. -## Parameters +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="theme" p_type="CatalogTheme" >}} +A catalog theme object to be created. +{{< /parameter >}} +{{% /parameters-block %}} -| parameter | type | description | -| -- | -- | -- | -| theme | CatalogTheme | A catalog theme object to be created. | - -## Returns - -_None_ +{{% parameters-block title="Returns" None="yes"%}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/delete_color_palette.md b/docs/content/en/latest/administration/appearance/delete_color_palette.md index 8dced3d02..1fa52d670 100644 --- a/docs/content/en/latest/administration/appearance/delete_color_palette.md +++ b/docs/content/en/latest/administration/appearance/delete_color_palette.md @@ -9,18 +9,17 @@ weight: 240 Delete a color palette. -## Parameters - -| parameter | type | description | -| -- | -- | -- | -| color_palette_id | str | Color palette identification string e.g. "my_palette" | - -## Returns - -_None_ - -## Raises - -| type | description | -| -- | -- | -| ValueError | Color palette does not exist. | +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="color_palette_id" p_type="string" >}} +Color palette identification string e.g. "my_palette" +{{< /parameter >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" None="yes"%}} +{{% /parameters-block %}} + +{{% parameters-block title="Raises" %}} +{{< parameter p_type="Value Error" >}} +Color palette does not exist. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/delete_theme.md b/docs/content/en/latest/administration/appearance/delete_theme.md index 934868b32..e8213d9be 100644 --- a/docs/content/en/latest/administration/appearance/delete_theme.md +++ b/docs/content/en/latest/administration/appearance/delete_theme.md @@ -9,18 +9,17 @@ weight: 140 Delete a theme. -## Parameters - -| parameter | type | description | -| -- | -- | -- | -| theme_id | str | Theme identification string e.g. "my_dark_theme" | - -## Returns - -_None_ - -## Raises - -| type | description | -| -- | -- | -| ValueError | Theme does not exist. | +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="theme_id" p_type="string" >}} +Theme identification string e.g. "my_dark_theme" +{{< /parameter >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" None="yes"%}} +{{% /parameters-block %}} + +{{% parameters-block title="Raises" %}} +{{< parameter p_type="Value Error" >}} +Theme does not exist. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/get_color_palette.md b/docs/content/en/latest/administration/appearance/get_color_palette.md index 8b76f01db..61d8a6086 100644 --- a/docs/content/en/latest/administration/appearance/get_color_palette.md +++ b/docs/content/en/latest/administration/appearance/get_color_palette.md @@ -9,14 +9,14 @@ weight: 210 Get an individual color palette. -## Parameters +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="color_palette_id" p_type="string" >}} +Color palette identification string e.g. "my_palette" +{{< /parameter >}} +{{% /parameters-block %}} -| parameter | type | description | -| -- | -- | -- | -| color_palette_id | str | Color palette identification string e.g. "my_palette" | - -## Returns - -| type | description | -| -- | -- | -| CatalogColorPalette | Catalog color palette object containing structure of the color palette. | +{{% parameters-block title="Returns" %}} +{{< parameter p_type="CatalogColorPalette" >}} +Catalog color palette object containing structure of the color palette. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/get_theme.md b/docs/content/en/latest/administration/appearance/get_theme.md index 1f574f79b..7156ca3ab 100644 --- a/docs/content/en/latest/administration/appearance/get_theme.md +++ b/docs/content/en/latest/administration/appearance/get_theme.md @@ -9,14 +9,14 @@ weight: 110 Get an individual theme. -## Parameters +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="theme_id" p_type="string" >}} +Theme identification string e.g. "my_dark_theme" +{{< /parameter >}} +{{% /parameters-block %}} -| parameter | type | description | -| -- | -- | -- | -| theme_id | str | Theme identification string e.g. "my_dark_theme" | - -## Returns - -| type | description | -| -- | -- | -| CatalogTheme | Catalog theme object containing structure of the theme. | +{{% parameters-block title="Returns" %}} +{{< parameter p_type="CatalogTheme" >}} +Catalog theme object containing structure of the theme. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/list_color_palettes.md b/docs/content/en/latest/administration/appearance/list_color_palettes.md index 00755f3da..a2e8d8583 100644 --- a/docs/content/en/latest/administration/appearance/list_color_palettes.md +++ b/docs/content/en/latest/administration/appearance/list_color_palettes.md @@ -9,12 +9,11 @@ weight: 200 Returns a list of all color palettes in the current organization. -## Parameters +{{% parameters-block title="Parameters" None="yes"%}} +{{% /parameters-block %}} -_None_ - -## Returns - -| type | description | -| -- | -- | -| list[CatalogColorPalette] | List of color palettes in the current organization. | +{{% parameters-block title="Returns" %}} +{{< parameter p_type="list[CatalogColorPalette]" >}} +List of color palettes in the current organization. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/list_themes.md b/docs/content/en/latest/administration/appearance/list_themes.md index 50c11edde..e852b0094 100644 --- a/docs/content/en/latest/administration/appearance/list_themes.md +++ b/docs/content/en/latest/administration/appearance/list_themes.md @@ -9,12 +9,11 @@ weight: 100 Returns a list of all themes in the current organization. -## Parameters +{{% parameters-block title="Parameters" None="yes"%}} +{{% /parameters-block %}} -_None_ - -## Returns - -| type | description | -| -- | -- | -| list[CatalogTheme] | List of themes in the current organization. | +{{% parameters-block title="Returns" %}} +{{< parameter p_type="list[CatalogTheme]" >}} +List of themes in the current organization. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/update_color_palette.md b/docs/content/en/latest/administration/appearance/update_color_palette.md index b0ad0bd56..26cb22c28 100644 --- a/docs/content/en/latest/administration/appearance/update_color_palette.md +++ b/docs/content/en/latest/administration/appearance/update_color_palette.md @@ -9,18 +9,17 @@ weight: 230 Update a color palette. -## Parameters - -| parameter | type | description | -| -- | -- | -- | -| color_palette | CatalogColorPalette | A catalog color palette object to be updated. | - -## Returns - -_None_ - -## Raises - -| type | description | -| -- | -- | -| ValueError | Color palette does not exist. | +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="color_palette" p_type="CatalogColorPalette" >}} +A catalog color palette object to be updated. +{{< /parameter >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" None="yes"%}} +{{% /parameters-block %}} + +{{% parameters-block title="Raises" %}} +{{< parameter p_type="Value Error" >}} +Color palette does not exist. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/docs/content/en/latest/administration/appearance/update_theme.md b/docs/content/en/latest/administration/appearance/update_theme.md index b394a49b5..ffe3c5292 100644 --- a/docs/content/en/latest/administration/appearance/update_theme.md +++ b/docs/content/en/latest/administration/appearance/update_theme.md @@ -9,18 +9,17 @@ weight: 130 Update a theme. -## Parameters - -| parameter | type | description | -| -- | -- | -- | -| theme | CatalogTheme | A catalog theme object to be updated. | - -## Returns - -_None_ - -## Raises - -| type | description | -| -- | -- | -| ValueError | Theme does not exist. | +{{% parameters-block title="Parameters" %}} +{{< parameter p_name="theme" p_type="CatalogTheme" >}} +A catalog theme object to be updated. +{{< /parameter >}} +{{% /parameters-block %}} + +{{% parameters-block title="Returns" None="yes"%}} +{{% /parameters-block %}} + +{{% parameters-block title="Raises" %}} +{{< parameter p_type="Value Error" >}} +Theme does not exist. +{{< /parameter >}} +{{% /parameters-block %}} diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/__init__.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/__init__.py index 06549c73b..efe7c60c8 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/__init__.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/__init__.py @@ -1 +1 @@ -# (C) 2024 GoodData Corporation +# (C) 2026 GoodData Corporation diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/__init__.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/__init__.py index 06549c73b..efe7c60c8 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/__init__.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/__init__.py @@ -1 +1 @@ -# (C) 2024 GoodData Corporation +# (C) 2026 GoodData Corporation diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/color_palette.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/color_palette.py index 4d82505df..883d89e1c 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/color_palette.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/color_palette.py @@ -1,4 +1,4 @@ -# (C) 2024 GoodData Corporation +# (C) 2026 GoodData Corporation from __future__ import annotations from typing import Any diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/theme.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/theme.py index 0fac1430c..4f54d0b0e 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/theme.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/entity_model/theme.py @@ -1,4 +1,4 @@ -# (C) 2024 GoodData Corporation +# (C) 2026 GoodData Corporation from __future__ import annotations from typing import Any diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/service.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/service.py index ef6f0bbcf..54876466f 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/service.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/appearance/service.py @@ -1,4 +1,4 @@ -# (C) 2024 GoodData Corporation +# (C) 2026 GoodData Corporation from __future__ import annotations import functools