|
2421 | 2421 | "/api/rest/2.0/vcs/git/config/search": { |
2422 | 2422 | "post": { |
2423 | 2423 | "operationId": "searchConfig", |
2424 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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\n\n\n\n#### Endpoint URL\n", |
| 2424 | + "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\n\n\n\n#### Endpoint URL\n", |
2425 | 2425 | "tags": [ |
2426 | 2426 | "Version Control", |
2427 | 2427 | "9.2.0.cl" |
|
2433 | 2433 | "type": "object", |
2434 | 2434 | "properties": { |
2435 | 2435 | "org_identifiers": { |
2436 | | - "description": " List of Org IDs. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"]\n \n\nNote: If no org identifier 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>", |
| 2436 | + "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>", |
2437 | 2437 | "type": "array", |
2438 | 2438 | "items": { |
2439 | 2439 | "type": "string" |
|
2505 | 2505 | "/api/rest/2.0/vcs/git/commits/search": { |
2506 | 2506 | "post": { |
2507 | 2507 | "operationId": "searchCommits", |
2508 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", |
| 2508 | + "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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", |
2509 | 2509 | "tags": [ |
2510 | 2510 | "Version Control", |
2511 | 2511 | "9.2.0.cl" |
|
6325 | 6325 | "/api/rest/2.0/vcs/git/config/create": { |
6326 | 6326 | "post": { |
6327 | 6327 | "operationId": "createConfig", |
6328 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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\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\n\n\n#### Endpoint URL\n", |
| 6328 | + "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\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\n\n\n#### Endpoint URL\n", |
6329 | 6329 | "tags": [ |
6330 | 6330 | "Version Control", |
6331 | 6331 | "9.2.0.cl" |
|
6349 | 6349 | "type": "string" |
6350 | 6350 | }, |
6351 | 6351 | "org_identifier": { |
6352 | | - "description": " Unique identifier of the Org. If no value is provided, the user will be created in the Org associated with the login session. Provide value -1 for cluster level. Example : OrgID1-or-Name1\n \n\nNote: If no org identifier is specified, then current org identifier of the user will be considered <br/> <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>", |
| 6352 | + "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>", |
6353 | 6353 | "type": "string" |
6354 | 6354 | }, |
6355 | 6355 | "branch_names": { |
|
6452 | 6452 | "/api/rest/2.0/vcs/git/config/update": { |
6453 | 6453 | "post": { |
6454 | 6454 | "operationId": "updateConfig", |
6455 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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\n\n\n\n#### Endpoint URL\n", |
| 6455 | + "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\n\n\n\n#### Endpoint URL\n", |
6456 | 6456 | "tags": [ |
6457 | 6457 | "Version Control", |
6458 | 6458 | "9.2.0.cl" |
|
6472 | 6472 | "type": "string" |
6473 | 6473 | }, |
6474 | 6474 | "org_identifier": { |
6475 | | - "description": " Unique identifier of the Org. If no value is provided, the user will be created in the Org associated with the login session. Provide value -1 for cluster level. Example : OrgID1-or-Name1\n \n\nNote: If no org identifier is specified, then current org identifier of the user will be considered <br/> <span class=\"since-beta-tag\">Version: 9.5.0.cl or later</span>", |
| 6475 | + "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>", |
6476 | 6476 | "type": "string" |
6477 | 6477 | }, |
6478 | 6478 | "branch_names": { |
|
6568 | 6568 | "/api/rest/2.0/vcs/git/config/delete": { |
6569 | 6569 | "post": { |
6570 | 6570 | "operationId": "deleteConfig", |
6571 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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\n\n\n\n#### Endpoint URL\n", |
| 6571 | + "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\n\n\n\n#### Endpoint URL\n", |
6572 | 6572 | "tags": [ |
6573 | 6573 | "Version Control", |
6574 | 6574 | "9.2.0.cl" |
|
6580 | 6580 | "type": "object", |
6581 | 6581 | "properties": { |
6582 | 6582 | "cluster_level": { |
6583 | | - "description": "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>", |
| 6583 | + "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>", |
6584 | 6584 | "type": "boolean", |
6585 | 6585 | "nullable": true |
6586 | 6586 | } |
|
6640 | 6640 | "/api/rest/2.0/vcs/git/branches/commit": { |
6641 | 6641 | "post": { |
6642 | 6642 | "operationId": "commitBranch", |
6643 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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/?pageid=git-integration).\n\n\n\n\n#### Endpoint URL\n", |
| 6643 | + "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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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/?pageid=git-integration).\n\n\n\n\n#### Endpoint URL\n", |
6644 | 6644 | "tags": [ |
6645 | 6645 | "Version Control", |
6646 | 6646 | "9.2.0.cl" |
|
6740 | 6740 | "/api/rest/2.0/vcs/git/commits/{commit_id}/revert": { |
6741 | 6741 | "post": { |
6742 | 6742 | "operationId": "revertCommit", |
6743 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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\n\n\n\n#### Endpoint URL\n", |
| 6743 | + "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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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\n\n\n\n#### Endpoint URL\n", |
6744 | 6744 | "tags": [ |
6745 | 6745 | "Version Control", |
6746 | 6746 | "9.2.0.cl" |
|
6844 | 6844 | "/api/rest/2.0/vcs/git/branches/validate": { |
6845 | 6845 | "post": { |
6846 | 6846 | "operationId": "validateMerge", |
6847 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", |
| 6847 | + "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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", |
6848 | 6848 | "tags": [ |
6849 | 6849 | "Version Control", |
6850 | 6850 | "9.2.0.cl" |
|
6934 | 6934 | "/api/rest/2.0/vcs/git/commits/deploy": { |
6935 | 6935 | "post": { |
6936 | 6936 | "operationId": "deployCommit", |
6937 | | - "description": "\n<span class=\"since-beta-tag\">Beta</span> <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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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\n\n\n\n#### Endpoint URL\n", |
| 6937 | + "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 `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\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\n\n\n\n#### Endpoint URL\n", |
6938 | 6938 | "tags": [ |
6939 | 6939 | "Version Control", |
6940 | 6940 | "9.2.0.cl" |
|
6968 | 6968 | "type": "string", |
6969 | 6969 | "enum": [ |
6970 | 6970 | "ALL_OR_NONE", |
6971 | | - "PARTIAL" |
| 6971 | + "PARTIAL", |
| 6972 | + "VALIDATE_ONLY" |
6972 | 6973 | ] |
6973 | 6974 | } |
6974 | 6975 | }, |
|
0 commit comments