openapi: 3.0.0
info:
  title: ThoughtSpot Public REST 10.1.0.cl 9.2.0.cl API
  version: '2.0'
servers:
- url: '{base-url}'
  variables:
    base-url:
      default: https://localhost:443
security:
- bearerAuth: []
tags:
- name: 9.2.0.cl
paths:
  /api/rest/2.0/connection/create:
    post:
      operationId: createConnection
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nCreates a connection to a data warehouse for live query services.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n#### Create a connection without tables\n\nTo create a connection without tables:\n\n1. Pass these parameters in your API request.\n * Name of the connection.\n * Type of the data warehouse to connect to.\n * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a SnowFlake connection:\n  ```\n  {\n     \"configuration\":{\n        \"accountName\":\"thoughtspot_partner\",\n        \"user\":\"tsadmin\",\n        \"password\":\"TestConn123\",\n        \"role\":\"sysadmin\",\n        \"warehouse\":\"MEDIUM_WH\"\n     },\n     \"authenticationType\": \"SERVICE_ACCOUNT\",\n     \"databases\": [\"DB1\", \"DB2\"],\n     \"externalDatabases\":[\n\n     ]\n  }\n  ```\n2. Set `validate` to `false`.\n\n**NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n#### Create a connection with tables\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) and `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\n\nTo create a connection with tables:\n\n1. Pass these parameters in your API request.\n* Name of the connection.\n* Type of the data warehouse to connect to.\n* A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n  ```\n  {\n     \"configuration\":{\n        \"accountName\":\"thoughtspot_partner\",\n        \"user\":\"tsadmin\",\n        \"password\":\"TestConn123\",\n        \"role\":\"sysadmin\",\n        \"warehouse\":\"MEDIUM_WH\"\n     },\n     \"authenticationType\": \"SERVICE_ACCOUNT\",\n     \"databases\": [\"DB1\", \"DB2\", \"AllDatatypes\"],\n     \"externalDatabases\":[\n        {\n           \"name\":\"AllDatatypes\",\n           \"isAutoCreated\":false,\n           \"schemas\":[\n              {\n                 \"name\":\"alldatatypes\",\n                 \"tables\":[\n                    {\n                       \"name\":\"allDatatypes\",\n                       \"type\":\"TABLE\",\n                       \"description\":\"\",\n                       \"selected\":true,\n                       \"linked\":true,\n                       \"columns\":[\n                          {\n                             \"name\":\"CNUMBER\",\n                             \"type\":\"INT64\",\n                             \"canImport\":true,\n                             \"selected\":true,\n                             \"isLinkedActive\":true,\n                             \"isImported\":false,\n                             \"tableName\":\"allDatatypes\",\n                             \"schemaName\":\"alldatatypes\",\n                             \"dbName\":\"AllDatatypes\"\n                          },\n                          {\n                             \"name\":\"CDECIMAL\",\n                             \"type\":\"INT64\",\n                             \"canImport\":true,\n                             \"selected\":true,\n                             \"isLinkedActive\":true,\n                             \"isImported\":false,\n                             \"tableName\":\"allDatatypes\",\n                             \"schemaName\":\"alldatatypes\",\n                             \"dbName\":\"AllDatatypes\"\n                          }\n                       ]\n                    }\n                 ]\n              }\n           ]\n        }\n     ]\n  }\n  ```\n2. Set `validate` to `true`.\n\n**NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\nThe optional `databases` property in `data_warehouse_config` accepts a list of database names. When specified, ThoughtSpot persists this list on the connection and uses it to scope metadata fetching to only the specified databases in subsequent table add and remove operations. If omitted, all databases in the data warehouse are accessible for metadata operations.\n\nThe `databases` and `externalDatabases` serve different purposes. `databases` is a flat list of database names that controls which databases are scanned during metadata operations. `externalDatabases` defines the full table hierarchy and determines which tables are linked into ThoughtSpot.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Connection to the datasource successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectionResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/connection/delete:
    post:
      operationId: deleteConnection
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Delete Connection V2](#/http/api-endpoints/connections/delete-connection-v2) endpoint to delete your connection objects.  \n\n#### Usage guidelines\n\nDeletes a connection object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\n\n\n#### Endpoint URL\n"
      deprecated: true
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConnectionRequest'
        required: true
      parameters: []
      responses:
        '204':
          description: Connection successfully deleted.
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/connection/search:
    post:
      operationId: searchConnection
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nGets connection objects.\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n- To get a list of all connections available in the ThoughtSpot system, send the API request without any attributes in the request body.\n- To get the connection objects for a specific type of data warehouse, specify the type in `data_warehouse_types`.\n- To fetch details of a connection object, specify the connection object GUID or name. The `name_pattern` attribute allows passing partial text with `%` for a wildcard match.\n- To get details of the database, schemas, tables, or columns from a data connection object, specify `data_warehouse_object_type`.\n- To get a specific database, schema, table, or column from a connection object, define the object type in `data_warehouse_object_type` and object properties in the `data_warehouse_objects` array. For example, to search for a column, you must pass the database, schema, and table names in the API request.\n  Note that in the following example, object properties are set in a hierarchical order (`database` > `schema` > `table` > `column`).\n\n```\n{\n  \"connections\": [\n    {\n      \"identifier\": \"b9d1f2ef-fa65-4a4b-994e-30fa2d57b0c2\",\n      \"data_warehouse_objects\": [\n        {\n          \"database\": \"NEBULADEV\",\n          \"schema\": \"INFORMATION_SCHEMA\",\n          \"table\": \"APPLICABLE_ROLES\",\n          \"column\": \"ROLE_NAME\"\n        }\n      ]\n    }\n  ],\n  \"data_warehouse_object_type\": \"COLUMN\"\n}\n```\n\n- To fetch data by `configuration`, specify `data_warehouse_object_type`. For example, to fetch columns from the `DEVELOPMENT` database, specify the `data_warehouse_object_type` as `DATABASE` and define the `configuration` string as `{\"database\":\"DEVELOPMENT\"}`. To get column data for a specific table, specify the table, for example,`{\"database\":\"RETAILAPPAREL\",\"table\":\"PIPES\"}`.\n- To query connections by `authentication_type`, specify `data_warehouse_object_type`. Supported values for `authentication_type` are:\n  - `SERVICE_ACCOUNT`: For connections that require service account credentials to authenticate to the Cloud Data Warehouse and fetch data.\n  - `OAUTH`: For connections that require OAuth credentials to authenticate to the Cloud Data Warehouse and fetch data. Teradata, Oracle, and Presto Cloud Data Warehouses do not support the OAuth authentication type.\n  - `IAM`: For connections that have the IAM OAuth set up. This authentication type is supported on Amazon Redshift connections only.\n  - `EXTOAUTH`: For connections that have External OAuth set up. ThoughtSpot supports external [OAuth with Microsoft Azure Active Directory (AD)](https://docs.thoughtspot.com/cloud/latest/ connections-snowflake-azure-ad-oauth) and [Okta for Snowflake data connections](https://docs.thoughtspot.com/cloud/latest/connections-snowflake-okta-oauth).\n  - `KEY_PAIR`: For connections that require Key Pair account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n  - `OAUTH_WITH_PKCE`: For connections that require OAuth with PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake, Starburst, Databricks, Denodo  connections only.\n  - `EXTOAUTH_WITH_PKCE`: For connections that require External OAuth With PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n  - `OAUTH_WITH_PEZ`: For connections that require OAuth With PEZ account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Amazon Redshift connections only.\n  - `OAUTH_WITH_SERVICE_PRINCIPAL`: For connections that require OAuth With Service Principal account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n  - `PERSONAL_ACCESS_TOKEN`: For connections that require Personal Access Token account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n  - `OAUTH_CLIENT_CREDENTIALS`: For connections that require OAuth Client Credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n- To include more details about connection objects in the API response, set `include_details` to `true`.\n- You can also sort the output by field names and filter connections by tags.\n\n**NOTE**: In addition to the connection GUID and name, the `identifier` field on each entry in `connections` accepts a Custom object ID if one is configured for the connection. The response also includes the `obj_id` field for each connection that has one set.\n\n**NOTE**: When filtering connection records by parameters other than `data_warehouse_types` or `tag_identifiers`, ensure that you set `record_size` to `-1` and `record_offset` to `0` for precise results.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchConnectionRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: List of connections to the datasource.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SearchConnectionResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/connection/update:
    post:
      operationId: updateConnection
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Update connection V2](#/http/api-endpoints/connections/update-connection-v2) endpoint to update your connection objects.\n\n#### Usage guidelines\n\nUpdates a connection object.  \n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n   a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n   b. Set `validate` to `true`.\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n\n\n\n#### Endpoint URL\n"
      deprecated: true
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionRequest'
        required: true
      parameters: []
      responses:
        '204':
          description: Connection successfully updated.
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/system/config-overrides:
    get:
      operationId: getSystemOverrideInfo
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nGets a list of configuration overrides applied on the cluster.  \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\nThis API does not require any parameters to be passed in the request.  \n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      parameters: []
      responses:
        '200':
          description: Cluster configuration which can be overridden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemOverrideInfo'
              examples:
                example_1:
                  description: System configuration overrides. The config_override_info field is a free-form JSON object whose keys are camelCase internal configuration property identifiers as returned by the server.
                  value:
                    config_override_info:
                      maxTableRowsPerPage: 500
                      enableCustomCalendar: true
                      allowMultipleOrgs: true
                      sessionTimeout: 3600
                example_2:
                  description: No configuration overrides applied
                  value:
                    config_override_info: {}
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized_access:
                  summary: Unauthorized access
                  value:
                    error:
                      message:
                        code: 10097
                        incident_id_guid: b2c3d4e5-f678-9012-bcde-f23456789012
                        trace_id_guid: b2c3d4e5-f678-9012-bcde-f23456789012
                        debug: Authentication required to retrieve system configuration overrides.
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden_access:
                  summary: Forbidden access
                  value:
                    error:
                      message:
                        code: 10023
                        incident_id_guid: c3d4e5f6-7890-1234-cdef-345678901234
                        trace_id_guid: c3d4e5f6-7890-1234-cdef-345678901234
                        debug: ADMINISTRATION privilege required to retrieve system configuration overrides.
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unexpected_error:
                  summary: Unexpected error
                  value:
                    error:
                      message:
                        code: 10038
                        incident_id_guid: d4e5f678-9012-3456-defa-456789012345
                        trace_id_guid: d4e5f678-9012-3456-defa-456789012345
                        debug: Unexpected server error while retrieving system configuration overrides.
  /api/rest/2.0/system/config-update:
    post:
      operationId: updateSystemConfig
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nUpdates the current configuration of the cluster. You must send the configuration data in JSON format.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSystemConfigRequest'
        required: true
      parameters: []
      responses:
        '204':
          description: Configuration successfully updated.
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_request:
                  summary: Invalid request
                  value:
                    error:
                      message:
                        code: 10002
                        incident_id_guid: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                        trace_id_guid: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                        debug: The configuration JSON contains an unknown or unsupported key.
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unauthorized_access:
                  summary: Unauthorized access
                  value:
                    error:
                      message:
                        code: 10097
                        incident_id_guid: b2c3d4e5-f678-9012-bcde-f23456789012
                        trace_id_guid: b2c3d4e5-f678-9012-bcde-f23456789012
                        debug: Authentication required to update system configuration.
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                forbidden_access:
                  summary: Forbidden access
                  value:
                    error:
                      message:
                        code: 10023
                        incident_id_guid: c3d4e5f6-7890-1234-cdef-345678901234
                        trace_id_guid: c3d4e5f6-7890-1234-cdef-345678901234
                        debug: ADMINISTRATION privilege required to update system configuration.
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                unexpected_error:
                  summary: Unexpected error
                  value:
                    error:
                      message:
                        code: 10038
                        incident_id_guid: d4e5f678-9012-3456-defa-456789012345
                        trace_id_guid: d4e5f678-9012-3456-defa-456789012345
                        debug: Unexpected server error while updating system configuration.
  /api/rest/2.0/vcs/git/branches/commit:
    post:
      operationId: commitBranch
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nCommits TML files of metadata objects to the Git branch configured on your instance.\n\nRequires at least edit access to objects used in the commit operation.\n\nBefore using this endpoint to push your commits:\n\n* Enable Git integration on your instance.\n* Make sure the Git repository and branch details are configured on your instance.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommitBranchRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Successfully committed the metadata objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommitResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/config/create:
    post:
      operationId: createConfig
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nAllows you to connect a ThoughtSpot instance to a Git repository.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\nYou can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository.\n\nBefore using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites:\n\n* You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\n\n* Your access token has `repo` scope that grants full access to public and private repositories.\n* Your Git repository has a branch that can be configured as a default branch in ThoughtSpot.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration).\n\n**Note**: ThoughtSpot supports only GitHub / itHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConfigRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Successfully configured local repository
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepoConfigObject'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/config/delete:
    post:
      operationId: deleteConfig
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nDeletes Git repository configuration from your ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConfigRequest'
        required: true
      parameters: []
      responses:
        '204':
          description: Successfully deleted local repository configuration
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/commits/deploy:
    post:
      operationId: deployCommit
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nAllows you to deploy a commit and publish TML content to your ThoughtSpot instance.\n\nRequires at least edit access to the objects used in the deploy operation.\n\nThe API deploys the head of the branch unless a `commit_id` is specified in the API request. If the branch name is not defined in the request, the default branch is considered for deploying commits.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeployCommitRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Successfully deployed the changes
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeployResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/commits/{commit_id}/revert:
    post:
      operationId: revertCommit
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nReverts TML objects to a previous commit specified in the API request.\n\nRequires at least edit access to objects.\n\nIn the API request, specify the `commit_id`. If the branch name is not specified in the request, the API will consider the default branch configured on your instance.\n\nBy default, the API reverts all objects. If the revert operation fails for one of the objects provided in the commit, the API returns an error and does not revert any object.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevertCommitRequest'
        required: true
      parameters:
      - in: path
        name: commit_id
        required: true
        schema:
          type: string
        description: Commit id to which the object should be reverted
      responses:
        '200':
          description: Reverted the object to the commit point specified
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevertResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/commits/search:
    post:
      operationId: searchCommits
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nGets a list of commits for a given metadata object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchCommitsRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Commit history of the metadata object
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CommitHistoryResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/config/search:
    post:
      operationId: searchConfig
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nGets Git repository connections configured on the ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchConfigRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Details of local repository configuration
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RepoConfigObject'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/config/update:
    post:
      operationId: updateConfig
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nUpdates Git repository configuration settings.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConfigRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: Successfully updated local repository configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepoConfigObject'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/rest/2.0/vcs/git/branches/validate:
    post:
      operationId: validateMerge
      description: "\n <span class=\"since-beta-tag\">Version: 9.2.0.cl or later</span>\n\nValidates the content of your source branch against the objects in your destination environment.\n\nBefore merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n"
      tags:
      - 9.2.0.cl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateMergeRequest'
        required: true
      parameters: []
      responses:
        '200':
          description: validation done successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeployResponse'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CommitBranchRequest:
      type: object
      properties:
        metadata:
          description: Metadata objects.
          type: array
          items:
            $ref: '#/components/schemas/MetadataObject'
        delete_aware:
          description: Delete the tml files from version control repo if it does not exist in the ThoughSpot instance
          default: true
          type: boolean
          nullable: true
        branch_name:
          description: "   Name of the remote branch where object should be pushed\n   \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered."
          type: string
        comment:
          description: Comment to be added to the commit
          type: string
      required:
      - metadata
      - comment
    RepoConfigObject:
      type: object
      properties:
        repository_url:
          type: string
          description: Remote repository URL configured
          nullable: true
        username:
          type: string
          description: Username to authenticate connection to the version control system
          nullable: true
        commit_branch_name:
          type: string
          description: Name of the remote branch where objects from this Thoughtspot instance will be versioned.
          nullable: true
        branches:
          type: array
          items:
            type: string
          description: Branches that have been pulled in local repository
          nullable: true
        enable_guid_mapping:
          type: boolean
          description: Maintain mapping of guid for the deployment to an instance
          nullable: true
        configuration_branch_name:
          type: string
          description: Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.
          nullable: true
        org:
          $ref: '#/components/schemas/Org'
          description: Details of the Org
          nullable: true
    SortOptionInput:
      type: object
      properties:
        field_name:
          type: string
          enum:
          - NAME
          - DISPLAY_NAME
          - AUTHOR
          - CREATED
          - MODIFIED
          - LAST_ACCESSED
          - SYNCED
          - VIEWS
          - USER_STATE
          - ROW_COUNT
          description: Name of the field to apply the sort on.
          nullable: true
        order:
          type: string
          enum:
          - ASC
          - DESC
          description: 'Sort order : ASC(Ascending) or DESC(Descending).'
          nullable: true
    SearchConfigRequest:
      type: object
      properties:
        org_identifiers:
          description: "   Applicable when Orgs is enabled in the cluster\n   \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n   \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to  <br/>  <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>"
          type: array
          items:
            type: string
    DeleteConfigRequest:
      type: object
      properties:
        cluster_level:
          description: "   Applicable when Orgs is enabled in the cluster\n   \n\nIndicator to consider cluster level or org level config. Set it to false to delete configuration from current org. If set to true, then the configuration at cluster level and orgs that inherited the configuration from cluster level will be deleted.  <br/>  <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>"
          type: boolean
          nullable: true
    UpdateConfigRequest:
      type: object
      properties:
        username:
          description: Username to authenticate connection to version control system
          type: string
        access_token:
          description: Access token corresponding to the user to authenticate connection to version control system
          type: string
        org_identifier:
          description: "   Applicable when Orgs is enabled in the cluster\n   \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n   \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to  <br/>  <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>"
          type: string
        branch_names:
          description: List the remote branches to configure. Example:[development, production]
          type: array
          items:
            type: string
        commit_branch_name:
          description: 'Name of the remote branch where objects from this Thoughtspot instance will be versioned. <br/>  <span class="since-beta-tag">Version: 9.7.0.cl or later</span>'
          type: string
        enable_guid_mapping:
          description: 'Maintain mapping of guid for the deployment to an instance <br/>  <span class="since-beta-tag">Version: 9.4.0.cl or later</span>'
          type: boolean
          nullable: true
        configuration_branch_name:
          description: 'Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained. <br/>  <span class="since-beta-tag">Version: 9.7.0.cl or later</span>'
          type: string
    RevertCommitRequest:
      type: object
      properties:
        metadata:
          description: Metadata objects.
          type: array
          items:
            $ref: '#/components/schemas/MetadataObject'
        branch_name:
          description: "   Name of the branch where the reverted version should be committed\n   \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered."
          type: string
        revert_policy:
          description: 'Policy to apply when reverting a commit. Valid values: [ALL_OR_NONE, PARTIAL]'
          default: ALL_OR_NONE
          type: string
          enum:
          - ALL_OR_NONE
          - PARTIAL
    ConnectionInput:
      type: object
      properties:
        identifier:
          type: string
          description: Unique ID or name of the connection.
          nullable: true
        name_pattern:
          type: string
          description: A pattern to match case-insensitive name of the connection object. User `%` for a wildcard match.
          nullable: true
        data_warehouse_objects:
          type: array
          items:
            $ref: '#/components/schemas/DataWarehouseObjectInput'
          description: Filter options for databases, schemas, tables and columns.
          nullable: true
    ValidateMergeRequest:
      type: object
      properties:
        source_branch_name:
          description: Name of the branch from which changes need to be picked for validation
          type: string
        target_branch_name:
          description: Name of the branch where files will be merged
          type: string
      required:
      - source_branch_name
      - target_branch_name
    CreateConnectionResponse:
      type: object
      required:
      - id
      - name
      - data_warehouse_type
      properties:
        id:
          type: string
          description: ID of the connection created.
        name:
          type: string
          description: Name of the connection.
        data_warehouse_type:
          type: string
          enum:
          - SNOWFLAKE
          - AMAZON_REDSHIFT
          - GOOGLE_BIGQUERY
          - AZURE_SYNAPSE
          - TERADATA
          - SAP_HANA
          - STARBURST
          - ORACLE_ADW
          - DATABRICKS
          - DENODO
          - DREMIO
          - TRINO
          - PRESTO
          - POSTGRES
          - SQLSERVER
          - MYSQL
          - GENERIC_JDBC
          - AMAZON_RDS_POSTGRESQL
          - AMAZON_AURORA_POSTGRESQL
          - AMAZON_RDS_MYSQL
          - AMAZON_AURORA_MYSQL
          - LOOKER
          - AMAZON_ATHENA
          - SINGLESTORE
          - GCP_SQLSERVER
          - GCP_ALLOYDB_POSTGRESQL
          - GCP_POSTGRESQL
          - GCP_MYSQL
          - MODE
          - GOOGLE_SHEETS
          - FALCON
          - FALCON_ONPREM
          - CLICKHOUSE
          - IOMETE
          description: Type of data warehouse.
        details:
          type: object
          description: Details of the connection.
          nullable: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          nullable: true
    Database:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name of the database.
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/SchemaObject'
          description: Schemas of the database.
          nullable: true
        auto_created:
          type: boolean
          description: Determines if the object is auto created.
          nullable: true
    SystemOverrideInfo:
      type: object
      properties:
        config_override_info:
          type: object
          nullable: true
    DeployResponse:
      type: object
      properties:
        file_name:
          type: string
          description: Name of the file deployed
          nullable: true
        metadata_name:
          type: string
          description: Name of the metadata object
          nullable: true
        metadata_type:
          type: string
          description: Type of the metadata object
          nullable: true
        status_code:
          type: string
          description: Indicates the status of deployment for the file
          nullable: true
        status_message:
          type: string
          description: Any error or warning with the deployment
          nullable: true
    SearchCommitsRequest:
      type: object
      properties:
        metadata_identifier:
          description: Unique ID or name of the metadata.
          type: string
        metadata_type:
          description: Type of metadata.
          type: string
          enum:
          - LIVEBOARD
          - ANSWER
          - LOGICAL_TABLE
          - CUSTOM_ACTION
        branch_name:
          description: "   Name of the branch from which commit history needs to be displayed.\n   \n\nNote: If no branch_name is specified, then commits will be returned for the default branch for this configuration."
          type: string
        record_offset:
          description: "    Record offset point in the commit history to display the response.\n    \n\nNote: If no record offset is specified, the beginning of the record will be considered."
          type: integer
          format: int32
        record_size:
          description: "    Number of history records from record offset point to be displayed in the response.\n    \n\nNote: If no record size is specified, then all the records will be considered."
          type: integer
          format: int32
      required:
      - metadata_identifier
    CommitResponse:
      type: object
      properties:
        committer:
          $ref: '#/components/schemas/CommiterType'
          description: Repository user using which changes were committed
          nullable: true
        author:
          $ref: '#/components/schemas/AuthorType'
          description: Thoughtspot user who commits the changes
          nullable: true
        comment:
          type: string
          description: Comments associated with the commit
          nullable: true
        commit_time:
          type: string
          description: Time at which the changes were committed.
          nullable: true
        commit_id:
          type: string
          description: SHA id associated with the commit
          nullable: true
        branch:
          type: string
          description: Branch where changes were committed
          nullable: true
        committed_files:
          type: array
          items:
            $ref: '#/components/schemas/CommitFileType'
          description: Files that were pushed as part of this commit
          nullable: true
    RevertedMetadata:
      type: object
      required:
      - file_name
      - metadata_name
      - metadata_type
      - status_code
      - status_message
      properties:
        file_name:
          type: string
          description: Name of the file deployed
        metadata_name:
          type: string
          description: Name of the metadata object
        metadata_type:
          type: string
          description: Type of the metadata object
        status_code:
          type: string
          description: Indicates the status of deployment for the file
        status_message:
          type: string
          description: Any error or warning with the deployment
    Org:
      type: object
      required:
      - id
      - name
      properties:
        id:
          type: integer
          format: int32
          description: The ID of the object.
        name:
          type: string
          description: Name of the object.
      description: The current Org context of the user.
    CommitHistoryResponse:
      type: object
      required:
      - committer
      - author
      - comment
      - commit_time
      - commit_id
      - branch
      properties:
        committer:
          $ref: '#/components/schemas/CommiterType'
          description: Repository user using which changes were committed
        author:
          $ref: '#/components/schemas/AuthorType'
          description: Thoughtspot user who commits the changes
        comment:
          type: string
          description: Comments associated with the commit
        commit_time:
          type: string
          description: Time at which the changes were committed.
        commit_id:
          type: string
          description: SHA id associated with the commit
        branch:
          type: string
          description: Branch where changes were committed
    MetadataObject:
      type: object
      required:
      - identifier
      properties:
        identifier:
          type: string
          description: Unique ID or name of the metadata
        type:
          type: string
          enum:
          - LIVEBOARD
          - ANSWER
          - LOGICAL_TABLE
          - CUSTOM_ACTION
          description: "  Type of metadata.\n  \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier."
          nullable: true
    DeployCommitRequest:
      type: object
      properties:
        commit_id:
          description: "   Commit_id against which the files should be picked to deploy.\n   \n\nNote: If no commit_id is specified, then the head of the branch is considered."
          type: string
        branch_name:
          description: Name of the remote branch where changes should be picked
          type: string
        deploy_type:
          description: Indicates if all files or only modified file at specified commit point should be considered
          default: DELTA
          type: string
          enum:
          - FULL
          - DELTA
        deploy_policy:
          description: Define the policy to follow while importing TML in the ThoughtSpot environment. Use “ALL_OR_NONE” to cancel the deployment of all ThoughtSpot objects if at least one of them fails to import. Use “Partial” to import ThoughtSpot objects that validate successfully even if other objects in the same deploy operations fail to import.
          default: ALL_OR_NONE
          type: string
          enum:
          - ALL_OR_NONE
          - PARTIAL
          - VALIDATE_ONLY
      required:
      - branch_name
    UpdateConnectionRequest:
      type: object
      properties:
        connection_identifier:
          description: Unique ID or name of the connection.
          type: string
        name:
          description: Updated name of the connection.
          type: string
        description:
          description: Updated description of the connection.
          type: string
        data_warehouse_config:
          description: Configuration of the data warehouse in JSON.
          type: object
        validate:
          description: Indicates whether to validate the connection details.
          default: true
          type: boolean
          nullable: true
      required:
      - connection_identifier
    CommitFileType:
      type: object
      required:
      - file_name
      - status_code
      properties:
        file_name:
          type: string
          description: Name of the file deployed
        status_code:
          type: string
          description: Indicates the status of deployment for the file
        status_message:
          type: string
          description: Any error or warning with the deployment
          nullable: true
    DataWarehouseObjectInput:
      type: object
      properties:
        database:
          type: string
          description: Name of the database.
          nullable: true
        schema:
          type: string
          description: Name of the schema within the database.
          nullable: true
        table:
          type: string
          description: Name of the table within the schema.
          nullable: true
        column:
          type: string
          description: Name of the column within the table.
          nullable: true
    SchemaObject:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name of the schema.
        tables:
          type: array
          items:
            $ref: '#/components/schemas/Table'
          description: Tables in the schema.
          nullable: true
    SearchConnectionResponse:
      type: object
      required:
      - id
      - name
      - data_warehouse_type
      properties:
        id:
          type: string
          description: Unique ID of the connection.
        name:
          type: string
          description: Name of the connection.
        obj_id:
          type: string
          description: 'Custom object ID (obj_id) of the connection, if one is set. <br/>  <span class="since-beta-tag">Version: 26.9.0.cl or later</span>'
          nullable: true
        description:
          type: string
          description: Description of the connection.
          nullable: true
        data_warehouse_type:
          type: string
          enum:
          - SNOWFLAKE
          - AMAZON_REDSHIFT
          - GOOGLE_BIGQUERY
          - AZURE_SYNAPSE
          - TERADATA
          - SAP_HANA
          - STARBURST
          - ORACLE_ADW
          - DATABRICKS
          - DENODO
          - DREMIO
          - TRINO
          - PRESTO
          - POSTGRES
          - SQLSERVER
          - MYSQL
          - GENERIC_JDBC
          - AMAZON_RDS_POSTGRESQL
          - AMAZON_AURORA_POSTGRESQL
          - AMAZON_RDS_MYSQL
          - AMAZON_AURORA_MYSQL
          - LOOKER
          - AMAZON_ATHENA
          - SINGLESTORE
          - GCP_SQLSERVER
          - GCP_ALLOYDB_POSTGRESQL
          - GCP_POSTGRESQL
          - GCP_MYSQL
          - MODE
          - GOOGLE_SHEETS
          - FALCON
          - FALCON_ONPREM
          - CLICKHOUSE
          - IOMETE
          description: Type of data warehouse.
        data_warehouse_objects:
          $ref: '#/components/schemas/DataWarehouseObjects'
          description: List of Data warehouse objects
          nullable: true
        details:
          type: object
          description: Details of the connection.
          nullable: true
    UpdateSystemConfigRequest:
      type: object
      properties:
        configuration:
          description: Configuration JSON with the key-value pair of configuration attributes to be updated.
          type: object
      required:
      - configuration
    Column:
      type: object
      required:
      - name
      - data_type
      properties:
        name:
          type: string
          description: Name of the column
        data_type:
          type: string
          description: Data type of the column
        is_aggregate:
          type: string
          description: Determines if the column schema is an aggregate
          nullable: true
        can_import:
          type: boolean
          description: Determines if the column schema can be imported
          nullable: true
        selected:
          type: boolean
          description: Determines if the table is selected
          nullable: true
        is_linked_active:
          type: boolean
          description: Determines if the table is linked
          nullable: true
    RevertResponse:
      type: object
      properties:
        committer:
          $ref: '#/components/schemas/CommiterType'
          description: Repository user using which changes were committed
          nullable: true
        author:
          $ref: '#/components/schemas/AuthorType'
          description: Thoughtspot user who commits the changes
          nullable: true
        comment:
          type: string
          description: Comments associated with the commit
          nullable: true
        commit_time:
          type: string
          description: Time at which the changes were committed.
          nullable: true
        commit_id:
          type: string
          description: SHA id associated with the commit
          nullable: true
        branch:
          type: string
          description: Branch where changes were committed
          nullable: true
        committed_files:
          type: array
          items:
            $ref: '#/components/schemas/CommitFileType'
          description: Files that were pushed as part of this commit
          nullable: true
        reverted_metadata:
          type: array
          items:
            $ref: '#/components/schemas/RevertedMetadata'
          description: Metadata of reverted file of this commit
          nullable: true
    CreateConnectionRequest:
      type: object
      properties:
        name:
          description: Unique name for the connection.
          type: string
        description:
          description: Description of the connection.
          type: string
        data_warehouse_type:
          description: Type of the data warehouse.
          type: string
          enum:
          - SNOWFLAKE
          - AMAZON_REDSHIFT
          - GOOGLE_BIGQUERY
          - AZURE_SYNAPSE
          - TERADATA
          - SAP_HANA
          - STARBURST
          - ORACLE_ADW
          - DATABRICKS
          - DENODO
          - DREMIO
          - TRINO
          - PRESTO
          - POSTGRES
          - SQLSERVER
          - MYSQL
          - GENERIC_JDBC
          - AMAZON_RDS_POSTGRESQL
          - AMAZON_AURORA_POSTGRESQL
          - AMAZON_RDS_MYSQL
          - AMAZON_AURORA_MYSQL
          - LOOKER
          - AMAZON_ATHENA
          - SINGLESTORE
          - GCP_SQLSERVER
          - GCP_ALLOYDB_POSTGRESQL
          - GCP_POSTGRESQL
          - GCP_MYSQL
          - MODE
          - GOOGLE_SHEETS
          - FALCON
          - FALCON_ONPREM
          - CLICKHOUSE
          - IOMETE
        data_warehouse_config:
          description: Connection configuration attributes in JSON format. To create a connection with tables, include table attributes. See the documentation above for sample JSON.
          type: object
        validate:
          description: Validates the connection metadata if tables are included. If you are creating a connection without tables, specify `false`.
          default: true
          type: boolean
          nullable: true
      required:
      - name
      - data_warehouse_type
      - data_warehouse_config
    DataWarehouseObjects:
      type: object
      required:
      - databases
      properties:
        databases:
          type: array
          items:
            $ref: '#/components/schemas/Database'
          description: Databases of the connection.
    SearchConnectionRequest:
      type: object
      properties:
        connections:
          description: List of connections and name pattern
          type: array
          items:
            $ref: '#/components/schemas/ConnectionInput'
        data_warehouse_types:
          description: Array of types of data warehouse defined for the connection.
          type: array
          items:
            type: string
            enum:
            - SNOWFLAKE
            - AMAZON_REDSHIFT
            - GOOGLE_BIGQUERY
            - AZURE_SYNAPSE
            - TERADATA
            - SAP_HANA
            - STARBURST
            - ORACLE_ADW
            - DATABRICKS
            - DENODO
            - DREMIO
            - TRINO
            - PRESTO
            - POSTGRES
            - SQLSERVER
            - MYSQL
            - GENERIC_JDBC
            - AMAZON_RDS_POSTGRESQL
            - AMAZON_AURORA_POSTGRESQL
            - AMAZON_RDS_MYSQL
            - AMAZON_AURORA_MYSQL
            - LOOKER
            - AMAZON_ATHENA
            - SINGLESTORE
            - GCP_SQLSERVER
            - GCP_ALLOYDB_POSTGRESQL
            - GCP_POSTGRESQL
            - GCP_MYSQL
            - MODE
            - GOOGLE_SHEETS
            - FALCON
            - FALCON_ONPREM
            - CLICKHOUSE
            - IOMETE
        record_offset:
          description: The starting record number from where the records should be included.
          default: 0
          type: integer
          format: int32
        record_size:
          description: The number of records that should be included.
          default: 10
          type: integer
          format: int32
        tag_identifiers:
          description: Unique ID or name of tags.
          type: array
          items:
            type: string
        data_warehouse_object_type:
          description: Data warehouse object type.
          type: string
          enum:
          - DATABASE
          - SCHEMA
          - TABLE
          - COLUMN
        sort_options:
          description: Sort options.
          allOf:
          - $ref: '#/components/schemas/SortOptionInput'
        include_details:
          description: Indicates whether to include complete details of the connection objects.
          type: boolean
          nullable: true
        configuration:
          description: 'Configuration values. If empty we are fetching configuration from datasource based on given connection id. If required you can provide config details to fetch specific details. Example input: {}, {"warehouse":"SMALL_WH","database":"DEVELOPMENT"}. This is only applicable when data_warehouse_object_type is selected.'
          type: object
        authentication_type:
          description: List of authentication types to fetch data_ware_house_objects from external Data warehouse. This is only applicable when data_warehouse_object_type is selected.
          default: SERVICE_ACCOUNT
          type: string
          enum:
          - SERVICE_ACCOUNT
          - OAUTH
          - IAM
          - EXTOAUTH
          - OAUTH_WITH_SERVICE_PRINCIPAL
          - PERSONAL_ACCESS_TOKEN
          - KEY_PAIR
          - OAUTH_WITH_PKCE
          - EXTOAUTH_WITH_PKCE
          - OAUTH_WITH_PEZ
          - OAUTH_CLIENT_CREDENTIALS
          - OAUTH_CLIENT_CREDENTIALS_WITH_X509
        show_resolved_parameters:
          description: '<div><span class="since-beta-tag">Version: 10.9.0.cl or later</span></div>


            Indicates whether to show resolved parameterised values.'
          default: false
          type: boolean
          nullable: true
    Table:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name of the table.
        columns:
          type: array
          items:
            $ref: '#/components/schemas/Column'
          description: Columns of the table.
          nullable: true
        type:
          type: string
          description: Type of table. Either view or table
          nullable: true
        description:
          type: string
          description: Description of the table
          nullable: true
        selected:
          type: boolean
          description: Determines if the table is selected
          nullable: true
        linked:
          type: boolean
          description: Determines if the table is linked
          nullable: true
        relationships:
          type: array
          items:
            type: object
          description: List of relationships for the table
          nullable: true
    CommiterType:
      type: object
      properties:
        email:
          type: string
          description: Email id of the committer
          nullable: true
        username:
          type: string
          description: Username of the committer
          nullable: true
    AuthorType:
      type: object
      properties:
        email:
          type: string
          description: Email id of the committer
          nullable: true
        username:
          type: string
          description: Username of the committer
          nullable: true
    DeleteConnectionRequest:
      type: object
      properties:
        connection_identifier:
          description: Unique ID or name of the connection.
          type: string
      required:
      - connection_identifier
    CreateConfigRequest:
      type: object
      properties:
        repository_url:
          description: URL for connecting to remote repository
          type: string
        username:
          description: Username to authenticate connection to remote repository
          type: string
        access_token:
          description: Access token corresponding to the user to authenticate connection to remote repository
          type: string
        org_identifier:
          description: "   Applicable when Orgs is enabled in the cluster\n   \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n   \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to  <br/>  <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>"
          type: string
        branch_names:
          description: List the remote branches to configure. Example:[development, production]
          type: array
          items:
            type: string
        commit_branch_name:
          description: 'Name of the remote branch where objects from this Thoughtspot instance will be versioned. <br/>  <span class="since-beta-tag">Version: 9.7.0.cl or later</span>'
          type: string
        enable_guid_mapping:
          description: 'Maintain mapping of guid for the deployment to an instance <br/>  <span class="since-beta-tag">Version: 9.4.0.cl or later</span>'
          default: true
          type: boolean
          nullable: true
        configuration_branch_name:
          description: "   Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.\n   \n\nNote: If no branch name is specified, then by default, ts_config_files branch is considered. Ensure this branch exists before configuration. <br/>  <span class=\"since-beta-tag\">Version: 9.7.0.cl or later</span>"
          type: string
      required:
      - repository_url
      - username
      - access_token
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-roles:
- name: 26.2.0.cl
  id: 26.2.0.cl
  tags:
  - 26.2.0.cl
  description: Roles for version 26.2.0.cl
- name: 10.4.0.cl
  id: 10.4.0.cl
  tags:
  - 10.4.0.cl
  description: Roles for version 10.4.0.cl
- name: 26.7.0.cl
  id: 26.7.0.cl
  tags:
  - 26.7.0.cl
  description: Roles for version 26.7.0.cl
- name: 26.8.0.cl
  id: 26.8.0.cl
  tags:
  - 26.8.0.cl
  description: Roles for version 26.8.0.cl
- name: 26.6.0.cl
  id: 26.6.0.cl
  tags:
  - 26.6.0.cl
  description: Roles for version 26.6.0.cl
- name: 10.15.0.cl
  id: 10.15.0.cl
  tags:
  - 10.15.0.cl
  description: Roles for version 10.15.0.cl
- name: 10.13.0.cl
  id: 10.13.0.cl
  tags:
  - 10.13.0.cl
  description: Roles for version 10.13.0.cl
- name: 26.9.0.cl
  id: 26.9.0.cl
  tags:
  - 26.9.0.cl
  description: Roles for version 26.9.0.cl
- name: 10.7.0.cl
  id: 10.7.0.cl
  tags:
  - 10.7.0.cl
  description: Roles for version 10.7.0.cl
- name: 26.5.0.cl
  id: 26.5.0.cl
  tags:
  - 26.5.0.cl
  description: Roles for version 26.5.0.cl
- name: 9.0.0.cl
  id: 9.0.0.cl
  tags:
  - 9.0.0.cl
  description: Roles for version 9.0.0.cl
- name: 9.4.0.cl
  id: 9.4.0.cl
  tags:
  - 9.4.0.cl
  description: Roles for version 9.4.0.cl
- name: 9.12.0.cl
  id: 9.12.0.cl
  tags:
  - 9.12.0.cl
  description: Roles for version 9.12.0.cl
- name: 26.4.0.cl
  id: 26.4.0.cl
  tags:
  - 26.4.0.cl
  description: Roles for version 26.4.0.cl
- name: 10.12.0.cl
  id: 10.12.0.cl
  tags:
  - 10.12.0.cl
  description: Roles for version 10.12.0.cl
- name: 9.2.0.cl
  id: 9.2.0.cl
  tags:
  - 9.2.0.cl
  description: Roles for version 9.2.0.cl
- name: 9.9.0.cl
  id: 9.9.0.cl
  tags:
  - 9.9.0.cl
  description: Roles for version 9.9.0.cl
- name: 9.6.0.cl
  id: 9.6.0.cl
  tags:
  - 9.6.0.cl
  description: Roles for version 9.6.0.cl
- name: 10.10.0.cl
  id: 10.10.0.cl
  tags:
  - 10.10.0.cl
  description: Roles for version 10.10.0.cl
- name: 10.6.0.cl
  id: 10.6.0.cl
  tags:
  - 10.6.0.cl
  description: Roles for version 10.6.0.cl
- name: 10.3.0.cl
  id: 10.3.0.cl
  tags:
  - 10.3.0.cl
  description: Roles for version 10.3.0.cl
- name: 10.1.0.cl
  id: 10.1.0.cl
  tags:
  - 10.1.0.cl
  description: Roles for version 10.1.0.cl
- name: 10.9.0.cl
  id: 10.9.0.cl
  tags:
  - 10.9.0.cl
  description: Roles for version 10.9.0.cl
- name: 10.8.0.cl
  id: 10.8.0.cl
  tags:
  - 10.8.0.cl
  description: Roles for version 10.8.0.cl
- name: 9.5.0.cl
  id: 9.5.0.cl
  tags:
  - 9.5.0.cl
  description: Roles for version 9.5.0.cl
- name: 26.3.0.cl
  id: 26.3.0.cl
  tags:
  - 26.3.0.cl
  description: Roles for version 26.3.0.cl
- name: 10.14.0.cl
  id: 10.14.0.cl
  tags:
  - 10.14.0.cl
  description: Roles for version 10.14.0.cl
- name: 9.7.0.cl
  id: 9.7.0.cl
  tags:
  - 9.7.0.cl
  description: Roles for version 9.7.0.cl