From 79ce8303dc53d03e6152a67327f2b514b2cbf72e Mon Sep 17 00:00:00 2001 From: Gary Marjoram Date: Wed, 25 Jan 2023 09:44:53 +0000 Subject: [PATCH] CD: Field description updates for PAT --- .../data_source_ibm_cd_toolchain_tool_githubconsolidated.go | 4 ++-- .../cdtoolchain/data_source_ibm_cd_toolchain_tool_gitlab.go | 4 ++-- .../data_source_ibm_cd_toolchain_tool_hostedgit.go | 4 ++-- .../resource_ibm_cd_toolchain_tool_githubconsolidated.go | 4 ++-- .../cdtoolchain/resource_ibm_cd_toolchain_tool_gitlab.go | 4 ++-- .../cdtoolchain/resource_ibm_cd_toolchain_tool_hostedgit.go | 4 ++-- .../docs/d/cd_toolchain_tool_githubconsolidated.html.markdown | 4 ++-- website/docs/d/cd_toolchain_tool_gitlab.html.markdown | 4 ++-- website/docs/d/cd_toolchain_tool_hostedgit.html.markdown | 4 ++-- .../docs/r/cd_toolchain_tool_githubconsolidated.html.markdown | 4 ++-- website/docs/r/cd_toolchain_tool_gitlab.html.markdown | 4 ++-- website/docs/r/cd_toolchain_tool_hostedgit.html.markdown | 4 ++-- 12 files changed, 24 insertions(+), 24 deletions(-) diff --git a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_githubconsolidated.go b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_githubconsolidated.go index 8535fb0d66..d4b43ecb4f 100644 --- a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_githubconsolidated.go +++ b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_githubconsolidated.go @@ -159,13 +159,13 @@ func DataSourceIBMCdToolchainToolGithubconsolidated() *schema.Resource { "auth_type": &schema.Schema{ Type: schema.TypeString, Computed: true, - Description: "Select the method of authentication that will be used to access the git provider.", + Description: "Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.", }, "api_token": &schema.Schema{ Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "Personal Access Token.", + Description: "Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.", }, "toolchain_issues_enabled": &schema.Schema{ Type: schema.TypeBool, diff --git a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_gitlab.go b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_gitlab.go index 8e33b4a0b8..619dd70394 100644 --- a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_gitlab.go +++ b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_gitlab.go @@ -154,13 +154,13 @@ func DataSourceIBMCdToolchainToolGitlab() *schema.Resource { "auth_type": &schema.Schema{ Type: schema.TypeString, Computed: true, - Description: "Select the method of authentication that will be used to access the git provider.", + Description: "Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.", }, "api_token": &schema.Schema{ Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "Personal Access Token.", + Description: "Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.", }, "toolchain_issues_enabled": &schema.Schema{ Type: schema.TypeBool, diff --git a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_hostedgit.go b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_hostedgit.go index e733e4cdd6..e22a5caa96 100644 --- a/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_hostedgit.go +++ b/ibm/service/cdtoolchain/data_source_ibm_cd_toolchain_tool_hostedgit.go @@ -154,13 +154,13 @@ func DataSourceIBMCdToolchainToolHostedgit() *schema.Resource { "auth_type": &schema.Schema{ Type: schema.TypeString, Computed: true, - Description: "Select the method of authentication that will be used to access the git provider.", + Description: "Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.", }, "api_token": &schema.Schema{ Type: schema.TypeString, Computed: true, Sensitive: true, - Description: "Personal Access Token.", + Description: "Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.", }, "toolchain_issues_enabled": &schema.Schema{ Type: schema.TypeBool, diff --git a/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_githubconsolidated.go b/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_githubconsolidated.go index 54b478358c..cf0530268d 100644 --- a/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_githubconsolidated.go +++ b/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_githubconsolidated.go @@ -116,14 +116,14 @@ func ResourceIBMCdToolchainToolGithubconsolidated() *schema.Resource { "auth_type": &schema.Schema{ Type: schema.TypeString, Optional: true, - Description: "Select the method of authentication that will be used to access the git provider.", + Description: "Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.", }, "api_token": &schema.Schema{ Type: schema.TypeString, Optional: true, DiffSuppressFunc: flex.SuppressHashedRawSecret, Sensitive: true, - Description: "Personal Access Token.", + Description: "Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.", }, "toolchain_issues_enabled": &schema.Schema{ Type: schema.TypeBool, diff --git a/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_gitlab.go b/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_gitlab.go index e250787c38..d1a0c14839 100644 --- a/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_gitlab.go +++ b/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_gitlab.go @@ -111,14 +111,14 @@ func ResourceIBMCdToolchainToolGitlab() *schema.Resource { "auth_type": &schema.Schema{ Type: schema.TypeString, Optional: true, - Description: "Select the method of authentication that will be used to access the git provider.", + Description: "Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.", }, "api_token": &schema.Schema{ Type: schema.TypeString, Optional: true, DiffSuppressFunc: flex.SuppressHashedRawSecret, Sensitive: true, - Description: "Personal Access Token.", + Description: "Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.", }, "toolchain_issues_enabled": &schema.Schema{ Type: schema.TypeBool, diff --git a/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_hostedgit.go b/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_hostedgit.go index f314b5a8ed..cb2820a3a9 100644 --- a/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_hostedgit.go +++ b/ibm/service/cdtoolchain/resource_ibm_cd_toolchain_tool_hostedgit.go @@ -111,14 +111,14 @@ func ResourceIBMCdToolchainToolHostedgit() *schema.Resource { "auth_type": &schema.Schema{ Type: schema.TypeString, Optional: true, - Description: "Select the method of authentication that will be used to access the git provider.", + Description: "Select the method of authentication that will be used to access the git provider. The default value is 'oauth'.", }, "api_token": &schema.Schema{ Type: schema.TypeString, Optional: true, DiffSuppressFunc: flex.SuppressHashedRawSecret, Sensitive: true, - Description: "Personal Access Token.", + Description: "Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise.", }, "toolchain_issues_enabled": &schema.Schema{ Type: schema.TypeBool, diff --git a/website/docs/d/cd_toolchain_tool_githubconsolidated.html.markdown b/website/docs/d/cd_toolchain_tool_githubconsolidated.html.markdown index 4a410943e5..e134fa2d9d 100644 --- a/website/docs/d/cd_toolchain_tool_githubconsolidated.html.markdown +++ b/website/docs/d/cd_toolchain_tool_githubconsolidated.html.markdown @@ -44,8 +44,8 @@ In addition to all argument references listed, you can access the following attr * `parameters` - (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested scheme for **parameters**: * `api_root_url` - (String) The API root URL for the GitHub server. - * `api_token` - (String) Personal Access Token. - * `auth_type` - (String) Select the method of authentication that will be used to access the git provider. + * `api_token` - (String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise. + * `auth_type` - (String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'. * Constraints: Allowable values are: `oauth`, `pat`. * `auto_init` - (Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository. * Constraints: The default value is `false`. diff --git a/website/docs/d/cd_toolchain_tool_gitlab.html.markdown b/website/docs/d/cd_toolchain_tool_gitlab.html.markdown index 22b1479eec..c4086462bf 100644 --- a/website/docs/d/cd_toolchain_tool_gitlab.html.markdown +++ b/website/docs/d/cd_toolchain_tool_gitlab.html.markdown @@ -44,8 +44,8 @@ In addition to all argument references listed, you can access the following attr * `parameters` - (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested scheme for **parameters**: * `api_root_url` - (String) The API root URL for the GitLab Server. - * `api_token` - (String) Personal Access Token. - * `auth_type` - (String) Select the method of authentication that will be used to access the git provider. + * `api_token` - (String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise. + * `auth_type` - (String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'. * Constraints: Allowable values are: `oauth`, `pat`. * `default_branch` - (String) The default branch of the git repository. * `enable_traceability` - (Boolean) Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues. diff --git a/website/docs/d/cd_toolchain_tool_hostedgit.html.markdown b/website/docs/d/cd_toolchain_tool_hostedgit.html.markdown index 4c81bef4a8..7d7fd76ea1 100644 --- a/website/docs/d/cd_toolchain_tool_hostedgit.html.markdown +++ b/website/docs/d/cd_toolchain_tool_hostedgit.html.markdown @@ -44,8 +44,8 @@ In addition to all argument references listed, you can access the following attr * `parameters` - (List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested scheme for **parameters**: * `api_root_url` - (String) The API root URL for the GitLab server. - * `api_token` - (String) Personal Access Token. - * `auth_type` - (String) Select the method of authentication that will be used to access the git provider. + * `api_token` - (String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise. + * `auth_type` - (String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'. * Constraints: Allowable values are: `oauth`, `pat`. * `default_branch` - (String) The default branch of the git repository. * `enable_traceability` - (Boolean) Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues. diff --git a/website/docs/r/cd_toolchain_tool_githubconsolidated.html.markdown b/website/docs/r/cd_toolchain_tool_githubconsolidated.html.markdown index 966a6e4022..8f585b3114 100644 --- a/website/docs/r/cd_toolchain_tool_githubconsolidated.html.markdown +++ b/website/docs/r/cd_toolchain_tool_githubconsolidated.html.markdown @@ -58,8 +58,8 @@ Nested scheme for **initialization**: * `parameters` - (Required, List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested scheme for **parameters**: * `api_root_url` - (Computed, String) The API root URL for the GitHub server. - * `api_token` - (Optional, String) Personal Access Token. - * `auth_type` - (Optional, String) Select the method of authentication that will be used to access the git provider. + * `api_token` - (Optional, String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise. + * `auth_type` - (Optional, String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'. * Constraints: Allowable values are: `oauth`, `pat`. * `auto_init` - (Computed, Boolean) Setting this value to true will initialize this repository with a README. This parameter is only used when creating a new repository. * Constraints: The default value is `false`. diff --git a/website/docs/r/cd_toolchain_tool_gitlab.html.markdown b/website/docs/r/cd_toolchain_tool_gitlab.html.markdown index 83b5d6f8f7..887c5d5f46 100644 --- a/website/docs/r/cd_toolchain_tool_gitlab.html.markdown +++ b/website/docs/r/cd_toolchain_tool_gitlab.html.markdown @@ -55,8 +55,8 @@ Nested scheme for **initialization**: * `parameters` - (Required, List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested scheme for **parameters**: * `api_root_url` - (Computed, String) The API root URL for the GitLab Server. - * `api_token` - (Optional, String) Personal Access Token. - * `auth_type` - (Optional, String) Select the method of authentication that will be used to access the git provider. + * `api_token` - (Optional, String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise. + * `auth_type` - (Optional, String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'. * Constraints: Allowable values are: `oauth`, `pat`. * `default_branch` - (Computed, String) The default branch of the git repository. * `enable_traceability` - (Optional, Boolean) Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues. diff --git a/website/docs/r/cd_toolchain_tool_hostedgit.html.markdown b/website/docs/r/cd_toolchain_tool_hostedgit.html.markdown index 80c8f024ee..8fb5544864 100644 --- a/website/docs/r/cd_toolchain_tool_hostedgit.html.markdown +++ b/website/docs/r/cd_toolchain_tool_hostedgit.html.markdown @@ -55,8 +55,8 @@ Nested scheme for **initialization**: * `parameters` - (Required, List) Unique key-value pairs representing parameters to be used to create the tool. A list of parameters for each tool integration can be found in the Configuring tool integrations page. Nested scheme for **parameters**: * `api_root_url` - (Computed, String) The API root URL for the GitLab server. - * `api_token` - (Optional, String) Personal Access Token. - * `auth_type` - (Optional, String) Select the method of authentication that will be used to access the git provider. + * `api_token` - (Optional, String) Personal Access Token. Required if ‘auth_type’ is set to ‘pat’, ignored otherwise. + * `auth_type` - (Optional, String) Select the method of authentication that will be used to access the git provider. The default value is 'oauth'. * Constraints: Allowable values are: `oauth`, `pat`. * `default_branch` - (Computed, String) The default branch of the git repository. * `enable_traceability` - (Optional, Boolean) Set this value to 'true' to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.