Skip to content

Commit b8b25a2

Browse files
action ref updates and final checks
1 parent c53bef7 commit b8b25a2

11 files changed

Lines changed: 100 additions & 71 deletions

File tree

modules/ROOT/pages/common/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
** link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground]
2323
** link:{{navprefix}}/graphql-play-ground[GraphQL Playground]
2424
** +++<a href="{{previewPrefix}}/api/rest/playgroundV1" target="_blank">REST API v1 Playground</a>+++
25-
** link:{{navprefix}}/theme-builder[Theme Builder ^[Beta\]^]
25+
** link:{{navprefix}}/theme-builder[Theme Builder ^Beta^]
2626
** link:{{navprefix}}/spotdev-portal[How to use]
2727
*** link:{{navprefix}}/dev-playground[Visual Embed Playground]
2828
*** link:{{navprefix}}/graphql-playground[GraphQL Playground]
@@ -74,7 +74,7 @@
7474
***** link:{{navprefix}}/css-variables-reference[CSS variables reference]
7575
***** link:{{navprefix}}/customize-icons[Customize icons]
7676
***** link:{{navprefix}}/customize-text[Customize text strings]
77-
**** link:{{navprefix}}/theme-builder-doc[Theme builder]
77+
**** link:{{navprefix}}/theme-builder-doc[Theme builder ^Beta^]
7878

7979
*** link:{{navprefix}}/filters-overview[Filters overview]
8080
**** link:{{navprefix}}/runtime-overrides[Runtime overrides]

modules/ROOT/pages/embed-action-ref.adoc

Lines changed: 74 additions & 53 deletions
Large diffs are not rendered by default.

modules/ROOT/pages/rest-apiv2-changelog.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,19 @@ This changelog lists the features and enhancements introduced in REST API v2.0.
1010

1111
== Version 10.6.0.cl, February 2025
1212

13-
=== Report APIs
14-
[tag redBackground]#BREAKING CHANGE# - The `POST /api/rest/2.0/report/answer` and `POST /api/rest/2.0/report/liveboard` no longer support downloading objects in CSV and XLS format. These endpoints support downloading data only in PDF and PNG formats.
15-
16-
1713
=== New metadata API endpoints
1814

1915
* `POST /api/rest/2.0/metadata/headers/update` +
2016
Updates metadata header for a given list of objects.
2117
* `POST /api/rest/2.0/metadata/worksheets/convert` +
2218
Converts a Worksheet object to a Model.
2319

24-
=== Regional settings in Report APIs
20+
=== Report APIs
21+
[tag redBackground]#BREAKING CHANGE#
22+
23+
The `POST /api/rest/2.0/report/answer` and `POST /api/rest/2.0/report/liveboard` no longer support downloading objects in CSV and XLS format. These endpoints support downloading data only in PDF and PNG formats.
24+
25+
==== Parameters for regional settings
2526

2627
The `/api/rest/2.0/report/answer` and `/api/rest/2.0/report/liveboard` now allow users to define the following `regional_settings` attributes:
2728

