Skip to content

Commit

Permalink
CD doc fix from generator utility (IBM-Cloud#3905)
Browse files Browse the repository at this point in the history 
* Doc fix from generator utility

* doc fix

* Revert ValidateSchema change from generator
  • Loading branch information
@gmarjoram @SunithaGudisagarIBM1
gmarjoram authored and SunithaGudisagarIBM1 committed Sep 14, 2022
1 parent f380721 commit c1a3c67
Show file tree
Hide file tree
Showing 44 changed files with 619 additions and 619 deletions.
22 changes: 11 additions & 11 deletions website/docs/d/cd_toolchain.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,26 +32,26 @@ Review the argument reference that you can specify for your data source.
In addition to all argument references listed, you can access the following attribute references after your data source is created.

* `id` - The unique identifier of the cd_toolchain.
* `account_id` - (Required, String) Account ID where toolchain can be found.
* `account_id` - (String) Account ID where toolchain can be found.

* `created_at` - (Required, String) Toolchain creation timestamp.
* `created_at` - (String) Toolchain creation timestamp.

* `created_by` - (Required, String) Identity that created the toolchain.
* `created_by` - (String) Identity that created the toolchain.

* `crn` - (Required, String) Toolchain CRN.
* `crn` - (String) Toolchain CRN.

* `description` - (Required, String) Toolchain description.
* `description` - (String) Toolchain description.

* `href` - (Required, String) URI that can be used to retrieve toolchain.
* `href` - (String) URI that can be used to retrieve toolchain.

* `location` - (Required, String) Toolchain region.
* `location` - (String) Toolchain region.

* `name` - (Required, String) Toolchain name.
* `name` - (String) Toolchain name.
* Constraints: The maximum length is `128` characters. The value must match regular expression `/^([^\\x00-\\x7F]|[a-zA-Z0-9-._ ])+$/`.

* `resource_group_id` - (Required, String) Resource group where toolchain can be found.
* `resource_group_id` - (String) Resource group where toolchain can be found.

* `tags` - (Required, List) Tags associated with the toolchain.
* `tags` - (List) Tags associated with the toolchain.

* `updated_at` - (Required, String) Latest toolchain update timestamp.
* `updated_at` - (String) Latest toolchain update timestamp.

34 changes: 17 additions & 17 deletions website/docs/d/cd_toolchain_tool_appconfig.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,36 +35,36 @@ Review the argument reference that you can specify for your data source.
In addition to all argument references listed, you can access the following attribute references after your data source is created.

* `id` - The unique identifier of the cd_toolchain_tool_appconfig.
* `crn` - (Required, String) Tool CRN.
* `crn` - (String) Tool CRN.


* `href` - (Required, String) URI representing the tool.
* `href` - (String) URI representing the tool.

* `name` - (Optional, String) Tool name.
* `name` - (String) Tool name.

* `parameters` - (Required, List) Parameters to be used to create the tool.
* `parameters` - (List) Parameters to be used to create the tool.
Nested scheme for **parameters**:
* `collection_name` - (Required, String) App Configuration collection.
* `collection_name` - (String) App Configuration collection.
* Constraints: The value must match regular expression `/\\S/`.
* `environment_name` - (Required, String) App Configuration environment.
* `environment_name` - (String) App Configuration environment.
* Constraints: The value must match regular expression `/\\S/`.
* `instance_name` - (Required, String) The name of your App Configuration instance. You should choose an entry from the list provided based on the selected region and resource group. e.g: App Configuration-01.
* `instance_name` - (String) The name of your App Configuration instance. You should choose an entry from the list provided based on the selected region and resource group. e.g: App Configuration-01.
* Constraints: The value must match regular expression `/\\S/`.
* `name` - (Required, String) Type a name for this tool integration, for example: my-appconfig. This name displays on your toolchain.
* `region` - (Required, String) Region.
* `resource_group` - (Required, String) Resource group.
* `name` - (String) Type a name for this tool integration, for example: my-appconfig. This name displays on your toolchain.
* `region` - (String) Region.
* `resource_group` - (String) Resource group.

* `referent` - (Required, List) Information on URIs to access this resource through the UI or API.
* `referent` - (List) Information on URIs to access this resource through the UI or API.
Nested scheme for **referent**:
* `api_href` - (Optional, String) URI representing the this resource through an API.
* `ui_href` - (Optional, String) URI representing the this resource through the UI.
* `api_href` - (String) URI representing the this resource through an API.
* `ui_href` - (String) URI representing the this resource through the UI.

* `resource_group_id` - (Required, String) Resource group where tool can be found.
* `resource_group_id` - (String) Resource group where tool can be found.

* `state` - (Required, String) Current configuration state of the tool.
* `state` - (String) Current configuration state of the tool.
* Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`.

* `toolchain_crn` - (Required, String) CRN of toolchain which the tool is bound to.
* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to.

* `updated_at` - (Required, String) Latest tool update timestamp.
* `updated_at` - (String) Latest tool update timestamp.

42 changes: 21 additions & 21 deletions website/docs/d/cd_toolchain_tool_artifactory.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,38 +35,38 @@ Review the argument reference that you can specify for your data source.
In addition to all argument references listed, you can access the following attribute references after your data source is created.

* `id` - The unique identifier of the cd_toolchain_tool_artifactory.
* `crn` - (Required, String) Tool CRN.
* `crn` - (String) Tool CRN.


* `href` - (Required, String) URI representing the tool.
* `href` - (String) URI representing the tool.

* `name` - (Optional, String) Tool name.
* `name` - (String) Tool name.

* `parameters` - (Required, List) Parameters to be used to create the tool.
* `parameters` - (List) Parameters to be used to create the tool.
Nested scheme for **parameters**:
* `dashboard_url` - (Optional, String) Type the URL that you want to navigate to when you click the Artifactory integration tile.
* `mirror_url` - (Optional, String) Type the URL for your Artifactory virtual repository, which is a repository that can see your private repositories and a cache of the public repositories.
* `name` - (Required, String) Type a name for this tool integration, for example: my-artifactory. This name displays on your toolchain.
* `release_url` - (Optional, String) Type the URL for your Artifactory release repository.
* `repository_name` - (Optional, String) Type the name of your artifactory repository where your docker images are located.
* `repository_url` - (Optional, String) Type the URL of your artifactory repository where your docker images are located.
* `snapshot_url` - (Optional, String) Type the URL for your Artifactory snapshot repository.
* `token` - (Optional, String) Type the API key for your Artifactory repository.
* `type` - (Required, String) Choose the type of repository for your Artifactory integration.
* `dashboard_url` - (String) Type the URL that you want to navigate to when you click the Artifactory integration tile.
* `mirror_url` - (String) Type the URL for your Artifactory virtual repository, which is a repository that can see your private repositories and a cache of the public repositories.
* `name` - (String) Type a name for this tool integration, for example: my-artifactory. This name displays on your toolchain.
* `release_url` - (String) Type the URL for your Artifactory release repository.
* `repository_name` - (String) Type the name of your artifactory repository where your docker images are located.
* `repository_url` - (String) Type the URL of your artifactory repository where your docker images are located.
* `snapshot_url` - (String) Type the URL for your Artifactory snapshot repository.
* `token` - (String) Type the API key for your Artifactory repository.
* `type` - (String) Choose the type of repository for your Artifactory integration.
* Constraints: Allowable values are: `npm`, `maven`, `docker`.
* `user_id` - (Optional, String) Type the User ID or email for your Artifactory repository.
* `user_id` - (String) Type the User ID or email for your Artifactory repository.

* `referent` - (Required, List) Information on URIs to access this resource through the UI or API.
* `referent` - (List) Information on URIs to access this resource through the UI or API.
Nested scheme for **referent**:
* `api_href` - (Optional, String) URI representing the this resource through an API.
* `ui_href` - (Optional, String) URI representing the this resource through the UI.
* `api_href` - (String) URI representing the this resource through an API.
* `ui_href` - (String) URI representing the this resource through the UI.

* `resource_group_id` - (Required, String) Resource group where tool can be found.
* `resource_group_id` - (String) Resource group where tool can be found.

* `state` - (Required, String) Current configuration state of the tool.
* `state` - (String) Current configuration state of the tool.
* Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`.

* `toolchain_crn` - (Required, String) CRN of toolchain which the tool is bound to.
* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to.

* `updated_at` - (Required, String) Latest tool update timestamp.
* `updated_at` - (String) Latest tool update timestamp.

46 changes: 23 additions & 23 deletions website/docs/d/cd_toolchain_tool_bitbucketgit.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,43 +35,43 @@ Review the argument reference that you can specify for your data source.
In addition to all argument references listed, you can access the following attribute references after your data source is created.

* `id` - The unique identifier of the cd_toolchain_tool_bitbucketgit.
* `crn` - (Required, String) Tool CRN.
* `crn` - (String) Tool CRN.


* `href` - (Required, String) URI representing the tool.
* `href` - (String) URI representing the tool.

* `name` - (Optional, String) Tool name.
* `name` - (String) Tool name.

* `parameters` - (Required, List) Parameters to be used to create the tool.
* `parameters` - (List) Parameters to be used to create the tool.
Nested scheme for **parameters**:
* `api_root_url` - (Optional, String) e.g. https://api.bitbucket.org.
* `enable_traceability` - (Optional, Boolean) Select this check box to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
* `api_root_url` - (String) e.g. https://api.bitbucket.org.
* `enable_traceability` - (Boolean) Select this check box to track the deployment of code changes by creating tags, labels and comments on commits, pull requests and referenced issues.
* Constraints: The default value is `false`.
* `git_id` - (Optional, String)
* `has_issues` - (Optional, Boolean) Select this check box to enable Bitbucket Issues for lightweight issue tracking.
* `git_id` - (String)
* `has_issues` - (Boolean) Select this check box to enable Bitbucket Issues for lightweight issue tracking.
* Constraints: The default value is `true`.
* `integration_owner` - (Optional, String) Select the user which git operations will be performed as.
* `owner_id` - (Optional, String)
* `private_repo` - (Optional, Boolean) Select this check box to make this repository private.
* `integration_owner` - (String) Select the user which git operations will be performed as.
* `owner_id` - (String)
* `private_repo` - (Boolean) Select this check box to make this repository private.
* Constraints: The default value is `false`.
* `repo_name` - (Optional, String)
* `repo_url` - (Optional, String) Type the URL of the repository that you are linking to.
* `source_repo_url` - (Optional, String) Type the URL of the repository that you are forking or cloning.
* `token_url` - (Optional, String) Integration token URL.
* `type` - (Optional, String)
* `repo_name` - (String)
* `repo_url` - (String) Type the URL of the repository that you are linking to.
* `source_repo_url` - (String) Type the URL of the repository that you are forking or cloning.
* `token_url` - (String) Integration token URL.
* `type` - (String)
* Constraints: Allowable values are: `new`, `fork`, `clone`, `link`.

* `referent` - (Required, List) Information on URIs to access this resource through the UI or API.
* `referent` - (List) Information on URIs to access this resource through the UI or API.
Nested scheme for **referent**:
* `api_href` - (Optional, String) URI representing the this resource through an API.
* `ui_href` - (Optional, String) URI representing the this resource through the UI.
* `api_href` - (String) URI representing the this resource through an API.
* `ui_href` - (String) URI representing the this resource through the UI.

* `resource_group_id` - (Required, String) Resource group where tool can be found.
* `resource_group_id` - (String) Resource group where tool can be found.

* `state` - (Required, String) Current configuration state of the tool.
* `state` - (String) Current configuration state of the tool.
* Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`.

* `toolchain_crn` - (Required, String) CRN of toolchain which the tool is bound to.
* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to.

* `updated_at` - (Required, String) Latest tool update timestamp.
* `updated_at` - (String) Latest tool update timestamp.

38 changes: 19 additions & 19 deletions website/docs/d/cd_toolchain_tool_custom.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,36 +35,36 @@ Review the argument reference that you can specify for your data source.
In addition to all argument references listed, you can access the following attribute references after your data source is created.

* `id` - The unique identifier of the cd_toolchain_tool_custom.
* `crn` - (Required, String) Tool CRN.
* `crn` - (String) Tool CRN.


* `href` - (Required, String) URI representing the tool.
* `href` - (String) URI representing the tool.

* `name` - (Optional, String) Tool name.
* `name` - (String) Tool name.

* `parameters` - (Required, List) Parameters to be used to create the tool.
* `parameters` - (List) Parameters to be used to create the tool.
Nested scheme for **parameters**:
* `additional_properties` - (Optional, String) (Advanced) Type any information that is needed to integrate with other tools in your toolchain.
* `dashboard_url` - (Required, String) Type the URL that you want to navigate to when you click the tool integration card.
* `description` - (Optional, String) Type a description for the tool instance.
* `documentation_url` - (Optional, String) Type the URL for your tool's documentation.
* `image_url` - (Optional, String) Type the URL of the icon to show on your tool integration's card.
* `lifecycle_phase` - (Required, String) Select the lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.
* `additional_properties` - (String) (Advanced) Type any information that is needed to integrate with other tools in your toolchain.
* `dashboard_url` - (String) Type the URL that you want to navigate to when you click the tool integration card.
* `description` - (String) Type a description for the tool instance.
* `documentation_url` - (String) Type the URL for your tool's documentation.
* `image_url` - (String) Type the URL of the icon to show on your tool integration's card.
* `lifecycle_phase` - (String) Select the lifecycle phase of the IBM Cloud Garage Method that is the most closely associated with this tool.
* Constraints: Allowable values are: `THINK`, `CODE`, `DELIVER`, `RUN`, `MANAGE`, `LEARN`, `CULTURE`.
* `name` - (Required, String) Type a name for this specific tool integration; for example: My Build and Deploy Pipeline.
* `type` - (Required, String) Type the name of the tool that you are integrating; for example: Delivery Pipeline.
* `name` - (String) Type a name for this specific tool integration; for example: My Build and Deploy Pipeline.
* `type` - (String) Type the name of the tool that you are integrating; for example: Delivery Pipeline.

* `referent` - (Required, List) Information on URIs to access this resource through the UI or API.
* `referent` - (List) Information on URIs to access this resource through the UI or API.
Nested scheme for **referent**:
* `api_href` - (Optional, String) URI representing the this resource through an API.
* `ui_href` - (Optional, String) URI representing the this resource through the UI.
* `api_href` - (String) URI representing the this resource through an API.
* `ui_href` - (String) URI representing the this resource through the UI.

* `resource_group_id` - (Required, String) Resource group where tool can be found.
* `resource_group_id` - (String) Resource group where tool can be found.

* `state` - (Required, String) Current configuration state of the tool.
* `state` - (String) Current configuration state of the tool.
* Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`.

* `toolchain_crn` - (Required, String) CRN of toolchain which the tool is bound to.
* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to.

* `updated_at` - (Required, String) Latest tool update timestamp.
* `updated_at` - (String) Latest tool update timestamp.

20 changes: 10 additions & 10 deletions website/docs/d/cd_toolchain_tool_devopsinsights.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,24 +35,24 @@ Review the argument reference that you can specify for your data source.
In addition to all argument references listed, you can access the following attribute references after your data source is created.

* `id` - The unique identifier of the cd_toolchain_tool_devopsinsights.
* `crn` - (Required, String) Tool CRN.
* `crn` - (String) Tool CRN.


* `href` - (Required, String) URI representing the tool.
* `href` - (String) URI representing the tool.

* `name` - (Optional, String) Tool name.
* `name` - (String) Tool name.

* `referent` - (Required, List) Information on URIs to access this resource through the UI or API.
* `referent` - (List) Information on URIs to access this resource through the UI or API.
Nested scheme for **referent**:
* `api_href` - (Optional, String) URI representing the this resource through an API.
* `ui_href` - (Optional, String) URI representing the this resource through the UI.
* `api_href` - (String) URI representing the this resource through an API.
* `ui_href` - (String) URI representing the this resource through the UI.

* `resource_group_id` - (Required, String) Resource group where tool can be found.
* `resource_group_id` - (String) Resource group where tool can be found.

* `state` - (Required, String) Current configuration state of the tool.
* `state` - (String) Current configuration state of the tool.
* Constraints: Allowable values are: `configured`, `configuring`, `misconfigured`, `unconfigured`.

* `toolchain_crn` - (Required, String) CRN of toolchain which the tool is bound to.
* `toolchain_crn` - (String) CRN of toolchain which the tool is bound to.

* `updated_at` - (Required, String) Latest tool update timestamp.
* `updated_at` - (String) Latest tool update timestamp.

Loading

0 comments on commit c1a3c67

Please sign in to comment.