diff --git a/.gitignore b/.gitignore index ebc5fe3e2..7a0077586 100644 --- a/.gitignore +++ b/.gitignore @@ -113,4 +113,5 @@ docs/public/ modules/**/generated/ # PyCharm -.idea \ No newline at end of file +.idea +dev_docs.code-workspace diff --git a/gatsby-config.js b/gatsby-config.js index 999a98b62..49cb7dd31 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -72,7 +72,7 @@ class CustomDocConverter { } anchorMarkup = `href="${anchorMarkup}"`; if (attributes.window) { - anchorMarkup += ` target="${attributes.window}"`; + anchorMarkup += ` window="${attributes.window}"`; } return `${node.getText()}`; } diff --git a/modules/ROOT/pages/configure-oidc.adoc b/modules/ROOT/pages/authentication/configure-oidc.adoc similarity index 100% rename from modules/ROOT/pages/configure-oidc.adoc rename to modules/ROOT/pages/authentication/configure-oidc.adoc diff --git a/modules/ROOT/pages/configure-saml.adoc b/modules/ROOT/pages/authentication/configure-saml.adoc similarity index 100% rename from modules/ROOT/pages/configure-saml.adoc rename to modules/ROOT/pages/authentication/configure-saml.adoc diff --git a/modules/ROOT/pages/embed-authentication.adoc b/modules/ROOT/pages/authentication/embed-authentication.adoc similarity index 100% rename from modules/ROOT/pages/embed-authentication.adoc rename to modules/ROOT/pages/authentication/embed-authentication.adoc diff --git a/modules/ROOT/pages/just-in-time-provisioning.adoc b/modules/ROOT/pages/authentication/just-in-time-provisioning.adoc similarity index 100% rename from modules/ROOT/pages/just-in-time-provisioning.adoc rename to modules/ROOT/pages/authentication/just-in-time-provisioning.adoc diff --git a/modules/ROOT/pages/trusted-auth-sdk.adoc b/modules/ROOT/pages/authentication/trusted-auth-sdk.adoc similarity index 99% rename from modules/ROOT/pages/trusted-auth-sdk.adoc rename to modules/ROOT/pages/authentication/trusted-auth-sdk.adoc index 379ccbbcb..30acd5a35 100644 --- a/modules/ROOT/pages/trusted-auth-sdk.adoc +++ b/modules/ROOT/pages/authentication/trusted-auth-sdk.adoc @@ -85,7 +85,7 @@ When used as a bearer token, the lifespan of the token is established when it is The `init()` function can automatically request a new token when it detects either the session or the token has expired if the `autoLogin: true` option is set. You may also set `disableLoginRedirect: true` to customize the behavior when `autoLogin` is in place. See the xref:getting-started.adoc#_configure_security_and_login_parameters_optional[init() function documentation] for a full description of the available customizations. === REST API requests -The Visual Embed SDK provides a link:https://developers.thoughtspot.com/docs/Function_tokenizedFetch[tokenizedFetch, target=_blank] function to use in place of the standard browser `fetch()` function, which will provide the current bearer token when using cookieless trusted authentication. +The Visual Embed SDK provides a link:https://developers.thoughtspot.com/docs/Function_tokenizedFetch[tokenizedFetch, window=_blank] function to use in place of the standard browser `fetch()` function, which will provide the current bearer token when using cookieless trusted authentication. Please see the documentation on xref:rest-apiv2-js.adoc[REST API V2.0 within a browser] for further explanation and example code. diff --git a/modules/ROOT/pages/trusted-auth-secret-key.adoc b/modules/ROOT/pages/authentication/trusted-auth-secret-key.adoc similarity index 100% rename from modules/ROOT/pages/trusted-auth-secret-key.adoc rename to modules/ROOT/pages/authentication/trusted-auth-secret-key.adoc diff --git a/modules/ROOT/pages/trusted-auth-token-request-service.adoc b/modules/ROOT/pages/authentication/trusted-auth-token-request-service.adoc similarity index 100% rename from modules/ROOT/pages/trusted-auth-token-request-service.adoc rename to modules/ROOT/pages/authentication/trusted-auth-token-request-service.adoc diff --git a/modules/ROOT/pages/trusted-auth-troubleshoot.adoc b/modules/ROOT/pages/authentication/trusted-auth-troubleshoot.adoc similarity index 100% rename from modules/ROOT/pages/trusted-auth-troubleshoot.adoc rename to modules/ROOT/pages/authentication/trusted-auth-troubleshoot.adoc diff --git a/modules/ROOT/pages/trusted-authentication.adoc b/modules/ROOT/pages/authentication/trusted-authentication.adoc similarity index 100% rename from modules/ROOT/pages/trusted-authentication.adoc rename to modules/ROOT/pages/authentication/trusted-authentication.adoc diff --git a/modules/ROOT/pages/abac-user-parameters.adoc b/modules/ROOT/pages/authorization/abac-user-parameters.adoc similarity index 97% rename from modules/ROOT/pages/abac-user-parameters.adoc rename to modules/ROOT/pages/authorization/abac-user-parameters.adoc index 6498b9787..7b3ac0ee9 100644 --- a/modules/ROOT/pages/abac-user-parameters.adoc +++ b/modules/ROOT/pages/authorization/abac-user-parameters.adoc @@ -14,7 +14,7 @@ Attribute-Based Access Control (ABAC) is a pattern where security entitlements a RLS using ABAC via tokens is in BETA. As this feature directly impacts data security in your environment, ThoughtSpot does not support its use in a Production environment until it becomes Generally Available. ThoughtSpot is working on improvements in the upcoming releases that will change some of the best practices recommended in this article and result in the needed re-work of your deployment's security architecture. To understand the RLS best practices for your use case and deployment timelines, and to get these features enabled on your ThoughtSpot instances, contact ThoughtSpot Support. ==== -Currently, the ABAC via tokens method requires using *link:https://docs.thoughtspot.com/cloud/latest/worksheet-create[Worksheets, target=_blank]* as data sources for Liveboards and Answers, rather than individual table objects. +Currently, the ABAC via tokens method requires using *link:https://docs.thoughtspot.com/cloud/latest/worksheet-create[Worksheets, window=_blank]* as data sources for Liveboards and Answers, rather than individual table objects. == Overview @@ -38,7 +38,7 @@ For the same reasons, end users of an embedded app cannot have *edit* access to The request for a token with ABAC details can *xref:abac-user-parameters.adoc#persistForUser[persist]* the set of filters and parameter values to the user's `user_parameters` property, after which all sessions and scheduled reports will use the persisted values. == Token request -The ABAC message to ThoughtSpot is encoded in JSON Web Token (JWT) format, using the existing ThoughtSpot link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token[V2.0 REST API Access Tokens, target=_blank], which are OAuth JWT tokens. +The ABAC message to ThoughtSpot is encoded in JSON Web Token (JWT) format, using the existing ThoughtSpot link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token[V2.0 REST API Access Tokens, window=_blank], which are OAuth JWT tokens. The token can be used as a bearer token for Cookieless Trusted Auth or REST API access, or as a sign-in token to create a ThoughtSpot session, in which case the ABAC user parameters should be *persisted*. @@ -48,7 +48,7 @@ ThoughtSpot compresses the size of JWT token by default to ensure that larger pa ==== === Request format -The ABAC request is sent using the `user_parameters` key of the link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token[V2.0 Full Access Token request, target=_blank]. +The ABAC request is sent using the `user_parameters` key of the link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token[V2.0 Full Access Token request, window=_blank]. There are three potential keys within `user_parameters`, each taking an array of objects: [code,javascript] @@ -65,7 +65,7 @@ The format for the objects in each section follows the equivalent formats in the There is a `xref:abac-user-parameters.adoc#persistForUser[persist]` key to be added on each object that takes a boolean `true` or `false`. This determines if the values are persisted at the user level beyond just the token itself, for features such as alerts and subscriptions that run outside a user's session. -The following is a `user_parameters` section that would be part of the JSON request of the link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token[V2.0 Full Access Token request, target=_blank]: +The following is a `user_parameters` section that would be part of the JSON request of the link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token[V2.0 Full Access Token request, window=_blank]: [source,JavaScript] ---- @@ -310,15 +310,15 @@ If the parameter is named `Secured` and the *shared secret* value is `rxzricmwfe === Use Parameters to filter a Worksheet The basic pattern for using a Parameter to filter a Worksheet includes these steps: -. Create link:https://docs.thoughtspot.com/cloud/latest/parameters-create[Parameters, target=_blank] in Worksheet -. Make link:https://docs.thoughtspot.com/cloud/latest/formulas[formula, target=_blank] that evaluates the Parameter's default value and the expected values from the token -. Make link:https://docs.thoughtspot.com/cloud/latest/filters#_worksheet_filters[Worksheet filter, target=_blank] based on the formula, set to *true*. +. Create link:https://docs.thoughtspot.com/cloud/latest/parameters-create[Parameters, window=_blank] in Worksheet +. Make link:https://docs.thoughtspot.com/cloud/latest/formulas[formula, window=_blank] that evaluates the Parameter's default value and the expected values from the token +. Make link:https://docs.thoughtspot.com/cloud/latest/filters#_worksheet_filters[Worksheet filter, window=_blank] based on the formula, set to *true*. -link:https://docs.thoughtspot.com/cloud/latest/parameters-create[Parameters, target=_blank] are defined at the Worksheet level within ThoughtSpot. Parameters have a data type and a default value set by the Worksheet author. +link:https://docs.thoughtspot.com/cloud/latest/parameters-create[Parameters, window=_blank] are defined at the Worksheet level within ThoughtSpot. Parameters have a data type and a default value set by the Worksheet author. -To use a Parameter, you'll make a link:https://docs.thoughtspot.com/cloud/latest/formulas[formula, target=_blank] on the Worksheet. +To use a Parameter, you'll make a link:https://docs.thoughtspot.com/cloud/latest/formulas[formula, window=_blank] on the Worksheet. -link:https://docs.thoughtspot.com/cloud/latest/filters#_worksheet_filters[Worksheet filters, target=_blank] can reference Worksheet formulas once they have been created, which creates the security layer out of the result of the formula. +link:https://docs.thoughtspot.com/cloud/latest/filters#_worksheet_filters[Worksheet filters, window=_blank] can reference Worksheet formulas once they have been created, which creates the security layer out of the result of the formula. All of these Worksheet-level features are set by clicking *Edit* on the Worksheet, then expanding the menu on the left sidebar: @@ -371,7 +371,7 @@ Parameters can be used in a formula to directly match a value in a column, or an `if ( parameter_name = field_name ) then true else false` ===== Use Parameters with pass-through functions -link:https://docs.thoughtspot.com/cloud/latest/formula-reference#passthrough-functions[ThoughtSpot SQL Pass-through functions, target=_blank] allow you to send arbitrary SQL to the data source, while passing in values to substitute from ThoughtSpot. +link:https://docs.thoughtspot.com/cloud/latest/formula-reference#passthrough-functions[ThoughtSpot SQL Pass-through functions, window=_blank] allow you to send arbitrary SQL to the data source, while passing in values to substitute from ThoughtSpot. The basic form of the SQL Pass-through function is: diff --git a/modules/ROOT/pages/access-control-sharing.adoc b/modules/ROOT/pages/authorization/access-control-sharing.adoc similarity index 94% rename from modules/ROOT/pages/access-control-sharing.adoc rename to modules/ROOT/pages/authorization/access-control-sharing.adoc index 50723154b..5a1c7154a 100644 --- a/modules/ROOT/pages/access-control-sharing.adoc +++ b/modules/ROOT/pages/authorization/access-control-sharing.adoc @@ -49,11 +49,11 @@ A user with *administrator* privileges can share any content to any user or grou image::./images/shareability_can_share_to.png[Shareability and group membership controls visibility] == Sharing via UI -Within the ThoughtSpot UI, there are buttons or menu items to trigger the sharing workflow for every type of object (link:https://docs.thoughtspot.com/cloud/latest/share-liveboards#share-liveboardpage[Liveboards, target=_blank] or link:https://docs.thoughtspot.com/cloud/latest/share-worksheets[worksheets, target=_blank] for example). +Within the ThoughtSpot UI, there are buttons or menu items to trigger the sharing workflow for every type of object (link:https://docs.thoughtspot.com/cloud/latest/share-liveboards#share-liveboardpage[Liveboards, window=_blank] or link:https://docs.thoughtspot.com/cloud/latest/share-worksheets[worksheets, window=_blank] for example). == Sharing via REST API -The REST API v2 link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/share endpoint, target=_blank] is used to programmatically share content, or to remove any access. +The REST API v2 link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/share endpoint, window=_blank] is used to programmatically share content, or to remove any access. The API request has two components, `metadata_identifiers` and `permissions`: @@ -104,17 +104,17 @@ Requests to the `/fetch-permissions` endpoints will never return any user or gro == Auditing access control Sharing details are not returned via the responses from the `/metadata/search` endpoints. Instead, there are two REST API endpoints under the */security/* for retrieving access control details. -Using the link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/fetch-permissions, target=_blank] endpoint on an object will return the *effective permissions* for all groups and the users within those groups who have access to the object. +Using the link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/fetch-permissions, window=_blank] endpoint on an object will return the *effective permissions* for all groups and the users within those groups who have access to the object. Effective permissions for an object are the full set of groups and users who have access, and what that access level is. -The link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/principals/fetch-permissions endpoint, target=_blank] is used to get the *effective permissions* for a specific user or group. +The link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/principals/fetch-permissions endpoint, window=_blank] is used to get the *effective permissions* for a specific user or group. Effective permissions for a user are based on things shared to them individually and their group membership. Group effective permissions should be close to their __defined permissions__ but hierarchical groups are a feature in ThoughtSpot that would lead to more complex scenarios (hierarchical groups are discouraged when doing embedded ThoughtSpot integrations). == Re-assign content author -The *author* of any object can be re-assigned using the V2.0 link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/assign, target=_blank] REST API endpoint: +The *author* of any object can be re-assigned using the V2.0 link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/assign, window=_blank] REST API endpoint: [source,JSON] ---- diff --git a/modules/ROOT/pages/data-security.adoc b/modules/ROOT/pages/authorization/data-security.adoc similarity index 96% rename from modules/ROOT/pages/data-security.adoc rename to modules/ROOT/pages/authorization/data-security.adoc index 99e98c112..0c34c732e 100644 --- a/modules/ROOT/pages/data-security.adoc +++ b/modules/ROOT/pages/authorization/data-security.adoc @@ -17,7 +17,7 @@ ThoughtSpot has three mechanisms for row-level security: * xref:rls-rules.adoc[RLS Rules, window=_blank] applied to the ThoughtSpot table objects * xref:abac-user-parameters.adoc[Attribute-Based Access Control (ABAC)] filters and parameters passed in via login token -* link:https://docs.thoughtspot.com/cloud/latest/connections-snowflake-oauth[OAuth connections, _target=blank]: Individualized login to the data warehouse connection using OAuth, where security rules have already been implemented for each user. +* link:https://docs.thoughtspot.com/cloud/latest/connections-snowflake-oauth[OAuth connections, _window=blank]: Individualized login to the data warehouse connection using OAuth, where security rules have already been implemented for each user. The OAuth workflow requires opening a new window or redirecting to the OAuth provider for the initial sign-in workflow, making it less seamless than using a service account and defining data security via ThoughtSpot. It tends to be used for non-embedded ThoughtSpot use cases or for embedded applications for an organization's internal users with existing individual data warehouse user accounts. diff --git a/modules/ROOT/pages/privileges-and-roles.adoc b/modules/ROOT/pages/authorization/privileges-and-roles.adoc similarity index 100% rename from modules/ROOT/pages/privileges-and-roles.adoc rename to modules/ROOT/pages/authorization/privileges-and-roles.adoc diff --git a/modules/ROOT/pages/rls-rules.adoc b/modules/ROOT/pages/authorization/rls-rules.adoc similarity index 98% rename from modules/ROOT/pages/rls-rules.adoc rename to modules/ROOT/pages/authorization/rls-rules.adoc index 20a2f92d0..f51de2fef 100644 --- a/modules/ROOT/pages/rls-rules.adoc +++ b/modules/ROOT/pages/authorization/rls-rules.adoc @@ -13,7 +13,7 @@ The two basic patterns for RLS Rules are *direct RLS rules* that reference a col If neither of these patterns is easily implemented, please consider the xref:abac-user-parameters.adoc[ABAC via tokens] method of RLS, available starting in ThoughtSpot 9.11. == RLS rules overview -*RLS rules* are link:https://docs.thoughtspot.com/cloud/latest/security-rls-implement[defined within ThoughtSpot, target=_blank] on table objects, and automatically extend to all worksheets, saved answers, and Liveboards based on that table, every time. +*RLS rules* are link:https://docs.thoughtspot.com/cloud/latest/security-rls-implement[defined within ThoughtSpot, window=_blank] on table objects, and automatically extend to all worksheets, saved answers, and Liveboards based on that table, every time. RLS rules are defined using either the *ts_username* variable or *ts_groups* variable. The RLS rules translate into WHERE clauses in any SQL query generated from that table object, with the variables expanding into the details of the signed-in user. *ts_groups* turns into the set of *group name* properties of the ThoughtSpot groups the user belongs to. @@ -152,7 +152,7 @@ The ACL table pattern introduces an additional table, the Access Control List (A |region_4 |=== -Within ThoughtSpot, you will establish link:https://docs.thoughtspot.com/cloud/latest/tables-join#_create_a_table_join[INNER JOINs, target=_blank] between each of the columns of the ACL table and the fact or dimension table that needs to be filtered. +Within ThoughtSpot, you will establish link:https://docs.thoughtspot.com/cloud/latest/tables-join#_create_a_table_join[INNER JOINs, window=_blank] between each of the columns of the ACL table and the fact or dimension table that needs to be filtered. With the JOINs set up properly, you place the RLS Rule not on the ACL table, but on the fact and dimension tables. You will be able to reference the fields within either table. diff --git a/modules/ROOT/pages/common/nav.adoc b/modules/ROOT/pages/common/nav.adoc index daa5c37d0..85be62d3d 100644 --- a/modules/ROOT/pages/common/nav.adoc +++ b/modules/ROOT/pages/common/nav.adoc @@ -18,10 +18,10 @@ ** link:{{navprefix}}/deprecated-features[Deprecation announcements] * Live Playgrounds -** +++Visual Embed Playground+++ +** +++Visual Embed Playground+++ ** link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground] ** link:{{navprefix}}/graphql-play-ground[GraphQL Playground] -** +++REST API v1 Playground+++ +** +++REST API v1 Playground+++ ** link:{{navprefix}}/spotdev-portal[How to use] *** link:{{navprefix}}/dev-playground[Visual Embed Playground] *** link:{{navprefix}}/graphql-playground[GraphQL Playground] diff --git a/modules/ROOT/pages/css-customization.adoc b/modules/ROOT/pages/css-customization.adoc index 07efc16da..a7df75db0 100644 --- a/modules/ROOT/pages/css-customization.adoc +++ b/modules/ROOT/pages/css-customization.adoc @@ -253,7 +253,7 @@ customizations: { . Click **Run**. ++++ -Try it out +Try it out ++++ == Additional resources @@ -303,7 +303,7 @@ customizations: { . Click `Run`. ++++ -Try it out +Try it out ++++ == Customization steps diff --git a/modules/ROOT/pages/custom-actions-callback.adoc b/modules/ROOT/pages/custom-actions-callback.adoc index 1d11ed825..b38b07804 100644 --- a/modules/ROOT/pages/custom-actions-callback.adoc +++ b/modules/ROOT/pages/custom-actions-callback.adoc @@ -357,4 +357,4 @@ Custom actions appear as disabled on unsaved charts and tables. If you have gene //// * link:https://github.com/thoughtspot/ts_everywhere_resources/tree/master/example_actions/download_csv[Custom action examples, window=_blank] -//// \ No newline at end of file +//// diff --git a/modules/ROOT/pages/custom-actions-edit.adoc b/modules/ROOT/pages/custom-actions/custom-actions-edit.adoc similarity index 100% rename from modules/ROOT/pages/custom-actions-edit.adoc rename to modules/ROOT/pages/custom-actions/custom-actions-edit.adoc diff --git a/modules/ROOT/pages/custom-actions-viz.adoc b/modules/ROOT/pages/custom-actions/custom-actions-viz.adoc similarity index 99% rename from modules/ROOT/pages/custom-actions-viz.adoc rename to modules/ROOT/pages/custom-actions/custom-actions-viz.adoc index 621827f97..5cf4a1e7f 100644 --- a/modules/ROOT/pages/custom-actions-viz.adoc +++ b/modules/ROOT/pages/custom-actions/custom-actions-viz.adoc @@ -103,4 +103,4 @@ To delete a custom action association: . Click the *Custom actions* icon image:./images/custom-action-icon.png[the Custom actions menu]. . In the **Custom actions **panel, click the delete icon next to that action that you want to remove. -For information about deleting a custom action assigned at the Worksheet level, see xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet]. \ No newline at end of file +For information about deleting a custom action assigned at the Worksheet level, see xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet]. diff --git a/modules/ROOT/pages/custom-actions-worksheet.adoc b/modules/ROOT/pages/custom-actions/custom-actions-worksheet.adoc similarity index 100% rename from modules/ROOT/pages/custom-actions-worksheet.adoc rename to modules/ROOT/pages/custom-actions/custom-actions-worksheet.adoc diff --git a/modules/ROOT/pages/custom-actions.adoc b/modules/ROOT/pages/custom-actions/custom-actions.adoc similarity index 100% rename from modules/ROOT/pages/custom-actions.adoc rename to modules/ROOT/pages/custom-actions/custom-actions.adoc diff --git a/modules/ROOT/pages/customize-text-strings.adoc b/modules/ROOT/pages/customize-text-strings.adoc index bfe1a9dce..9d90aece6 100644 --- a/modules/ROOT/pages/customize-text-strings.adoc +++ b/modules/ROOT/pages/customize-text-strings.adoc @@ -29,7 +29,7 @@ init({ }); ---- -+++ Try it out +++ in the Visual Embed Playground to preview the customization. ++++ Try it out +++ in the Visual Embed Playground to preview the customization. == Limitations Note the following limitations: + diff --git a/modules/ROOT/pages/deploy-with-tml-apis.adoc b/modules/ROOT/pages/deployment-and-integration/deploy-with-tml-apis.adoc similarity index 100% rename from modules/ROOT/pages/deploy-with-tml-apis.adoc rename to modules/ROOT/pages/deployment-and-integration/deploy-with-tml-apis.adoc diff --git a/modules/ROOT/pages/development-and-deployment.adoc b/modules/ROOT/pages/deployment-and-integration/development-and-deployment.adoc similarity index 97% rename from modules/ROOT/pages/development-and-deployment.adoc rename to modules/ROOT/pages/deployment-and-integration/development-and-deployment.adoc index bade01633..beb9d89c5 100644 --- a/modules/ROOT/pages/development-and-deployment.adoc +++ b/modules/ROOT/pages/deployment-and-integration/development-and-deployment.adoc @@ -15,7 +15,7 @@ ThoughtSpot provides numerous tools for building a structured deployment process == Best practices The primary tool for structured development and deployment in ThoughtSpot is called xref:orgs.adoc[Orgs] -Each Org in ThoughtSpot can be xref:version_control.adoc[paired] to a link:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches[branch, target=_blank] in a link:https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories[Git repository, target=_blank] as a single *environment*. +Each Org in ThoughtSpot can be xref:version_control.adoc[paired] to a link:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches[branch, window=_blank] in a link:https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories[Git repository, window=_blank] as a single *environment*. xref:orgs.adoc[Orgs] are fully separated tenants on a single ThoughtSpot instance. For TSE customers and others who need a structured development and deployment process, Orgs should always be enabled. diff --git a/modules/ROOT/pages/git-configuration.adoc b/modules/ROOT/pages/deployment-and-integration/git-configuration.adoc similarity index 100% rename from modules/ROOT/pages/git-configuration.adoc rename to modules/ROOT/pages/deployment-and-integration/git-configuration.adoc diff --git a/modules/ROOT/pages/git-rest-api-guide.adoc b/modules/ROOT/pages/deployment-and-integration/git-rest-api-guide.adoc similarity index 95% rename from modules/ROOT/pages/git-rest-api-guide.adoc rename to modules/ROOT/pages/deployment-and-integration/git-rest-api-guide.adoc index 540971059..11e56b106 100644 --- a/modules/ROOT/pages/git-rest-api-guide.adoc +++ b/modules/ROOT/pages/deployment-and-integration/git-rest-api-guide.adoc @@ -16,7 +16,7 @@ The xref:version_control.adoc#moving-tml-changes-between-environments[basic proc The following sections describe how to use the version control REST APIs after completing xref:git-configuration.adoc[Git configuration] for a ThoughtSpot instance. -There is a complete implementation of all Git REST APIs available in the link:https://thoughtspot.github.io/cs_tools/tools/git/[CS Tools package, target=_blank] as well as link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/[example workflow scripts available in Python, target=_blank]. +There is a complete implementation of all Git REST APIs available in the link:https://thoughtspot.github.io/cs_tools/tools/git/[CS Tools package, window=_blank] as well as link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/[example workflow scripts available in Python, window=_blank]. == Commit files The `/api/rest/2.0/vcs/git/branches/commit` API call exports the TML files for the requested ThoughtSpot objects directly to a Git branch and commits the changes. @@ -94,7 +94,7 @@ You must specify the *branch_name* of the commits to deploy from. In the xref:de In a xref:single-tenant-data-models.adoc[single-tenanted deployment pattern], you might instead deploy to each end-customer Org from the "release" / "pre-prod" branch rather than deploy from the branch of the Org's environment. If you have any additional processes to run on the TML files prior to final deployment, it is preferable to merge changes to the environment branch and then deploy commits from the environment branch. -The API will deploy the link:https://training.github.com/downloads/github-git-cheat-sheet/[head of the specified Git branch, target=_blank] unless a `commit_id` is specified in the API request. If your team uses link:https://git-scm.com/book/en/v2/Git-Basics-Tagging[tags, target=_blank] or link:https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases[releases, target=_blank], supply the `commit_id` from Git associated with the release or tag. +The API will deploy the link:https://training.github.com/downloads/github-git-cheat-sheet/[head of the specified Git branch, window=_blank] unless a `commit_id` is specified in the API request. If your team uses link:https://git-scm.com/book/en/v2/Git-Basics-Tagging[tags, window=_blank] or link:https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases[releases, window=_blank], supply the `commit_id` from Git associated with the release or tag. Because each Org in ThoughtSpot has distinct objects with their own GUIDs, the import process for objects originating from a different environment requires swapping in the correct GUIDs. @@ -102,7 +102,7 @@ If you have enabled xref:guid-mapping.adoc[GUID mapping] in the Git configuratio See the xref:guid-mapping.adoc[GUID mapping] documentation to understand how it works and the additional capabilities for handling other substitutions that may be necessary during deploying commits to the destination environment. -The link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/git_deploy_commits_to_prod_single_tenants.py[example script in Python, target=_blank] shows the pattern of deploying to "prod org per customer" from a single `pre_prod/release` branch, to avoid the need for pull requests into each branch linked to an end customer Org. +The link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/git_deploy_commits_to_prod_single_tenants.py[example script in Python, window=_blank] shows the pattern of deploying to "prod org per customer" from a single `pre_prod/release` branch, to avoid the need for pull requests into each branch linked to an end customer Org. [NOTE] ==== @@ -119,7 +119,7 @@ Make sure the *guid mapping file* is referenced when creating the final TML file |===== |Parameter|Description |`commit_id` + -__Optional__|__String__. ID of the commit to deploy on the cluster. By default, the command will deploy the head of the branch. To deploy a specific version, specify the `commit_id`. If your team uses link:https://git-scm.com/book/en/v2/Git-Basics-Tagging[tags, target=_blank] or link:https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases[releases, target=_blank], supply the `commit_id` from Git associated with the release or tag. +__Optional__|__String__. ID of the commit to deploy on the cluster. By default, the command will deploy the head of the branch. To deploy a specific version, specify the `commit_id`. If your team uses link:https://git-scm.com/book/en/v2/Git-Basics-Tagging[tags, window=_blank] or link:https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases[releases, window=_blank], supply the `commit_id` from Git associated with the release or tag. |`branch_name` |__String__. Name of the branch from which the commit must be picked for deployment. |`deploy_type` a| __String__. Specify one of the following options: + diff --git a/modules/ROOT/pages/guid-mapping.adoc b/modules/ROOT/pages/deployment-and-integration/guid-mapping.adoc similarity index 98% rename from modules/ROOT/pages/guid-mapping.adoc rename to modules/ROOT/pages/deployment-and-integration/guid-mapping.adoc index 4b1dc362d..d603519b8 100644 --- a/modules/ROOT/pages/guid-mapping.adoc +++ b/modules/ROOT/pages/deployment-and-integration/guid-mapping.adoc @@ -109,7 +109,7 @@ The link:https://docs.thoughtspot.com/cloud/latest/connections[Connection, windo Connections can be defined programmatically via link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fcreate-connection[REST API] or using link:https://docs.thoughtspot.com/cloud/latest/tml-connections[TML for connections, window=_blank] in the ThoughtSpot UI or via APIs. -Creating a connection involves secure credentials, which are not exported in the Connection TML. For this reason, it is preferable to set it via UI or REST API. An example of creating connections via REST API across multiple Orgs is available at the link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/create_connection_on_orgs.py[thoughtspot_rest_api_v1_python GitHub repository, target=_blank]. +Creating a connection involves secure credentials, which are not exported in the Connection TML. For this reason, it is preferable to set it via UI or REST API. An example of creating connections via REST API across multiple Orgs is available at the link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/create_connection_on_orgs.py[thoughtspot_rest_api_v1_python GitHub repository, window=_blank]. == Switching "dev" Orgs When the Orgs feature is enabled on an instance for the first time, all existing content will be available in the *Primary* Org, with `org_id` as `0`. @@ -128,7 +128,7 @@ The structure of the GUID Mapping file is entirely simple key-value mappings in You can modify the files in the `config_branch` manually for additions or corrections, but you must make sure the data is in the correct format and matches what ThoughtSpot generates. -An example of this process in Python is available as link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/git_guid_mapping_file_functions.py[git_guid_mapping_file_functions.py, target=_blank]. +An example of this process in Python is available as link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/git_guid_mapping_file_functions.py[git_guid_mapping_file_functions.py, window=_blank]. Take the swapped JSON and save it in `org-0.json` file within the `{instanceId}.mapping` directory of the `config_branch` in GitHub, or whichever `org-{orgId}.json` file matches to your `prod` Org. diff --git a/modules/ROOT/pages/intro-thoughtspot-objects.adoc b/modules/ROOT/pages/deployment-and-integration/intro-thoughtspot-objects.adoc similarity index 100% rename from modules/ROOT/pages/intro-thoughtspot-objects.adoc rename to modules/ROOT/pages/deployment-and-integration/intro-thoughtspot-objects.adoc diff --git a/modules/ROOT/pages/modify-tml.adoc b/modules/ROOT/pages/deployment-and-integration/modify-tml.adoc similarity index 100% rename from modules/ROOT/pages/modify-tml.adoc rename to modules/ROOT/pages/deployment-and-integration/modify-tml.adoc diff --git a/modules/ROOT/pages/multi-tenancy-best-practices.adoc b/modules/ROOT/pages/deployment-and-integration/multi-tenancy-best-practices.adoc similarity index 100% rename from modules/ROOT/pages/multi-tenancy-best-practices.adoc rename to modules/ROOT/pages/deployment-and-integration/multi-tenancy-best-practices.adoc diff --git a/modules/ROOT/pages/multi-tenancy-intro.adoc b/modules/ROOT/pages/deployment-and-integration/multi-tenancy-intro.adoc similarity index 100% rename from modules/ROOT/pages/multi-tenancy-intro.adoc rename to modules/ROOT/pages/deployment-and-integration/multi-tenancy-intro.adoc diff --git a/modules/ROOT/pages/orgs.adoc b/modules/ROOT/pages/deployment-and-integration/orgs.adoc similarity index 100% rename from modules/ROOT/pages/orgs.adoc rename to modules/ROOT/pages/deployment-and-integration/orgs.adoc diff --git a/modules/ROOT/pages/single-tenant-data-models.adoc b/modules/ROOT/pages/deployment-and-integration/single-tenant-data-models.adoc similarity index 100% rename from modules/ROOT/pages/single-tenant-data-models.adoc rename to modules/ROOT/pages/deployment-and-integration/single-tenant-data-models.adoc diff --git a/modules/ROOT/pages/vercel-int.adoc b/modules/ROOT/pages/deployment-and-integration/vercel-int.adoc similarity index 100% rename from modules/ROOT/pages/vercel-int.adoc rename to modules/ROOT/pages/deployment-and-integration/vercel-int.adoc diff --git a/modules/ROOT/pages/version_control.adoc b/modules/ROOT/pages/deployment-and-integration/version_control.adoc similarity index 100% rename from modules/ROOT/pages/version_control.adoc rename to modules/ROOT/pages/deployment-and-integration/version_control.adoc diff --git a/modules/ROOT/pages/developer-playground.adoc b/modules/ROOT/pages/developer-playground.adoc index 82c952085..64976de92 100644 --- a/modules/ROOT/pages/developer-playground.adoc +++ b/modules/ROOT/pages/developer-playground.adoc @@ -29,7 +29,7 @@ To explore the Search embed function: a|**Collapse data panel** + Minimizes the data panel on the left navigation bar. ++++ -Try it out +Try it out ++++ a|**Hide data panel** + @@ -37,7 +37,7 @@ a|**Hide data panel** + Hides the default data panel. You can use this function to create a custom data panel when embedding the search module in your application. ++++ -Try it out +Try it out ++++ a|**Hide chart or table** @@ -45,7 +45,7 @@ a|**Hide chart or table** Hides the charts and tables that appear beneath the search bar by default. For example, if you want to create a custom visualization using raw data from an existing Answer, you can enable this checkbox. ++++ -Try it out +Try it out ++++ a|**Modify available actions** + @@ -53,7 +53,7 @@ a|**Modify available actions** + include::{path}/modify-available-actions.adoc[] ++++ -Try it out +Try it out ++++ a|**Enable Search Assist** @@ -61,7 +61,7 @@ a|**Enable Search Assist** Enables the Search Assist feature that provides a custom onboarding experience for users searching data on an embedded instance. With Search Assist, data engineers and Worksheet owners can create a set of questions to assist users with the search. ++++ -Try it out +Try it out ++++ a|**Set runtime filters** @@ -81,7 +81,7 @@ runtimeFilters: [{ ---- ++++ -Try it out +Try it out ++++ a|**Add search tokens** + @@ -100,7 +100,7 @@ searchOptions: { ---- ++++ -Try it out +Try it out ++++ a|*Handle custom actions* @@ -108,14 +108,14 @@ a|*Handle custom actions* Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. ++++ -Try it out +Try it out ++++ a|Use Host Event Allows registering a host event. The registered event triggers an action in the embedded on clicking **Try Event**. ++++ -Try it out +Try it out ++++ a|**Apply custom styles** @@ -123,7 +123,7 @@ Shows the code for interface customization. You can define custom styles and def For more information about CSS variables, styles, and customizations options, see xref:css-customization.adoc[Customize CSS]. ++++ -Try it out +Try it out ++++ | |==== @@ -135,7 +135,7 @@ To explore the Search embed function: . Go to *Playground* > *Natural Language Search*. . Select a Worksheet. -. +++Try out+++ the following customization settings and click *Run* to preview the result. +. +++Try out+++ the following customization settings and click *Run* to preview the result. + [width="100%"] @@ -215,7 +215,7 @@ runtimeFilters: [{ ---- ++++ -Try it out +Try it out ++++ For more information, see xref:runtime-filters.adoc[Runtime filters]. @@ -225,14 +225,14 @@ a|**Handle custom actions** Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. ++++ -Try it out +Try it out ++++ a|Use Host Event Allows registering a host event. The registered event triggers an action in the embedded on clicking **Try Event**. ++++ -Try it out +Try it out ++++ a|**Apply custom styles** @@ -240,7 +240,7 @@ Shows the code for interface customization. You can define custom styles and def For more information about CSS variables, styles, and customizations options, see xref:css-customization.adoc[Customize CSS]. ++++ -Try it out +Try it out ++++ | |==== @@ -263,7 +263,7 @@ Dynamically resizes the embedded Liveboard frame according to the height of the If the embedded Liveboard does not fit vertically within your application page, a second scroll bar may appear. When **Full Height** is selected, the embedded Liveboard container is automatically adjusted according to the height of the Liveboard. ++++ -Try it out +Try it out ++++ a|**Modify available actions ** @@ -287,7 +287,7 @@ runtimeFilters: [{ ---- ++++ -Try it out +Try it out ++++ For more information, see xref:runtime-filters.adoc[Runtime filters]. @@ -297,14 +297,14 @@ a|*Handle custom actions* Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. ++++ -Try it out +Try it out ++++ a|**Use Host Event** Allows registering a host event. The registered event triggers an action in the embedded on clicking **Try Event**. ++++ -Try it out +Try it out ++++ a|**Apply custom styles** @@ -313,7 +313,7 @@ Shows the code for interface customization. You can define custom styles and def For more information about CSS variables, styles, and customizations options, see xref:css-customization.adoc[Customize CSS]. ++++ -Try it out +Try it out ++++ |==== @@ -335,7 +335,7 @@ a|*Show navigation bar* Displays the ThoughtSpot top navigation bar. By default, the navigation bar is hidden. ++++ -Try it out +Try it out ++++ a|**Hide profile and help** + @@ -343,7 +343,7 @@ a|**Hide profile and help** + Hides the user profile and help icons in the top navigation bar. ++++ -Try it out +Try it out ++++ a|**Navigate to URL** @@ -374,7 +374,7 @@ runtimeFilters: [{ ---- ++++ -Try it out +Try it out ++++ For more information, see xref:runtime-filters.adoc[Runtime filters]. @@ -384,14 +384,14 @@ a|**Handle custom actions** Allows you to view the code for a custom action event. If the embedded instance has a custom action, use this checkbox to view the event generated by the custom action and send ThoughtSpot data as a payload. ++++ -Try it out +Try it out ++++ a|**Use Host Event** Allows registering a host event. The registered event triggers an action in the embedded on clicking **Try Event**. ++++ -Try it out +Try it out ++++ a|**Apply custom styles** @@ -400,7 +400,7 @@ Shows the code for interface customization. You can define custom styles and def For more information about CSS variables, styles, and customizations options, see xref:css-customization.adoc[Customize CSS]. ++++ -Try it out +Try it out ++++ |==== diff --git a/modules/ROOT/pages/embed-a-viz.adoc b/modules/ROOT/pages/embed-a-viz.adoc index 763d737d6..7d802c9a2 100644 --- a/modules/ROOT/pages/embed-a-viz.adoc +++ b/modules/ROOT/pages/embed-a-viz.adoc @@ -107,7 +107,7 @@ visibleActions: [Action.DownloadAsPDF,Action.DownloadAsCSV,Action.Save,Action.Pr ---- + ++++ -Try it out +Try it out ++++ + @@ -128,7 +128,7 @@ hiddenActions: [Action.Download] ---- + ++++ -Try it out +Try it out ++++ @@ -143,7 +143,7 @@ disabledActions: [Action.Present] ---- + ++++ -Try it out +Try it out ++++ include::{path}/custom-action-note.adoc[] @@ -193,7 +193,7 @@ __String, Integer, or Boolean__. The list of operands. Operators like EQ, LE acc + ++++ -Try it in Playground +Try it in Playground ++++ For more information about the supported data types and how to use runtime filters, see xref:runtime-filters.adoc[Runtime filters]. diff --git a/modules/ROOT/pages/embed-actions.adoc b/modules/ROOT/pages/embed-actions.adoc index cc9fc20d2..d2a5c6f9c 100644 --- a/modules/ROOT/pages/embed-actions.adoc +++ b/modules/ROOT/pages/embed-actions.adoc @@ -42,7 +42,7 @@ visibleActions: [Action.Save,Action.ShowUnderlyingData,Action.Download,Action.Do Only the actions specified in the `visibleActions` attribute will appear in the embedded UI. The embedded application users can access and use the **Save**, **Show underlying data**, *Download as CSV*, and *Pin* menu actions. ++++ -Try it out +Try it out ++++ +++