@@ -44,9 +45,9 @@ The following API endpoints allow you to specify a custom object ID (`obj_identi
4445

4546
=== TML import API
4647

47-
The `/api/rest/2.0/metadata/tml/async/import` API now allows skipping diff check when processing TMLs for imports. The `skip_diff_check` attribute is disabled by default.
48+
The `/api/rest/2.0/metadata/tml/async/import` and `POST /api/rest/2.0/metadata/tml/import` endpoints allow skipping diff check when processing TMLs for imports. The `skip_diff_check` attribute is disabled by default and can be enabled to avoid importing objects that do not have any changes.
4849

49-
=== API response and header changes
50+
=== API response changes
5051

5152
The 200 and 201 response body from `POST /api/rest/2.0/ai/answer/create` and `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` API calls now includes the `display_tokens` property.
5253

modules/ROOT/pages/theme-builder.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Theme builder [beta betaBackground]^Beta^
1+
= Theme builder
22
:toc: true
33
:toclevels: 2
44

modules/ROOT/pages/tml-api.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ __Optional__ a|__Boolean__. Specify if import operation must be run for all Orgs
7474
__Requires Org administration privileges to access TML objects across all Orgs.__ | `false`
7575
a|`skip_cdw_validation_for_tables` +
7676
__Optional__ |__Boolean__. Skips Cloud Data Warehouse validation for table TML imports. | `false`
77+
78+
|`skip_diff_check` +
79+
__Optional__
80+
a|__Boolean__. Skips diff check before processing TMLs for imports. +
81+
When set to `true`, this attribute enables diff check to identify the objects that haven’t been changed since the last import or TML update. This feature eliminates importing redundant objects and helps optimize the import process. |`false`
7782
|====
7883

7984
=== Example request

modules/ROOT/pages/tml.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ You can import single or multiple objects using the `tml/import` API. If you are
4747

4848
By default, the `fqn` parameter is not present in the TML file. However, you can export TML with FQNs and use it during the import.
4949

50-
To import TML representation of the metadata objects into ThoughtSpot, use one of the following API endpoints:
50+
You can also set the `skip_diff_check` to `true` to skip diff check before processing TMLs for imports. This attribute helps identify the objects that haven’t been changed since the last import or TML update, and eliminates importing redundant objects.
51+
52+
To import TML representation of the metadata objects into ThoughtSpot, use one of the following API endpoints:
5153

5254
* +++<a href="{{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fimport-metadata-tml">POST /api/rest/2.0/metadata/tml/import</a>+++ (REST API v2)
5355
* xref:tml-api.adoc#import[POST /tspublic/v1/metadata/tml/import] (REST API v1)
@@ -110,7 +112,8 @@ Imports objects that validate successfully and skips the objects that do not val
110112

111113
|`skip_diff_check` +
112114
__Optional__
113-
|__Boolean__. Skips diff check before processing TMLs for imports. |`false`
115+
|__Boolean__. Skips diff check before processing TMLs for imports. +
116+
When set to `true`, this attribute enables diff check to identify the objects that haven’t been changed since the last import or TML update. This feature eliminates importing redundant objects and helps optimize the import process. |`false`
114117
|`enable_large_metadata_validation` +
115118
__Optional__
116119
|__Boolean__. Available from 10.5.0.cl. Enables validation for large metadata objects. Set to `true` if the database contains multiple thousands of tables. When enabled, it allows for schema validation of one table at a time and helps circumvent the metadata fetching limitations of the Cloud Data Warehouse (CDW).
@@ -137,7 +140,6 @@ curl -X POST \
137140
],
138141
"create_new": true,
139142
"all_orgs_context": false,
140-
"skip_cdw_validation_for_tables": true
141143
}'
142144
----
143145

modules/ROOT/pages/whats-new.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Spotter is enabled on ThoughtSpot instances by default and is now generally avai
1818
This release also introduces several enhancements to Spotter embed:
1919

2020
* xref:embed-spotter.adoc#configControls[Configuration controls in the SDK] to disable or hide the data source, and show or hide sample questions
21-
* xref:embed-spotter.adoc#SpotterCSS[Customization controls for CSS overrides], xref:embed-spotter.adoc#spotterMenuActions[action IDs to disable, show or hide menu actions and elements]
22-
* Additional options in the xref:developer-playground.adoc#playground-spotter[Spotter Playground experience], which allow users to explore the customization settings available in the SDK..
21+
* xref:embed-spotter.adoc#SpotterCSS[Customization controls for CSS overrides], xref:embed-spotter.adoc#spotterMenuActions[action IDs] for menu customization on the Spotter page.
22+
* Additional options in the xref:developer-playground.adoc#playground-spotter[Spotter Playground experience], which allow users to explore the customization settings available for Spotter.
2323

2424
For more information, see xref:embed-spotter.adoc[Embed Spotter].
2525

@@ -45,7 +45,7 @@ When MFA is enabled on your ThoughtSpot instance, using basic authentication in
4545

4646
When MFA is enabled on a ThoughtSpot instance, local authentication users cannot log in with their `username` and `password` and are prompted to enable MFA when they try to log in via UI. Setting up MFA via APIs is not supported.
4747

48-
If you are using REST APIs with basic authentication, ThoughtSpot recommends updating your application environment to use username and `secret_key` to generate authentication token. To stay security compliant and avoid breaking changes, before activating MFA for your users, we recommend that you enable *Trusted Authentication* on your instance and set up your embed and REST API environments to use token-based authentication. For more information and assistance, contact ThoughtSpot Support.
48+
If you are using REST APIs with basic authentication, ThoughtSpot recommends updating your application environment to use `username` and `secret_key` to generate authentication token. To stay security compliant and avoid breaking changes, before activating MFA for your users, we recommend that you enable *Trusted Authentication* on your instance and set up your embed and REST API environments to use token-based authentication. For more information and assistance, contact ThoughtSpot Support.
4949

5050
=== Liveboard enhancements
5151

@@ -59,7 +59,7 @@ Compact Liveboard header is disabled by default. To enable this feature, set `is
5959

6060
By default, Liveboards display all filters and parameters, including those that are not applicable to the visualizations in a tab. On embedded Liveboards, developers can control the visibility of filters and Parameters for visualizations in a tab using the `hideirrelevantchipsinliveboardtabs` property in the SDK.
6161

62-
For more information about filters for Liveboard tabs, see link:https://docs.thoughtspot.com/cloud/10.6.0.cl/liveboard-filters#_apply_filters_to_specific_visualizations_or_tabs[Apply filters to specific visualizations or tabs].
62+
For more information about filters for Liveboard tabs, see link:https://docs.thoughtspot.com/cloud/latest/liveboard-filters#_apply_filters_to_specific_visualizations_or_tabs[Apply filters to specific visualizations or tabs].
6363

6464

6565
=== Worksheet to Model conversion

src/configs/doc-configs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ module.exports = {
3535
},
3636
VERSION_DROPDOWN: [
3737
{
38-
label: '10.5.0.cl',
38+
label: '10.6.0.cl',
3939
link: ' ',
4040
subLabel: 'Cloud (Latest)',
4141
},

static/doc-images/images/json.png

-6.55 KB
Loading
-6.91 KB
Loading

0 commit comments

Comments
 (0)