Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update openapiSpecv3-2_0.json #182

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Update openapiSpecv3-2_0.json #182

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d2bbf54
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 19, 2024
a402d89
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 19, 2024
f48b4a6
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 19, 2024
2b5de00
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 19, 2024
594cc70
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 25, 2024
8996e8d
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 25, 2024
866f1b5
Update openapiSpecv3-2_0.json
ayush-dixit-ts Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
311 changes: 293 additions & 18 deletions api-spec/openapiSpecv3-2_0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,14 @@
],
"description": "Roles for version 10.3.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": "9.9.0.cl",
"id": "9.9.0.cl",
Expand Down Expand Up @@ -3061,7 +3069,7 @@
"/api/rest/2.0/roles/search": {
"post": {
"operationId": "searchRoles",
"description": "\n <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nGets a list of Role objects from the ThoughtSpot system.\n\nAvailable if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\nTo get details of a specific Role object, specify the GUID or name. You can also filter the API response based on user group and Org identifiers, privileges assigned to the Role, and deprecation status.\n\n\n\n\n#### Endpoint URL\n",
"description": "\nGets Roles configured on a ThoughtSpot instance.\nRequires cluster Administration, Role Administration or\nGroup Administration privileges. <br/> <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nGets a list of Role objects from the ThoughtSpot system.\n\nAvailable if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\nTo get details of a specific Role object, specify the GUID or name. You can also filter the API response based on user group and Org identifiers, privileges assigned to the Role, and deprecation status.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
Expand Down Expand Up @@ -4031,12 +4039,6 @@
"items": {
"$ref": "#/components/schemas/Group_Object"
}
},
"auto_create": {
"description": " Creates a new user if the specified username does not exist in ThoughtSpot. To provision a user just-in-time (JIT), set this attribute to true.\n \n\nNote: For JIT provisioning of a user, the secret_key is required. <br/> <span class=\"since-beta-tag\">Version: 10.5.0.cl or later</span>",
"default": true,
"type": "boolean",
"nullable": true
}
},
"required": [
Expand Down Expand Up @@ -7113,6 +7115,82 @@
}
}
},
"/api/rest/2.0/metadata/worksheets/convert": {
"post": {
"operationId": "convertWorksheetToModel",
"description": "\nConvert worksheets to models <br/> <span class=\"since-beta-tag\">Version: 10.6.0.cl or later</span>\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **identifiers** \n - **Description:** A comma-separated list of GUIDs (Globally Unique Identifiers) specifying the Worksheets to be converted. \n - **Usage:** \n - Used only when `convert_all` is set to `false`. \n - Leave empty or omit when `convert_all` is set to `true`.\n\n2. **excludeIdentifiers** \n - **Description:** A comma-separated list of GUIDs specifying Worksheets to be excluded from conversion. \n - **Usage:** \n - Useful when `convert_all` is set to `true` and specific Worksheets should not be converted.\n\n3. **convertAll** \n - **Description:** A boolean flag determining the scope of the conversion. \n - **Options:** \n - `true`: Converts all Worksheets in the system, except those specified in `excludeIdentifiers`. \n - `false`: Converts only the Worksheets listed in `identifiers`.\n\n4. **applyChanges** \n - **Description:** A boolean flag indicating whether to apply the conversion. \n - **Options:** \n - `true`: The conversion is applied directly to ThoughtSpot. \n - `false`: Simulates the conversion and generates a preview of changes, without applying them.\n\n---\n\n## Best Practices\n\n1. **Backup Before Conversion:** \n Always export metadata as a backup before initiating a conversion process.\n\n2. **Partial Conversion for Testing:** \n Test the conversion process by setting `convert_all` to `false` and specifying a small number of `identifiers`.\n\n3. **Verify Dependencies:** \n Ensure all dependencies (e.g., Tables, Connections) for the Worksheets are in place before conversion to avoid invalid references.\n\n4. **Review Changes:** \n Use `apply_changes: false` to preview the impact of the conversion before applying changes.\n\n---\n\n## Examples\n\n### Convert Specific Worksheets\n```json\n{\n \"identifiers\": \"guid1,guid2,guid3\",\n \"convertAll\": false,\n \"applyChanges\": true\n}\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Metadata",
"10.6.0.cl"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"input": {
"description": "Details of worksheet GUID which needs to be converted.",
"allOf": [
{
"$ref": "#/components/schemas/ConvertWorksheetInput"
}
]
}
},
"required": [
"input"
]
}
}
},
"required": true
},
"parameters": [],
"responses": {
"200": {
"description": "Common successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseWorksheetToModelConversionData"
}
}
}
},
"201": {
"description": "Common error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseWorksheetToModelConversionData"
}
}
}
},
"400": {
"description": "Operation failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Operation failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/api/rest/2.0/security/metadata/assign": {
"post": {
"operationId": "assignChangeAuthor",
Expand Down Expand Up @@ -8653,7 +8731,7 @@
"/api/rest/2.0/roles/create": {
"post": {
"operationId": "createRole",
"description": "\n <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nCreates a Role object in ThoughtSpot.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"description": "\nCreates a Role.\nRequires cluster Administration or Role Administration privileges. <br/> <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nCreates a Role object in ThoughtSpot.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
Expand Down Expand Up @@ -8713,12 +8791,6 @@
"CAN_SETUP_VERSION_CONTROL"
]
}
},
"read_only": {
"description": "<div><span class=\"since-beta-tag\">Version: 10.5.0.cl or later</span></div>\n\nIndicates whether the role is read only. A readonly role can neither be updated nor deleted.",
"default": false,
"type": "boolean",
"nullable": true
}
},
"required": [
Expand Down Expand Up @@ -8787,7 +8859,7 @@
"/api/rest/2.0/roles/{role_identifier}/update": {
"post": {
"operationId": "updateRole",
"description": "\n <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nUpdates the properties of a Role object.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"description": "\nUpdates a Role.\nRequires cluster Administration or Role Administration privileges. <br/> <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nUpdates the properties of a Role object.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
Expand Down Expand Up @@ -8923,7 +8995,7 @@
"/api/rest/2.0/roles/{role_identifier}/delete": {
"post": {
"operationId": "deleteRole",
"description": "\n <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nDeletes a Role object from the ThoughtSpot system.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"description": "\nDeletes a Role.\nRequires cluster Administration or Role Administration privileges. <br/> <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>\n\nDeletes a Role object from the ThoughtSpot system.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n",
"tags": [
"Roles",
"9.5.0.cl"
Expand All @@ -8936,7 +9008,7 @@
"schema": {
"type": "string"
},
"description": "Unique ID or name of the Role. ReadOnly roles cannot be deleted."
"description": "Unique ID or name of the Role."
}
],
"responses": {
Expand Down Expand Up @@ -15219,6 +15291,209 @@
}
}
},
"ConvertWorksheetInput": {
"type": "object",
"properties": {
"identifiers": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of Worksheet Identifiers.",
"nullable": true
},
"exclude_identifiers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude Worksheet objects.",
"nullable": true
},
"convert_all": {
"type": "boolean",
"default": false,
"description": "Indicates whether all the worksheet needs to be converted to models.",
"nullable": true
},
"apply_changes": {
"type": "boolean",
"default": false,
"description": "Indicates whether the changes should be applied to database.",
"nullable": true
}
},
"description": "Input type for convertWorksheetToModel mutation."
},
"ResponseWorksheetToModelConversionData": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/ResponseWorksheetToModelConversion"
}
},
"description": "Response data for worksheet to model conversion."
},
"ResponseWorksheetToModelConversion": {
"type": "object",
"required": [
"name",
"success_count",
"failure_count",
"incomplete_count",
"post_upgrade_failed_count",
"total_time_in_millis",
"successful_entities",
"failed_entities",
"incomplete_entities",
"post_upgrade_failed_entities"
],
"properties": {
"name": {
"type": "string"
},
"success_count": {
"type": "integer",
"format": "int32",
"description": "The number of worksheets successfully converted to models."
},
"failure_count": {
"type": "integer",
"format": "int32",
"description": "The number of worksheets that failed to convert."
},
"incomplete_count": {
"type": "integer",
"format": "int32",
"description": "The number of worksheets that were incomplete during the conversion process."
},
"post_upgrade_failed_count": {
"type": "integer",
"format": "int32",
"description": "The number of worksheets that failed after an upgrade during the conversion process."
},
"total_time_in_millis": {
"type": "integer",
"format": "int32",
"description": "The total time taken to complete the conversion process in milliseconds."
},
"successful_entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseSuccessfulEntity"
},
"description": "List of worksheets successfully converted to models."
},
"failed_entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseFailedEntity"
},
"description": "List of worksheets that failed to convert."
},
"incomplete_entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponseIncompleteEntity"
},
"description": "List of worksheets that were incomplete during the conversion."
},
"post_upgrade_failed_entities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResponsePostUpgradeFailedEntity"
},
"description": "List of worksheets that failed after an upgrade during the conversion process."
}
},
"description": "Name of the conversion process, which involves converting worksheets to models."
},
"ResponseSuccessfulEntity": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Name of the worksheet."
}
},
"description": "Unique ID of the worksheet."
},
"ResponseFailedEntity": {
"type": "object",
"required": [
"id",
"name",
"error"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Name of the worksheet that failed to convert."
},
"error": {
"type": "string",
"description": "Error details related to the failed conversion."
}
},
"description": "Unique ID of the failed worksheet."
},
"ResponseIncompleteEntity": {
"type": "object",
"required": [
"id",
"name",
"error"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Name of the incomplete worksheet."
},
"error": {
"type": "string",
"description": "Error details related to the incomplete conversion."
}
},
"description": "Unique ID of the incomplete worksheet."
},
"ResponsePostUpgradeFailedEntity": {
"type": "object",
"required": [
"id",
"name",
"error"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Name of the worksheet that failed post-upgrade."
},
"error": {
"type": "string",
"description": "Error details related to the post-upgrade failure."
}
},
"description": "Unique ID of the worksheet that failed post-upgrade."
},
"ExportMetadataTypeInput": {
"type": "object",
"required": [
Expand Down Expand Up @@ -16756,4 +17031,4 @@
}
}
]
}
}