+++ @@ -55,7 +55,7 @@ visibleActions: [] ---- ++++ -Try it out +Try it out ++++ +++

+++ @@ -69,7 +69,7 @@ disabledActions: [] ---- ++++ -Try it out +Try it out ++++ +++

+++ @@ -84,7 +84,7 @@ disabledActions: [Action.Download] ---- ++++ -Try it out +Try it out ++++ @@ -99,7 +99,7 @@ hiddenActions: [] ---- ++++ -Try it out +Try it out ++++ +++

+++ @@ -113,7 +113,7 @@ hiddenActions: [Action.DownloadAsPDF,Action.DownloadAsCSV] ---- ++++ -Try it out +Try it out ++++ +++

+++ @@ -127,7 +127,7 @@ hiddenActions: [Action.DownloadAsPDF,Action.DownloadAsCSV] ---- ++++ -Try it out +Try it out ++++ +++

+++ @@ -141,7 +141,7 @@ hiddenActions: [] ---- ++++ -Try it out +Try it out ++++ == Disable actions @@ -158,7 +158,7 @@ disabledActions: [Action.ShowUnderlyingData] ---- ++++ -Try it out +Try it out ++++ Similarly, to disable multiple actions, you can specify the action strings in the `disabledActions` attribute. @@ -170,7 +170,7 @@ disabledActions: [Action.AddFilter,Action.Present] ++++ -Try it out +Try it out ++++ === Disable a custom action @@ -195,7 +195,7 @@ disabledActionReason: "Contact your administrator to enable this action" ++++ -Try it out +Try it out ++++ == Hide actions @@ -210,7 +210,7 @@ hiddenActions: [Action.Download,Action.Pin] ---- ++++ -Try it out +Try it out ++++ === Hide a custom action diff --git a/modules/ROOT/pages/embed-events.adoc b/modules/ROOT/pages/embed-events.adoc index 89b2eed87..4d3173680 100644 --- a/modules/ROOT/pages/embed-events.adoc +++ b/modules/ROOT/pages/embed-events.adoc @@ -66,7 +66,7 @@ import { LiveboardEmbed, useEmbedRef } from '@thoughtspot/visual-embed-sdk/react ---- ++++ -Try it out in Playground +Try it out in Playground ++++ diff --git a/modules/ROOT/pages/embed-nls.adoc b/modules/ROOT/pages/embed-nls.adoc index 9a9d4d4a3..0dd5d3455 100644 --- a/modules/ROOT/pages/embed-nls.adoc +++ b/modules/ROOT/pages/embed-nls.adoc @@ -146,7 +146,7 @@ visibleActions: [Action.DownloadAsPDF,Action.DownloadAsCSV,Action.Save,Action.Sh ---- + ++++ -Try it out +Try it out ++++ hiddenActions __Optional__:: @@ -161,7 +161,7 @@ hiddenActions: [Action.Share] ---- + ++++ -Try it out +Try it out ++++ @@ -176,7 +176,7 @@ disabledActions: [Action.ShowUnderlyingData] ---- + ++++ -Try it out +Try it out ++++ include::{path}/custom-action-note.adoc[] @@ -190,7 +190,7 @@ _Boolean_. When set to true, it hides the default Data Source panel. Use this at + ++++ -Try it out +Try it out ++++ [#search-query] @@ -217,7 +217,7 @@ searchOptions: { ---- ++++ -Try it out +Try it out ++++ //// @@ -255,7 +255,7 @@ Type a question or select a popular query, and verify the results. The `SageEmbed` SDK allows customizing Natural Language Search experience in the embedded view. The xref:SageViewConfig.adoc[`SageViewConfig` interface] includes several parameters to customizing the Natural Language Search page, enable or disable Worksheet selection, show or hide popular queries and sample questions. -To preview the Natural Language Search embed and customization features, use the +++Visual Embed Playground+++. +To preview the Natural Language Search embed and customization features, use the +++Visual Embed Playground+++. For more information about Natural Language Search components, interface objects, properties, methods, and enumeration members, see the following pages: diff --git a/modules/ROOT/pages/embed-search.adoc b/modules/ROOT/pages/embed-search.adoc index 7e0cd2918..c8d091c73 100644 --- a/modules/ROOT/pages/embed-search.adoc +++ b/modules/ROOT/pages/embed-search.adoc @@ -132,7 +132,7 @@ _Boolean_. When set to true, it minimizes the Data Source panel. + ++++ -Try it out +Try it out ++++ @@ -151,7 +151,7 @@ visibleActions: [Action.DownloadAsPDF,Action.DownloadAsCSV,Action.Save,Action.Sh ---- + ++++ -Try it out +Try it out ++++ @@ -167,7 +167,7 @@ hiddenActions: [Action.Share] ---- + ++++ -Try it out +Try it out ++++ @@ -182,7 +182,7 @@ disabledActions: [Action.ShowUnderlyingData] ---- + ++++ -Try it out +Try it out ++++ include::{path}/custom-action-note.adoc[] @@ -196,7 +196,7 @@ _Boolean_. When set to true, it hides the default Data Source panel. Use this at + ++++ -Try it out +Try it out ++++ @@ -208,7 +208,7 @@ Search Assist uses the predefined queries and answers from the Worksheet. Users + ++++ -Try it out +Try it out ++++ forceTable __Optional__:: @@ -216,7 +216,7 @@ _Boolean_. When set to `true`, the tabular view is set as the default format for + ++++ -Try it out +Try it out ++++ @@ -225,7 +225,7 @@ _Boolean_. When set to true, it hides charts and tables that appear beneath the + ++++ -Try it out +Try it out ++++ [#search-query] @@ -252,7 +252,7 @@ searchOptions: { ---- ++++ -Try it out +Try it out ++++ //// diff --git a/modules/ROOT/pages/embed-searchbar.adoc b/modules/ROOT/pages/embed-searchbar.adoc index 0b75efc66..3cbddcc79 100644 --- a/modules/ROOT/pages/embed-searchbar.adoc +++ b/modules/ROOT/pages/embed-searchbar.adoc @@ -136,7 +136,7 @@ visibleActions: [Action.DownloadAsPDF,Action.DownloadAsCSV,Action.Save,Action.Sh ---- + ++++ -Try it out +Try it out ++++ hiddenActions __Optional__:: @@ -151,7 +151,7 @@ hiddenActions: [Action.Share] ---- + ++++ -Try it out +Try it out ++++ @@ -166,7 +166,7 @@ disabledActions: [Action.ShowUnderlyingData] ---- + ++++ -Try it out +Try it out ++++ include::{path}/custom-action-note.adoc[] @@ -180,7 +180,7 @@ _Boolean_. When set to true, it hides the default Data Source panel. Use this at + ++++ -Try it out +Try it out ++++ [#search-query] @@ -207,7 +207,7 @@ searchOptions: { ---- ++++ -Try it out +Try it out ++++ //// diff --git a/modules/ROOT/pages/full-app-customize.adoc b/modules/ROOT/pages/full-app-customize.adoc index 840117db7..e39e57c8e 100644 --- a/modules/ROOT/pages/full-app-customize.adoc +++ b/modules/ROOT/pages/full-app-customize.adoc @@ -462,7 +462,7 @@ If there is an element of a page that you dislike and cannot hide with any combi Specifying a direct element using the direct CSS selectors vs. the ThoughtSpot provided variables. To discover the appropriate selector, use the *Inspect* functionality of your browser to bring up the *Elements* portion of the browser's Developer Tools, then look at the *Styles* information. -An example of using direct selectors in a file is available in the link:https://github.com/thoughtspot/custom-css-demo/blob/main/complete.css[complete.css, target=_blank]. +An example of using direct selectors in a file is available in the link:https://github.com/thoughtspot/custom-css-demo/blob/main/complete.css[complete.css, window=_blank]. [source,css] ---- diff --git a/modules/ROOT/pages/full-embed.adoc b/modules/ROOT/pages/full-embed.adoc index 8cee1eb01..456c30bbd 100644 --- a/modules/ROOT/pages/full-embed.adoc +++ b/modules/ROOT/pages/full-embed.adoc @@ -135,7 +135,7 @@ disabledActions: [Action.ShowUnderlyingData] ---- + ++++ -Try it out +Try it out ++++ disabledActionReason __Optional__:: @@ -153,7 +153,7 @@ hiddenActions: [Action.Share] ---- + ++++ -Try it out +Try it out ++++ @@ -172,7 +172,7 @@ visibleActions: [Action.Download,Action.Share,Action.Pin,Action.ShowUnderlyingDa ---- + ++++ -Try it out +Try it out ++++ + @@ -182,7 +182,7 @@ disableProfileAndHelp __Optional__:: _Boolean_. When set to `true`, the help and user profile buttons are hidden on the top navigation bar. You can use this attribute to hide these icons if the `showPrimaryNavbar` attribute is set to `true`. ++++ -Try it out +Try it out ++++ hideObjects _optional_:: @@ -198,7 +198,7 @@ _Boolean_. Shows or hides the ThoughtSpot navigation bar. + ++++ -Try it out +Try it out ++++ runtimeFilters [small]_optional_:: @@ -229,7 +229,7 @@ For more information about the supported data types and how to use runtime filte + ++++ -Try it out +Try it out ++++ tag [small]_optional_:: @@ -251,7 +251,7 @@ Search Assist uses predefined queries and answers from the worksheet. Users with + ++++ -Try it out +Try it out ++++ //// diff --git a/modules/ROOT/pages/getting-started.adoc b/modules/ROOT/pages/getting-started.adoc index 4c026c834..b19ad0529 100644 --- a/modules/ROOT/pages/getting-started.adoc +++ b/modules/ROOT/pages/getting-started.adoc @@ -57,7 +57,7 @@ Use the **LiveboardEmbed** component to xref:embed-a-viz.adoc[embed a single vis + ++++ -Embed a Liveboard +Embed a Liveboard ++++ * **SageEmbed** + @@ -65,7 +65,7 @@ Use the `SageEmbed` package to embed Natural Language Search interface. + ++++ -Embed Natural Language Search +Embed Natural Language Search ++++ * **AppEmbed** + @@ -73,14 +73,14 @@ Use the `AppEmbed` library to embed full ThoughtSpot application in your app. + ++++ -Embed full ThoughtSpot application +Embed full ThoughtSpot application ++++ * **SearchEmbed** + Use the `SearchEmbed` package to embed the ThoughtSpot search page with a pre-selected data source. + ++++ -Embed Search page +Embed Search page ++++ * **SearchBarEmbed** + @@ -88,7 +88,7 @@ Use the `SearchBarEmbed` component to embed only the ThoughtSpot Search bar and + ++++ -Embed Search bar +Embed Search bar ++++ ==== Example diff --git a/modules/ROOT/pages/graphql-guide.adoc b/modules/ROOT/pages/graphql-guide.adoc index 24616f1e9..6f332bb88 100644 --- a/modules/ROOT/pages/graphql-guide.adoc +++ b/modules/ROOT/pages/graphql-guide.adoc @@ -229,4 +229,4 @@ For more information, see link:https://www.apollographql.com/docs/react[https:// Check the GraphQL APIs on the live playground: -+++ GraphQL Playground +++ \ No newline at end of file ++++ GraphQL Playground +++ \ No newline at end of file diff --git a/modules/ROOT/pages/graphql-play-ground.adoc b/modules/ROOT/pages/graphql-play-ground.adoc index c3a561eb1..ed7e576f9 100644 --- a/modules/ROOT/pages/graphql-play-ground.adoc +++ b/modules/ROOT/pages/graphql-play-ground.adoc @@ -19,7 +19,7 @@ ThoughtSpot users with developer or administrator privileges can access the Grap To open the Playground, click *Develop* > *REST API* > *GraphQL Playground*. ++++ -View the Playground +View the Playground ++++ == Playground experience diff --git a/modules/ROOT/pages/graphql-playground.adoc b/modules/ROOT/pages/graphql-playground.adoc index 28113c964..4da557213 100644 --- a/modules/ROOT/pages/graphql-playground.adoc +++ b/modules/ROOT/pages/graphql-playground.adoc @@ -19,7 +19,7 @@ ThoughtSpot users with developer or administrator privileges can access the Grap To open the Playground, click *Develop* > *REST API* > *GraphQL Playground*. ++++ -View the Playground +View the Playground ++++ == Playground experience diff --git a/modules/ROOT/pages/home.adoc b/modules/ROOT/pages/home.adoc index 18b28e00c..6205d7184 100644 --- a/modules/ROOT/pages/home.adoc +++ b/modules/ROOT/pages/home.adoc @@ -32,7 +32,7 @@

