From 21b79de40194f191beb49bf457970c7128377843 Mon Sep 17 00:00:00 2001 From: Ayon Ghosh Date: Fri, 5 Feb 2021 10:58:12 +0530 Subject: [PATCH] Move asciidoc files to docs/src/asciidocs --- docs/src/asciidocs/about-rest-apis.adoc | 5 + docs/src/asciidocs/authentication.adoc | 122 +++++ docs/src/asciidocs/calling-rest-api.adoc | 110 +++++ docs/src/asciidocs/customize-style.adoc | 95 ++++ docs/src/asciidocs/embed-a-viz.adoc | 60 +++ docs/src/asciidocs/embed-pinboard.adoc | 57 +++ docs/src/asciidocs/embed-search.adoc | 68 +++ docs/src/asciidocs/full-embed.adoc | 142 ++++++ docs/src/asciidocs/getting-started.adoc | 56 +++ docs/src/asciidocs/group-api.adoc | 112 +++++ docs/src/asciidocs/index.adoc | 42 ++ docs/src/asciidocs/metadata-api.adoc | 225 +++++++++ docs/src/asciidocs/rest-api-reference.adoc | 522 +++++++++++++++++++++ docs/src/asciidocs/search-data-api.adoc | 249 ++++++++++ docs/src/asciidocs/visual-embed-sdk.adoc | 135 ++++++ 15 files changed, 2000 insertions(+) create mode 100644 docs/src/asciidocs/about-rest-apis.adoc create mode 100644 docs/src/asciidocs/authentication.adoc create mode 100644 docs/src/asciidocs/calling-rest-api.adoc create mode 100644 docs/src/asciidocs/customize-style.adoc create mode 100644 docs/src/asciidocs/embed-a-viz.adoc create mode 100644 docs/src/asciidocs/embed-pinboard.adoc create mode 100644 docs/src/asciidocs/embed-search.adoc create mode 100644 docs/src/asciidocs/full-embed.adoc create mode 100644 docs/src/asciidocs/getting-started.adoc create mode 100644 docs/src/asciidocs/group-api.adoc create mode 100644 docs/src/asciidocs/index.adoc create mode 100644 docs/src/asciidocs/metadata-api.adoc create mode 100644 docs/src/asciidocs/rest-api-reference.adoc create mode 100644 docs/src/asciidocs/search-data-api.adoc create mode 100644 docs/src/asciidocs/visual-embed-sdk.adoc diff --git a/docs/src/asciidocs/about-rest-apis.adoc b/docs/src/asciidocs/about-rest-apis.adoc new file mode 100644 index 000000000..76ba324fd --- /dev/null +++ b/docs/src/asciidocs/about-rest-apis.adoc @@ -0,0 +1,5 @@ +== REST APIs +ThoughtSpot APIs are documented in the ThoughtSpot Documentation. You can also find details about the APIs and test many of them using Swagger. To access Swagger, first, login as a user with Administrator credentials. Then navigate to https:///external/swagger. You will get a list of all publicly available services. + + +You can click on a header to expand and get the list of services. Clicking on a service name provides more details about the service. diff --git a/docs/src/asciidocs/authentication.adoc b/docs/src/asciidocs/authentication.adoc new file mode 100644 index 000000000..1c2f69af6 --- /dev/null +++ b/docs/src/asciidocs/authentication.adoc @@ -0,0 +1,122 @@ +== Authentication +:toc: true + +You can control which type of authentication you use between your client application and ThoughtSpot. + +=== No Authentication + +You can simply not set up authentication. +This would require the user to be _already logged into ThoughtSpot_, before interacting with the client application. +This approach is for testing the client. +Do not use this in a production environment. + +=== SAML SSO + +To avoid showing the ThoughtSpot login page in the iFrame and provide a seamless login experience, you should configure SSO so that your users are automatically authenticated to ThoughtSpot, and the pages are loaded immediately. + +Before you can embed all or part of ThoughtSpot, you must authenticate to ThoughtSpot using SAML with the public REST API call. + +//// +For more information, see https://cloud-docs.thoughtspot.com/admin/ts-cloud/authentication-integration.html[Managing authentication with SAML]. +Note that this does not assign the user to any groups, which must be managed manually or via the APIs. + +After authentication, a URL is provided to call the desired visualization, and populate it into an ` + + +---- + +The function `updateIframeUrl(id)` contains the logic to change the src URL of the `