diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index a147ae81..67590810 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -37,6 +37,14 @@ ], "description": "Roles for version 9.2.0.cl" }, + { + "name": "10.0.0.cl", + "id": "10.0.0.cl", + "tags": [ + "10.0.0.cl" + ], + "description": "Roles for version 10.0.0.cl" + }, { "name": "9.9.0.cl", "id": "9.9.0.cl", @@ -268,7 +276,6 @@ "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", - "ENABLESPOTAPPCREATION", "PREVIEW_THOUGHTSPOT_SAGE", "APPLICATION_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", @@ -278,7 +285,10 @@ "BILLING_INFO_ADMINISTRATION", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } }, @@ -977,7 +987,6 @@ "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", - "ENABLESPOTAPPCREATION", "PREVIEW_THOUGHTSPOT_SAGE", "APPLICATION_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", @@ -987,7 +996,10 @@ "BILLING_INFO_ADMINISTRATION", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } }, @@ -2035,6 +2047,7 @@ "default": "COMPACT", "type": "string", "enum": [ + "FULL", "COMPACT" ] }, @@ -2161,6 +2174,7 @@ "default": "COMPACT", "type": "string", "enum": [ + "FULL", "COMPACT" ] }, @@ -2275,6 +2289,7 @@ "default": "COMPACT", "type": "string", "enum": [ + "FULL", "COMPACT" ] }, @@ -2398,7 +2413,7 @@ "format": "float" }, "get_all_logs": { - "description": "Fetch all the logs. This is available from 9.11.0.cl", + "description": "Fetch all the logs. This is available from 9.10.5.cl", "default": true, "type": "boolean", "nullable": true @@ -2579,7 +2594,8 @@ "enum": [ "LIVEBOARD", "ANSWER", - "LOGICAL_TABLE" + "LOGICAL_TABLE", + "CUSTOM_ACTION" ] }, "branch_name": { @@ -2719,7 +2735,7 @@ "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", - "RDBMS_LOOKER_ML" + "GOOGLE_SHEETS" ] } }, @@ -2916,7 +2932,12 @@ "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_CONFIGURE_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CONTROL_TRUSTED_AUTH", + "CAN_CREATE_CATALOG", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } }, @@ -3275,8 +3296,7 @@ "format": "int32" }, "org_id": { - "description": "ID of the Org context to log in to. If Org ID is not specified, the user will be logged in to the Org context of their previous login session.", - "default": 0, + "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.", "type": "integer", "format": "int32" }, @@ -3302,12 +3322,12 @@ } }, "jwt_user_options": { - "description": " JWT user options to create a JWT token given the payload.\n \n\n*Deprecated from 9.11.0.cl : Replaced by user_parameters* ", + "description": " JWT user options to create a JWT token given the payload.\n \n\n*Deprecated from 9.10.5.cl : Replaced by user_parameters* ", "$ref": "#/components/schemas/JWT_User_Options", "deprecated": true }, "user_parameters": { - "description": "User Parameters to be set via JWT Token.
Version: 9.11.0.cl or later", + "description": "User Parameters to be set via JWT Token.
Version: 9.10.5.cl or later", "$ref": "#/components/schemas/User_Parameter_Options" } }, @@ -3410,8 +3430,7 @@ "format": "int32" }, "org_id": { - "description": "ID of the Org context to log in to. If the Org ID is not specified, the user will be logged in to the Org context of their previous login session.", - "default": 0, + "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.", "type": "integer", "format": "int32" }, @@ -3437,12 +3456,12 @@ } }, "jwt_user_options": { - "description": " JWT user options to create a JWT token given the payload.\n \n\n*Deprecated from 9.11.0.cl : Replaced by user_parameters* ", + "description": " JWT user options to create a JWT token given the payload.\n \n\n*Deprecated from 9.10.5.cl : Replaced by user_parameters* ", "$ref": "#/components/schemas/JWT_User_Options_Full", "deprecated": true }, "user_parameters": { - "description": "User Parameters to be set via JWT Token.
Version: 9.11.0.cl or later", + "description": "User Parameters to be set via JWT Token.
Version: 9.10.5.cl or later", "$ref": "#/components/schemas/User_Parameter_Options" } }, @@ -5560,9 +5579,11 @@ "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", - "ENABLESPOTAPPCREATION", "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE" + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } }, @@ -5727,9 +5748,11 @@ "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", - "ENABLESPOTAPPCREATION", "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE" + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } }, @@ -6040,6 +6063,12 @@ "default": false, "type": "boolean", "nullable": true + }, + "all_orgs_context": { + "description": "If import is happening from all orgs context.", + "default": false, + "type": "boolean", + "nullable": true } }, "required": [ @@ -6151,10 +6180,11 @@ ] }, "export_schema_version": { - "description": "Indicates whether to export worksheet TML in V1 or V2 version.", - "default": "V1", + "description": "Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.", + "default": "DEFAULT", "type": "string", "enum": [ + "DEFAULT", "V1", "V2" ] @@ -6170,6 +6200,12 @@ "default": false, "type": "boolean", "nullable": true + }, + "all_orgs_override": { + "description": "Indicates whether to export is happening from all orgs context.", + "default": false, + "type": "boolean", + "nullable": true } }, "required": [ @@ -6433,12 +6469,19 @@ ] }, "metadata_identifiers": { - "description": "Unique ID or name of metadata objects. Note: All the identifiers should belong to same metadata_type", + "description": "Unique ID or name of metadata objects. Note: All the names should belong to same metadata_type", "type": "array", "items": { "type": "string" } }, + "metadata": { + "description": "Metadata details for sharing objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShareMetadataTypeInput" + } + }, "permissions": { "description": "Permission details for sharing the objects.", "type": "array", @@ -6484,7 +6527,6 @@ } }, "required": [ - "metadata_identifiers", "permissions", "emails", "message" @@ -7297,7 +7339,7 @@ "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", - "RDBMS_LOOKER_ML" + "GOOGLE_SHEETS" ] }, "data_warehouse_config": { @@ -7451,6 +7493,72 @@ } } }, + "/api/rest/2.0/connections/delete/{connection_identifier}": { + "post": { + "operationId": "deleteConnectionV2", + "description": "\n Version: 10.0.0.cl or later\n\nDeletes a connection object.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", + "tags": [ + "Connections", + "10.0.0.cl" + ], + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection." + } + ], + "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/update": { "post": { "operationId": "updateConnection", @@ -7544,6 +7652,102 @@ } } }, + "/api/rest/2.0/connections/update/{connection_identifier}": { + "post": { + "operationId": "updateConnectionV2", + "description": "\n Version: 10.0.0.cl or later\n\nUpdates a connection object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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", + "tags": [ + "Connections", + "10.0.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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": true + }, + "parameters": [ + { + "in": "path", + "name": "connection_identifier", + "required": true, + "schema": { + "type": "string" + }, + "description": "Unique ID or name of the connection." + } + ], + "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/connections/fetch-connection-diff-status/{connection_identifier}": { "post": { "operationId": "fetchConnectionDiffStatus", @@ -7738,7 +7942,11 @@ "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CAN_CREATE_CATALOG", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } } @@ -7858,7 +8066,11 @@ "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CAN_CREATE_CATALOG", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] } } @@ -8041,7 +8253,8 @@ "type": "string", "enum": [ "CSV", - "PDF" + "PDF", + "XLSX" ] }, "liveboard_options": { @@ -8980,7 +9193,8 @@ "type": "string", "enum": [ "CSV", - "PDF" + "PDF", + "XLSX" ] }, "liveboard_options": { @@ -12151,7 +12365,7 @@ "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", - "RDBMS_LOOKER_ML" + "GOOGLE_SHEETS" ], "description": "Type of data warehouse." }, @@ -12377,7 +12591,12 @@ "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_CONFIGURE_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CONTROL_TRUSTED_AUTH", + "CAN_CREATE_CATALOG", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] }, "description": "Privileges granted to the role." @@ -12774,6 +12993,11 @@ "items": { "$ref": "#/components/schemas/User_Parameters" } + }, + "compress": { + "type": "boolean", + "default": false, + "description": " Version: 9.12.0.cl or later" } }, "description": "User properties runtime_filters,runtime_sorts,parameters applicable to LOGICAL_TABLE(Worksheet)" @@ -12842,7 +13066,7 @@ "persist": { "type": "boolean", "default": false, - "description": "Flag to persist the runtime filters." + "description": "Flag to persist the runtime filters.
Version: 9.12.0.cl or later" }, "objects": { "type": "array", @@ -12872,7 +13096,7 @@ "persist": { "type": "boolean", "default": false, - "description": "Flag to persist the runtime sorts." + "description": "Flag to persist the runtime sorts.
Version: 9.12.0.cl or later" }, "objects": { "type": "array", @@ -12905,7 +13129,7 @@ "persist": { "type": "boolean", "default": false, - "description": "Flag to persist the parameters." + "description": "Flag to persist the parameters.
Version: 9.12.0.cl or later" }, "objects": { "type": "array", @@ -13239,9 +13463,11 @@ "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", - "ENABLESPOTAPPCREATION", "LIVEBOARD_VERIFIER", - "PREVIEW_THOUGHTSPOT_SAGE" + "PREVIEW_THOUGHTSPOT_SAGE", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] }, "description": "Privileges that will be assigned to the group." @@ -13379,6 +13605,27 @@ }, "description": "MetadataType InputType used in Author API's" }, + "ShareMetadataTypeInput": { + "type": "object", + "required": [ + "identifier" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "LIVEBOARD", + "ANSWER", + "LOGICAL_TABLE" + ], + "description": "Type of metadata (Optional when given identifier is ID)." + }, + "identifier": { + "type": "string", + "description": "Unique ID or name of the metadata object." + } + } + }, "SharePermissionsInput": { "type": "object", "required": [ @@ -13416,7 +13663,8 @@ "enum": [ "LIVEBOARD", "ANSWER", - "LOGICAL_TABLE" + "LOGICAL_TABLE", + "CUSTOM_ACTION" ], "description": "Type of metadata." } @@ -13627,7 +13875,7 @@ "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", - "RDBMS_LOOKER_ML" + "GOOGLE_SHEETS" ], "description": "Type of data warehouse." }, @@ -13715,7 +13963,11 @@ "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", - "CAN_MANAGE_WORKSHEET_VIEWS_TABLES" + "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", + "CAN_MANAGE_VERSION_CONTROL", + "THIRDPARTY_ANALYSIS", + "CAN_CREATE_CATALOG", + "BLOCK_NON_EMBED_FULL_APP_ACCESS" ] }, "description": "Privileges granted to the role."