Embed ThoughtSpot search to implement search-driven analytics in your application and help your users find answers instantly!

-

Learn more | Try it out

+

Learn more | Try it out

@@ -42,7 +42,7 @@

Embed ThoughtSpot visualizations in your application to empower your users with insights that are easy to read and modify.

-

Learn more | Try it out

+

Learn more | Try it out

@@ -52,7 +52,7 @@
-

Learn more | Try it out

+

Learn more | Try it out

@@ -71,7 +71,7 @@ Embed full ThoughtSpot app -->

- Learn more | Try it out + Learn more | Try it out

@@ -97,7 +97,7 @@ Customize UI -->

- Learn more | Try it out + Learn more | Try it out

@@ -123,22 +123,22 @@ What's new

SDK changelog

REST API changelog

-

ThoughtSpot Cloud Release Notes

-

ThoughtSpot Software Release Notes

 +

ThoughtSpot Cloud Release Notes

+

ThoughtSpot Software Release Notes

Additional resources

Get trained

- Go to ThoughtSpot U + Go to ThoughtSpot U

Join ThoughtSpot community

- Go to Community + Go to Community

View code samples

- Go to CodeSpot + Go to CodeSpot

diff --git a/modules/ROOT/pages/integration-overview.adoc b/modules/ROOT/pages/integration-overview.adoc index 8a595d99c..5fd53b629 100644 --- a/modules/ROOT/pages/integration-overview.adoc +++ b/modules/ROOT/pages/integration-overview.adoc @@ -66,6 +66,6 @@ For more information, see xref:security-settings.adoc[Configure security setting The ThoughtSpot Developer portal provides a playground for developers to explore the Visual Embed SDK components. The *Playground* offers an interactive coding experience for developers to evaluate the APIs and embed ThoughtSpot search, visualizations, Liveboards, or the full ThoughtSpot experience within their host application. ++++ -Go to Playground +Go to Playground ++++ diff --git a/modules/ROOT/pages/org-manage-api.adoc b/modules/ROOT/pages/org-manage-api.adoc index 049f536ba..0fe939bec 100644 --- a/modules/ROOT/pages/org-manage-api.adoc +++ b/modules/ROOT/pages/org-manage-api.adoc @@ -36,10 +36,10 @@ To create an Org on a multi-tenant ThoughtSpot instance, you need cluster admini For Orgs CRUD operations, you can also use the following REST API v2.0 Org endpoints: -* +++/api/rest/2.0/orgs/create+++ -* +++ /api/rest/2.0/orgs/search+++ -* +++/api/rest/2.0/orgs/{org_identifier}/update +++ -* +++ /api/rest/2.0/orgs/{org_identifier}/delete+++ +* +++/api/rest/2.0/orgs/create+++ +* +++ /api/rest/2.0/orgs/search+++ +* +++/api/rest/2.0/orgs/{org_identifier}/update +++ +* +++ /api/rest/2.0/orgs/{org_identifier}/delete+++ === REST API v1 endpoints @@ -82,13 +82,13 @@ You can also create a user just-in-time and assign Orgs, groups, and privileges For more information, see xref:api-auth-session.adoc[REST API v1 authentication]. a| **Basic authentication** + -To log in to a specific Org context with basic authentication, specify the Org ID in the +++ /api/rest/2.0/auth/session/login +++ API request. +To log in to a specific Org context with basic authentication, specify the Org ID in the +++ /api/rest/2.0/auth/session/login +++ API request. **Token-based authentication** + Use the following API endpoints: -* +++ /api/rest/2.0/auth/token/object +++ -* +++ /api/rest/2.0/auth/token/full +++ +* +++ /api/rest/2.0/auth/token/object +++ +* +++ /api/rest/2.0/auth/token/full +++ These above endpoints also support just-in-time provisioning of users to Orgs and groups. For more information, see xref:authentication.adoc[REST API v2 authentication]. @@ -97,20 +97,20 @@ These above endpoints also support just-in-time provisioning of users to Orgs an To add multiple users to an Org in bulk, use the xref:user-api.adoc#addOrg[`/tspublic/v1/user/addtoorg`] API endpoint. + To remove a user from an Org, use the xref:user-api.adoc#delete-user[`DELETE /tspublic/v1/user/{userid}`] endpoint. If a user belongs only to the Org specified in the `DELETE` request, the user will be deleted from the Org and ThoughtSpot system. If the user belongs to more than one Org, the `DELETE` operation removes the user from only the Org specified in the API request. To remove the user from the ThoughtSpot system and all Orgs, you must set the `orgid` to `-1` in your API request. -|To create users and assign users to one or several Orgs, use the +++ /api/rest/2.0/users/create +++ API endpoint. + +|To create users and assign users to one or several Orgs, use the +++ /api/rest/2.0/users/create +++ API endpoint. + -To assign an existing user to new Orgs or remove a user from an Org, use the +++ /api/rest/2.0/users/{user_identifier}/update +++ API endpoint. +To assign an existing user to new Orgs or remove a user from an Org, use the +++ /api/rest/2.0/users/{user_identifier}/update +++ API endpoint. |Group provisioning a|To create a group in an Org, log in to the Org context or xref:session-api.adoc#orgSwitch[switch to the Org context] and send an API request to the xref:group-api.adoc#create-group[`/tspublic/v1/group/`] endpoint. -a|To create a group in an Org, use the +++ /api/rest/2.0/groups/create +++ API endpoint. +a|To create a group in an Org, use the +++ /api/rest/2.0/groups/create +++ API endpoint. |Fetching Orgs a| * To get a list of Orgs for the currently logged-in user, use the xref:session-api.adoc#getOrgs[/tspublic/v1/session/orgs] API endpoint. + * To get Orgs for a specific user, use the xref:session-api.adoc#getOrgsForUser[/tspublic/v1/session/orgs/users/{userid}] endpoint. Set the Org scope to `ALL` to get all Orgs for a given user. a| The REST API v2 endpoints allow you to perform query operations to get Org details: -* To get a list of all Orgs on the cluster, use +++/api/rest/2.0/orgs/search +++ (Requires cluster administrator privileges) +* To get a list of all Orgs on the cluster, use +++/api/rest/2.0/orgs/search +++ (Requires cluster administrator privileges) -* To get Org details for a user, use +++/api/rest/2.0/users/search+++ -* To get Org details for a group, use +++/api/rest/2.0/groups/search+++ +* To get Org details for a user, use +++/api/rest/2.0/users/search+++ +* To get Org details for a group, use +++/api/rest/2.0/groups/search+++ |===== diff --git a/modules/ROOT/pages/page-navigation.adoc b/modules/ROOT/pages/page-navigation.adoc index 035932594..474b60f94 100644 --- a/modules/ROOT/pages/page-navigation.adoc +++ b/modules/ROOT/pages/page-navigation.adoc @@ -63,7 +63,7 @@ Once you have the URL patterns defined within the embedding application to load Navigation typically takes the form of elements in a menu, but could also be a dropdown selector or a set of buttons. -Please see the link:https://github.com/thoughtspot/ts_everywhere_resources/blob/master/examples/menus_and_other_navigation_components/rest_api_ui_navigation_v2.html[example on GitHub, target=_blank] for a complete flow of REST API requests powering various navigation components to be rendered into an embedding application's page. +Please see the link:https://github.com/thoughtspot/ts_everywhere_resources/blob/master/examples/menus_and_other_navigation_components/rest_api_ui_navigation_v2.html[example on GitHub, window=_blank] for a complete flow of REST API requests powering various navigation components to be rendered into an embedding application's page. === Hardcoded links within a menu system If your web application only embeds a limited set of ThoughtSpot objects, without granting users the ability to save their own objects, you can __hardcode__ the object IDs and names of the ThoughtSpot content. @@ -167,7 +167,7 @@ The display of a visualization from a Liveboard differs from a saved Answer obje Setting the `include_visualization_headers` request parameter to `true` will bring back the list of all visualization details with any Liveboard response. This request requires a separate API call for each Liveboard in the V1 REST API. === Replicating the ThoughtSpot UI Liveboards or Answers page -As mentioned before, the `/metadata/list` V1 REST API provides the same details as the internal REST API used to display the pages within the ThoughtSpot UI, making it easy to "replicate" those pages exactly within the embedding web app's own UI. The V2.0 REST API includes these details within the `metadata_headers` section of its response so it can be used for a similar purpose as well (see see the link:https://github.com/thoughtspot/ts_everywhere_resources/blob/master/examples/menus_and_other_navigation_components/rest_api_ui_navigation_v2.html[example on GitHub for V2.0 equivalents, target=_blank]. +As mentioned before, the `/metadata/list` V1 REST API provides the same details as the internal REST API used to display the pages within the ThoughtSpot UI, making it easy to "replicate" those pages exactly within the embedding web app's own UI. The V2.0 REST API includes these details within the `metadata_headers` section of its response so it can be used for a similar purpose as well (see see the link:https://github.com/thoughtspot/ts_everywhere_resources/blob/master/examples/menus_and_other_navigation_components/rest_api_ui_navigation_v2.html[example on GitHub for V2.0 equivalents, window=_blank]. The endpoint can only request one object type at a time: + diff --git a/modules/ROOT/pages/partials/modify-available-actions.adoc b/modules/ROOT/pages/partials/modify-available-actions.adoc index e24234be1..9dac6fc36 100644 --- a/modules/ROOT/pages/partials/modify-available-actions.adoc +++ b/modules/ROOT/pages/partials/modify-available-actions.adoc @@ -23,7 +23,7 @@ hiddenActions: [Action.DownloadAsPDF] ---- + ++++ -Try it out +Try it out ++++ + include::{path}/custom-action-note.adoc[] diff --git a/modules/ROOT/pages/rest-api-getstarted.adoc b/modules/ROOT/pages/rest-api-getstarted.adoc index 9fa15520a..cc208d16b 100644 --- a/modules/ROOT/pages/rest-api-getstarted.adoc +++ b/modules/ROOT/pages/rest-api-getstarted.adoc @@ -22,7 +22,7 @@ You can access the REST API v1 explorer using one of the following options: + ++++ -Try it out +Try it out ++++ * Using the Swagger URL diff --git a/modules/ROOT/pages/authentication.adoc b/modules/ROOT/pages/rest-api-v2/authentication.adoc similarity index 100% rename from modules/ROOT/pages/authentication.adoc rename to modules/ROOT/pages/rest-api-v2/authentication.adoc diff --git a/modules/ROOT/pages/rest-api-v2-groups-search.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-groups-search.adoc similarity index 97% rename from modules/ROOT/pages/rest-api-v2-groups-search.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-groups-search.adoc index 779b503cd..2f6908769 100644 --- a/modules/ROOT/pages/rest-api-v2-groups-search.adoc +++ b/modules/ROOT/pages/rest-api-v2/rest-api-v2-groups-search.adoc @@ -6,11 +6,11 @@ :page-pageid: rest-apiv2-groups-search :page-description: Many use cases are possible with the v2.0 groups/search endpoint -The `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fsearch-user-groups[/groups/search, target=_blank]` API endpoint is used to retrieve details about ThooughtSpot groups (referred to as user groups or with the `USER_GROUP` value in the API), with many specific filtering capabilities for answering a number of relevant questions about groups. +The `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fsearch-user-groups[/groups/search, window=_blank]` API endpoint is used to retrieve details about ThooughtSpot groups (referred to as user groups or with the `USER_GROUP` value in the API), with many specific filtering capabilities for answering a number of relevant questions about groups. You can search for the `USER_GROUP` type using `metadata/search`, but `groups/search` provides considerably more control. -The overall structure of `groups/search` request is link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fapi-rest-20-groups-search-request[described as a combination of objects, target=_blank]. +The overall structure of `groups/search` request is link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fapi-rest-20-groups-search-request[described as a combination of objects, window=_blank]. Note that many parameters in the request are *optional*, and leaving the parameter name out entirely has a different effect from including the parameter and specific values. @@ -78,7 +78,7 @@ The response from any call to `groups/search` will resemble the following: == Lists of metadata The `/groups/search` API performs listing functions when you do not send specific object IDs as part of your request. Note you must send some request in the body of the POST, even if this is only `{ }`. -The basic metadata selectors are placed in the `metadata` parameter as an array of link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-list-item-input[Metadata List objects, target=_blank]. +The basic metadata selectors are placed in the `metadata` parameter as an array of link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-list-item-input[Metadata List objects, window=_blank]. For example, to see *all groups*, you can simply send the `record_offset` and `record_size` parameters: @@ -107,7 +107,7 @@ Several parameters allow referencing a group object directly. The `group_identif == Filtering and sorting === sort_options -The `sort_options` parameter requires link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fenumerations%2Ffield-name[Sort Options, target=_blank] to sort on one field of the metadata response either in the ascending (`ASC`) or descending (`DESC`) order: +The `sort_options` parameter requires link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fenumerations%2Ffield-name[Sort Options, window=_blank] to sort on one field of the metadata response either in the ascending (`ASC`) or descending (`DESC`) order: [source,JSON] ---- diff --git a/modules/ROOT/pages/rest-api-v2-metadata-search.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-metadata-search.adoc similarity index 96% rename from modules/ROOT/pages/rest-api-v2-metadata-search.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-metadata-search.adoc index d566dad2b..de5ba2694 100644 --- a/modules/ROOT/pages/rest-api-v2-metadata-search.adoc +++ b/modules/ROOT/pages/rest-api-v2/rest-api-v2-metadata-search.adoc @@ -6,9 +6,9 @@ :page-pageid: rest-apiv2-metadata-search :page-description: Many use cases are possible with the very V2.0 metadata/search endpoint -The `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fsearch-metadata[/metadata/search, target=_blank]` endpoint is the most versatile of all metadata endpoints. It can be used to search for lists or to retrieve very detailed information about specific objects. This endpoint replaces `metadata/list`, `metadata/listobjectheaders`, `metadata/details`, and `metadata/listvizheaders` from REST API v1. +The `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fsearch-metadata[/metadata/search, window=_blank]` endpoint is the most versatile of all metadata endpoints. It can be used to search for lists or to retrieve very detailed information about specific objects. This endpoint replaces `metadata/list`, `metadata/listobjectheaders`, `metadata/details`, and `metadata/listvizheaders` from REST API v1. -The overall structure of `metadata/search` request is link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fapi-rest-20-metadata-search-request[described as a combination of objects, target=_blank]. +The overall structure of `metadata/search` request is link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fapi-rest-20-metadata-search-request[described as a combination of objects, window=_blank]. Note that many parameters in the request are *optional*, and leaving the parameter name out entirely has a different effect from including the parameter and specific values. @@ -87,7 +87,7 @@ You'll notice a number of other keys with a `null` value. Various request parame == Lists of metadata The `/metadata/search` API performs listing functions when you do not send specific object IDs as part of your request. -The basic metadata selectors are placed in the `metadata` parameter as an array of link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-list-item-input[Metadata List objects, target=_blank]. +The basic metadata selectors are placed in the `metadata` parameter as an array of link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-list-item-input[Metadata List objects, window=_blank]. For example, to get all Liveboards, you need to send only a single metadata object with `type` parameter set to `LIVEBOARD`. @@ -153,7 +153,7 @@ You can specify an object name in the `identifier` key, but you must include the } ---- -The response to a `metadata/search` request takes the form of an array of link:https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/api/rest/playgroundV2_0?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-search-response[Metadata Response Objects, target=_blank]: +The response to a `metadata/search` request takes the form of an array of link:https://try-everywhere.thoughtspot.cloud/v2/#/everywhere/api/rest/playgroundV2_0?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-search-response[Metadata Response Objects, window=_blank]: [source,JSON] ---- @@ -178,7 +178,7 @@ The `metadata_header` key is always returned with values, regardless of the requ == Filtering and sorting === sort_options -The `sort_options` parameter requires link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-search-sort-options[Metadata Search Sort Options, target=_blank] to sort on one field of the metadata response either in the ascending (`ASC`) or descending (`DESC`) order: +The `sort_options` parameter requires link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-search-sort-options[Metadata Search Sort Options, window=_blank] to sort on one field of the metadata response either in the ascending (`ASC`) or descending (`DESC`) order: [source,JSON] ---- @@ -201,9 +201,9 @@ If you need multiple levels of sorting, you'll have to parse the response progra === permissions You can filter responses based on who can access the object, that is, who the content has been shared to, using the `permissions` parameter. -While the `permissions` parameter filters the response set of `metadata/search`, the objects in the response do not list the full set of assigned permissions. Please use the `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Ffetch-permissions-on-metadata[/security/metadata/fetch-permissions/`, target=_blank]` endpoint for a full listing, which replaces the individual `security` endpoints in the v1 REST API, such as the xref:security-api.adoc#obj-permission-all[get object permission details for a specific object type] endpoint. +While the `permissions` parameter filters the response set of `metadata/search`, the objects in the response do not list the full set of assigned permissions. Please use the `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Ffetch-permissions-on-metadata[/security/metadata/fetch-permissions/`, window=_blank]` endpoint for a full listing, which replaces the individual `security` endpoints in the v1 REST API, such as the xref:security-api.adoc#obj-permission-all[get object permission details for a specific object type] endpoint. -The `permissions` object takes an array of objects that define a `principal` and a `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fenumerations%2Fshare-mode[share_mode, target=_blank]`. `principal` is an object with a `type` of `USER` or `USER_GROUP` and an `identifier`, either the name or the GUID of the principal: +The `permissions` object takes an array of objects that define a `principal` and a `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fenumerations%2Fshare-mode[share_mode, window=_blank]`. `principal` is an object with a `type` of `USER` or `USER_GROUP` and an `identifier`, either the name or the GUID of the principal: [source,JSON] ---- @@ -404,7 +404,7 @@ Common use cases for the dependent objects include tagging, auditing proper shar The `include_stats` boolean option causes the `stats` key of the response to be filled with an object with statistics about user access to the object. === include_worksheet_search_assist_data -The `include_worksheet_search_assist_data` boolean parameter includes details about the link:https://docs.thoughtspot.com/cloud/latest/search-assist[Search Assist, target=_blank] feature within the response. +The `include_worksheet_search_assist_data` boolean parameter includes details about the link:https://docs.thoughtspot.com/cloud/latest/search-assist[Search Assist, window=_blank] feature within the response. === include_hidden_objects, include_incomplete_objects, include_auto_created_objects The `metadata/search` response typically excludes objects that are `auto-created`, `hidden`, or `incomplete`, as these objects represent internal use cases typically not seen or modified by any end user. diff --git a/modules/ROOT/pages/rest-api-v2-playground.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-playground.adoc similarity index 100% rename from modules/ROOT/pages/rest-api-v2-playground.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-playground.adoc diff --git a/modules/ROOT/pages/rest-api-v2-reference-beta.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-reference-beta.adoc similarity index 85% rename from modules/ROOT/pages/rest-api-v2-reference-beta.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-reference-beta.adoc index f248436d7..abc78a34d 100644 --- a/modules/ROOT/pages/rest-api-v2-reference-beta.adoc +++ b/modules/ROOT/pages/rest-api-v2/rest-api-v2-reference-beta.adoc @@ -23,7 +23,7 @@ Gets details of the current session for the logged-in user. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -36,7 +36,7 @@ Signs in a user to ThoughtSpot. //// ++++ -View in Playground +View in Playground ++++ //// @@ -46,7 +46,7 @@ Signs in a user to ThoughtSpot. Gets an OAuth access token for a ThoughtSpot client. You must send this token in the `Authorization` header to authorize your API requests. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -56,7 +56,7 @@ Gets an OAuth access token for a ThoughtSpot client. You must send this token in Revokes an existing access token assigned to a ThoughtSpot client. To make API calls, you must obtain a new access token. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -66,7 +66,7 @@ Revokes an existing access token assigned to a ThoughtSpot client. To make API c Logs out a ThoughtSpot user. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -79,7 +79,7 @@ Logs out a ThoughtSpot user. Creates a user object. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -89,7 +89,7 @@ Creates a user object. Gets details of a specific user. You must provide the username or the GUID of the user. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -99,7 +99,7 @@ Gets details of a specific user. You must provide the username or the GUID of th Modifies the properties of a user object. You must specify a username or the GUID of the user. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -109,7 +109,7 @@ Modifies the properties of a user object. You must specify a username or the GUI Deletes a user object. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -119,7 +119,7 @@ Deletes a user object. Assigns a user to groups. If the assigned groups have privileges configured, the user inherits these privileges. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -129,7 +129,7 @@ Assigns a user to groups. If the assigned groups have privileges configured, the Removes the groups assigned to a user. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -139,7 +139,7 @@ Removes the groups assigned to a user. Allows changing a ThoughtSpot user's password. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -149,7 +149,7 @@ Allows changing a ThoughtSpot user's password. Gets a list of users available in the ThoughtSpot system. To filter your query, you can specify the user type, group, privileges, sharing visibility, and other such attributes. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -162,7 +162,7 @@ Gets a list of users available in the ThoughtSpot system. To filter your query, Gets details of a specific group. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -172,7 +172,7 @@ Gets details of a specific group. Creates a group object. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -182,7 +182,7 @@ Creates a group object. Requires administrator privileges. Modifies the properties of a group object. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -193,7 +193,7 @@ Assigns privileges to a group. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -204,7 +204,7 @@ Removes privileges assigned to a group. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -215,7 +215,7 @@ Deletes a group object. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// @@ -227,7 +227,7 @@ Assigns users to a group. Requires administrator privileges. //// ++++ -View in Playground +View in Playground ++++ //// @@ -239,7 +239,7 @@ Removes one or several users assigned to a group. Requires administrator privile //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -250,7 +250,7 @@ Adds a group to another group object. This API request creates a hierarchy of gr //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -261,7 +261,7 @@ Removes a group from the parent group. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -271,7 +271,7 @@ Removes a group from the parent group. Gets a list of groups created in the ThoughtSpot system. To filter your query, you can specify the group type, group name, privileges, sharing visibility, users, and other such attributes. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -285,7 +285,7 @@ Gets details of the current configuration of a ThoughtSpot cluster. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -296,7 +296,7 @@ Gets details of configuration overrides. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -307,7 +307,7 @@ Updates configuration settings of the ThoughtSpot cluster. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -318,7 +318,7 @@ Resets the password of a user account. //// ++++ -View in Playground +View in Playground ++++ //// @@ -330,7 +330,7 @@ Synchronizes user account and group properties from an external database with Th //// ++++ -View in Playground +View in Playground ++++ //// @@ -342,7 +342,7 @@ Transfers the ownership of objects from one user to another. //// ++++ -View in Playground +View in Playground ++++ //// @@ -354,7 +354,7 @@ Assigns ownership of objects to a specific user. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -365,7 +365,7 @@ Logs out specified users from ThoughtSpot. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -379,7 +379,7 @@ Gets details for the specified tag. You must specify the tag name or the GUID. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -390,7 +390,7 @@ Creates a tag object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -402,7 +402,7 @@ Modifies the properties of a tag object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -414,7 +414,7 @@ Assigns a tag to one or several metadata objects. You can assign a tag to a Live //// ++++ -View in Playground +View in Playground ++++ //// @@ -426,7 +426,7 @@ Removes the tag assigned to an object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -438,7 +438,7 @@ Deletes the specified tag. //// ++++ -View in Playground +View in Playground ++++ //// @@ -450,7 +450,7 @@ Adds an object such as Liveboards and answers to a user's favorites list. //// ++++ -View in Playground +View in Playground ++++ //// @@ -462,7 +462,7 @@ Removes the specified object from the user's favorites list. //// ++++ -View in Playground +View in Playground ++++ //// @@ -474,7 +474,7 @@ Gets the details of the Liveboard that is set as a default Liveboard for the Tho //// ++++ -View in Playground +View in Playground ++++ //// @@ -486,7 +486,7 @@ Assigns a Liveboard as a default Liveboard for a ThoughtSpot user. //// ++++ -View in Playground +View in Playground ++++ //// @@ -498,7 +498,7 @@ Removes the default home Liveboard setting for a ThoughtSpot user. //// ++++ -View in Playground +View in Playground ++++ //// @@ -510,7 +510,7 @@ Gets a list of objects with incomplete metadata. //// ++++ -View in Playground +View in Playground ++++ //// @@ -522,7 +522,7 @@ Gets header details for a specific metadata object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -534,7 +534,7 @@ Gets details of a specific metadata object. To filter your query, specify the me //// ++++ -View in Playground +View in Playground ++++ //// @@ -546,7 +546,7 @@ Gets a list of visualization headers associated with a Liveboard. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -557,7 +557,7 @@ Gets a list of all metadata objects in the ThoughtSpot system. To filter your qu //// ++++ -View in Playground +View in Playground ++++ //// @@ -569,7 +569,7 @@ Gets details of one or several metadata objects of a specific type. //// ++++ -View in Playground +View in Playground ++++ //// @@ -586,7 +586,7 @@ Note that the endpoint does not support deleting the connection, user, and group //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -597,7 +597,7 @@ Gets a list of dependent metadata objects. //// ++++ -View in Playground +View in Playground ++++ //// @@ -609,7 +609,7 @@ Exports a TML object and associated metadata. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -620,7 +620,7 @@ Imports one or several TML objects and object associations. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -634,7 +634,7 @@ Gets details of a specific data connection. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -645,7 +645,7 @@ Gets details of the databases associated with a connection ID. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -656,7 +656,7 @@ Gets details of the tables associated with a connection ID. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -667,7 +667,7 @@ Gets details of the columns of the tables associated with a connection ID. //// ++++ -View in Playground +View in Playground ++++ //// @@ -679,7 +679,7 @@ Creates a data connection. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -690,7 +690,7 @@ Updates an existing data connection. //// ++++ -View in Playground +View in Playground ++++ //// @@ -702,7 +702,7 @@ Deletes a data connection. //// ++++ -View in Playground +View in Playground ++++ //// @@ -714,7 +714,7 @@ Adds a table to an existing data connection. //// ++++ -View in Playground +View in Playground ++++ //// @@ -726,7 +726,7 @@ Removes a table from an existing data connection. //// ++++ -View in Playground +View in Playground ++++ //// @@ -738,7 +738,7 @@ Gets details of all data connections. You can also query data for a specific con //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -752,7 +752,7 @@ Allows constructing a search query string and retrieves data from a search query //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -763,7 +763,7 @@ Gets data from a saved search answer. //// ++++ -View in Playground +View in Playground ++++ //// @@ -775,7 +775,7 @@ Gets data from the specified Liveboard and visualization. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -788,7 +788,7 @@ Retrieves SQL for an Answer object. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -801,7 +801,7 @@ Retrieves SQL for a visualization on a Liveboard. //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -815,7 +815,7 @@ Downloads Answer data in the specified file format, such as PDF, CSV, PNG, and X //// ++++ -View in Playground +View in Playground ++++ //// @@ -827,7 +827,7 @@ Downloads a given Liveboard and its visualizations as a PDF, CSV, XLSX, or PNG f //// ++++ -View in Playground +View in Playground ++++ //// -- @@ -840,7 +840,7 @@ Allows sharing an object with another user or group in ThoughtSpot. //// ++++ -View in Playground +View in Playground ++++ //// @@ -852,7 +852,7 @@ Allows sharing a Liveboard visualization with another user or group in ThoughtS //// ++++ -View in Playground +View in Playground ++++ //// @@ -864,7 +864,7 @@ Gets access permission details for a metadata object. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -875,7 +875,7 @@ Gets a list of objects that the specified user or group has access to. //// ++++ -View in Playground +View in Playground ++++ //// @@ -887,7 +887,7 @@ Gets permission details for specific objects, and users and groups who have acce //// ++++ -View in Playground +View in Playground ++++ //// @@ -899,7 +899,7 @@ Gets a list objects to which a user or group has `READ_ONLY` or `MODIFY` permiss //// ++++ -View in Playground +View in Playground ++++ //// @@ -911,7 +911,7 @@ Gets details of a custom action. //// ++++ -View in Playground +View in Playground ++++ //// @@ -923,7 +923,7 @@ Creates a custom action. //// ++++ -View in Playground +View in Playground ++++ //// @@ -935,7 +935,7 @@ Updates a custom action object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -947,7 +947,7 @@ Deletes a custom action object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -959,7 +959,7 @@ Allows searching for custom actions available in ThoughtSpot. //// ++++ -View in Playground +View in Playground ++++ //// @@ -971,7 +971,7 @@ Gets metadata association details for a given custom action. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -982,7 +982,7 @@ Updates metadata association for a given custom action. //// ++++ -View in Playground +View in Playground ++++ //// @@ -994,7 +994,7 @@ Removes custom action association to a user, group or metadata object. //// ++++ -View in Playground +View in Playground ++++ //// @@ -1008,7 +1008,7 @@ Gets security audit logs from the ThoughtSpot system. //// ++++ -View in Playground +View in Playground ++++ //// +++

+++ @@ -1024,7 +1024,7 @@ Refreshes data in a materialized view. + This endpoint is applicable to ThoughtSpot Software deployments only. ++++ -View in Playground +View in Playground ++++ +++

+++ -- diff --git a/modules/ROOT/pages/rest-api-v2-reference.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-reference.adoc similarity index 100% rename from modules/ROOT/pages/rest-api-v2-reference.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-reference.adoc diff --git a/modules/ROOT/pages/rest-api-v2-search.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-search.adoc similarity index 99% rename from modules/ROOT/pages/rest-api-v2-search.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-search.adoc index 208d16cfd..67128dcd2 100644 --- a/modules/ROOT/pages/rest-api-v2-search.adoc +++ b/modules/ROOT/pages/rest-api-v2/rest-api-v2-search.adoc @@ -225,7 +225,7 @@ The `metadata` key holds information about the object that is scheduled. For add The `author` key holds information about the user who created the schedule. For additional details about that user, use the `users/search` endpoint. === Sort the response -The `sort_options` parameter takes a link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-search-sort-options[Metadata Search Sort Options, target=_blank] object allowing for sorting on one field of the metadata response either **ASC** or **DESC**: +The `sort_options` parameter takes a link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fmetadata-search-sort-options[Metadata Search Sort Options, window=_blank] object allowing for sorting on one field of the metadata response either **ASC** or **DESC**: [source,JSON] ---- diff --git a/modules/ROOT/pages/rest-api-v2-users-search.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2-users-search.adoc similarity index 98% rename from modules/ROOT/pages/rest-api-v2-users-search.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2-users-search.adoc index fc2e4f099..4fd9d44ee 100644 --- a/modules/ROOT/pages/rest-api-v2-users-search.adoc +++ b/modules/ROOT/pages/rest-api-v2/rest-api-v2-users-search.adoc @@ -6,11 +6,11 @@ :page-pageid: rest-apiv2-users-search :page-description: Many use cases are possible with the very V2.0 users/search endpoint -The `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fsearch-users[/users/search, target=_blank]` API endpoint is used to retrieve details about ThoughtSpot users, with many specific filtering capabilities for answering a number of relevant questions about users. +The `link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fsearch-users[/users/search, window=_blank]` API endpoint is used to retrieve details about ThoughtSpot users, with many specific filtering capabilities for answering a number of relevant questions about users. You can search for the `USER` type using `metadata/search`, but `users/search` provides considerably more control. -The overall structure of `users/search` request is link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fapi-rest-20-users-search-request[described as a combination of objects, target=_blank]. +The overall structure of `users/search` request is link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fstructures%2Fapi-rest-20-users-search-request[described as a combination of objects, window=_blank]. Note that many parameters in the request are *optional*, and leaving the parameter name out entirely has a different effect from including the parameter and specific values. @@ -124,7 +124,7 @@ The `display_name` property checks against the visible name that a user sees wit === sort_options -The `sort_options` parameter requires link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fenumerations%2Ffield-name[Users Search Sort Options, target=_blank] to sort on one field of the metadata response either in the ascending (`ASC`) or descending (`DESC`) order: +The `sort_options` parameter requires link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fmodels%2Fenumerations%2Ffield-name[Users Search Sort Options, window=_blank] to sort on one field of the metadata response either in the ascending (`ASC`) or descending (`DESC`) order: [source,JSON] ---- diff --git a/modules/ROOT/pages/rest-api-v2.adoc b/modules/ROOT/pages/rest-api-v2/rest-api-v2.adoc similarity index 100% rename from modules/ROOT/pages/rest-api-v2.adoc rename to modules/ROOT/pages/rest-api-v2/rest-api-v2.adoc diff --git a/modules/ROOT/pages/rest-apiv2-js.adoc b/modules/ROOT/pages/rest-api-v2/rest-apiv2-js.adoc similarity index 98% rename from modules/ROOT/pages/rest-apiv2-js.adoc rename to modules/ROOT/pages/rest-api-v2/rest-apiv2-js.adoc index 75f30647b..58580cc8b 100644 --- a/modules/ROOT/pages/rest-apiv2-js.adoc +++ b/modules/ROOT/pages/rest-api-v2/rest-apiv2-js.adoc @@ -10,7 +10,7 @@ REST API v2.0 uses JSON for the request and the response format, so it is easy t Every REST API v2.0 endpoint uses either an HTTP GET or POST request, with or without a JSON request, so this simple async wrapper function can be used generically to build out any specific endpoint request. Before making an API request to a REST API v2.0 endpoint, xref:authentication.adoc[obtain a bearer token or set session cookies]. -The Visual Embed SDK includes a link:https://developers.thoughtspot.com/docs/Function_tokenizedFetch[tokenizedFetch function, target=_blank] which will automatically add the bearer token that the SDK has retrieved already. Add `tokenizedFetch` to the list of imports from the Visual Embed SDK, and then the following code will work for any authorization method: +The Visual Embed SDK includes a link:https://developers.thoughtspot.com/docs/Function_tokenizedFetch[tokenizedFetch function, window=_blank] which will automatically add the bearer token that the SDK has retrieved already. Add `tokenizedFetch` to the list of imports from the Visual Embed SDK, and then the following code will work for any authorization method: [source,javascript] ---- diff --git a/modules/ROOT/pages/runtime-filters.adoc b/modules/ROOT/pages/runtime-filters.adoc index ba0892b30..d67dfd59c 100644 --- a/modules/ROOT/pages/runtime-filters.adoc +++ b/modules/ROOT/pages/runtime-filters.adoc @@ -466,7 +466,7 @@ The following video shows how to apply multiple runtime filters on a Liveboard. video::./images/runtime-filters.mp4[width=100%,options="autoplay,loop"] ++++ Copy sample code -Try it out in Playground +Try it out in Playground ++++ -- diff --git a/modules/ROOT/pages/search-assist-tse.adoc b/modules/ROOT/pages/search-assist-tse.adoc index 9a535d785..7ec85b21a 100644 --- a/modules/ROOT/pages/search-assist-tse.adoc +++ b/modules/ROOT/pages/search-assist-tse.adoc @@ -31,7 +31,7 @@ const searchEmbed = new SearchEmbed(document.getElementById('ts-embed'), { ---- ++++ -Try it out +Try it out ++++ == Configure Search Assist content diff --git a/modules/ROOT/pages/session-api.adoc b/modules/ROOT/pages/session-api.adoc index 7082250fa..4b74fb5fa 100644 --- a/modules/ROOT/pages/session-api.adoc +++ b/modules/ROOT/pages/session-api.adoc @@ -6,6 +6,7 @@ :page-pageid: session-api :page-description: To log in to ThoughtSpot and create user sessions, use the session API endpoints + The Session APIs allow ThoughtSpot users to authenticate and manage their sessions. == Supported operations diff --git a/modules/ROOT/pages/spotdev-portal.adoc b/modules/ROOT/pages/spotdev-portal.adoc index 81bfc50dc..298182c2d 100644 --- a/modules/ROOT/pages/spotdev-portal.adoc +++ b/modules/ROOT/pages/spotdev-portal.adoc @@ -55,7 +55,7 @@ The Visual Embed SDK *Playground* allows you to explore the following Visual Emb + ++++ -Visit the Playground +Visit the Playground ++++ REST API:: @@ -68,14 +68,14 @@ REST Playground v1;; Opens the REST API v1 Explorer page. This page allows you to make API calls to the REST API v1 endpoints through the Swagger UI. + ++++ -Try it out +Try it out ++++ REST Playground v2.0;; Opens the REST API v2.0 Playground, which allows you to view the v2.0 endpoints, make API calls, and explore the request and response workflows. + ++++ -Try it out +Try it out ++++ Customizations:: diff --git a/modules/tutorials/pages/rest-api/rest-api_lesson-02.adoc b/modules/tutorials/pages/rest-api/rest-api_lesson-02.adoc index 2b620252f..4d8f07f71 100644 --- a/modules/tutorials/pages/rest-api/rest-api_lesson-02.adoc +++ b/modules/tutorials/pages/rest-api/rest-api_lesson-02.adoc @@ -199,7 +199,7 @@ Unfortunately, making a REST API request to a web server can result in any numbe Good coding involves testing for and handling error situations. === Using try and except in Python -Python code raises `link:https://docs.python.org/3/tutorial/errors.html[Exceptions, target=_blank]` when an error is encountered. +Python code raises `link:https://docs.python.org/3/tutorial/errors.html[Exceptions, window=_blank]` when an error is encountered. If an `Exception` is raised and is not *handled*, the script exits and displays the message provided with the Exception and other details of what failed.