generate documentation using tfplugindocs

docs/data-sources/sonarqube_group.md → docs/data-sources/group.md

@@ -1,4 +1,5 @@
 ---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "sonarqube_group Data Source - terraform-provider-sonarqube"
 subcategory: ""
 description: |-
@@ -9,24 +10,22 @@ description: |-
 
 Use this data source to get a Sonarqube Group resource
 
-## Example usage
+## Example Usage
 
 ```terraform
 data "sonarqube_group" "group" {
   name = "terraform-test"
 }
 ```
 
-## Argument Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-The following arguments are supported:
+### Required
 
-- name - (Required) The name of the Group
+- `name` (String) The name of the group.
 
-## Attributes Reference
+### Read-Only
 
-The following attributes are exported:
-
-- id - The ID of the Group.
-- name - The name of the group.
-- description - The group description.
+- `description` (String) The group description.
+- `id` (String) The ID of this resource.

docs/data-sources/portfolio.md

@@ -0,0 +1,38 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "sonarqube_portfolio Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube portfolio resource
+---
+
+# sonarqube_portfolio (Data Source)
+
+Use this data source to get a Sonarqube portfolio resource
+
+## Example Usage
+
+```terraform
+data "sonarqube_portfolio" "portfolio" {
+  key = "portfolio-key"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `key` (String) The key of the portfolio
+
+### Read-Only
+
+- `branch` (String) Which branch is analyzed
+- `description` (String) Description of the portfolio
+- `id` (String) The ID of this resource.
+- `name` (String) Name of the portfolio
+- `qualifier` (String) `VW` (portfolios always have this qualifier)
+- `regexp` (String) The regular expression used to populate the portfolio. Only active when `selection_mode` is `REGEXP`
+- `selection_mode` (String) How the Portfolio is populated. Possible values are `NONE`, `MANUAL`, `TAGS`, `REGEXP` or `REST`. [See docs](https://docs.sonarqube.org/9.8/project-administration/managing-portfolios/#populating-portfolios) for how Portfolio population works
+- `tags` (List of String) The list of tags used to populate the Portfolio. Only active when `selection_mode` is `TAGS`
+- `visibility` (String) Portfolio visibility

docs/data-sources/sonarqube_project.md → docs/data-sources/project.md

@@ -1,4 +1,5 @@
 ---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "sonarqube_project Data Source - terraform-provider-sonarqube"
 subcategory: ""
 description: |-
@@ -9,24 +10,23 @@ description: |-
 
 Use this data source to get a Sonarqube project resource
 
-## Example usage
+## Example Usage
 
 ```terraform
 data "sonarqube_project" "project" {
   project = "projet-key-id"
 }
 ```
 
-## Argument Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-The following arguments are supported:
+### Required
 
-- project - (Required) The project key of the project
+- `project` (String) The project key of the project
 
-## Attributes Reference
+### Read-Only
 
-The following attributes are exported:
-
-- name - Name of the project
-- project - Key of the project
-- visibility - Project visibility
+- `id` (String) The ID of this resource.
+- `name` (String) Name of the project
+- `visibility` (String) Project visibility

docs/data-sources/qualitygate.md

@@ -0,0 +1,43 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "sonarqube_qualitygate Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube qualitygate resource
+---
+
+# sonarqube_qualitygate (Data Source)
+
+Use this data source to get a Sonarqube qualitygate resource
+
+## Example Usage
+
+```terraform
+data "sonarqube_qualitygate" "main" {
+  name = "example"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) The name of the Quality Gate.
+
+### Read-Only
+
+- `condition` (List of Object) List of Quality Gate conditions. (see [below for nested schema](#nestedatt--condition))
+- `copy_from` (String) Origin of the Quality Gate
+- `id` (String) The ID of this resource.
+- `is_default` (Boolean) Quality Gate default.
+
+<a id="nestedatt--condition"></a>
+### Nested Schema for `condition`
+
+Read-Only:
+
+- `id` (String)
+- `metric` (String)
+- `op` (String)
+- `threshold` (String)

docs/data-sources/qualityprofile.md

@@ -0,0 +1,33 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "sonarqube_qualityprofile Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube qualityprofile resource
+---
+
+# sonarqube_qualityprofile (Data Source)
+
+Use this data source to get a Sonarqube qualityprofile resource
+
+## Example Usage
+
+```terraform
+data "sonarqube_qualityprofile" "main" {
+  name = "example"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `name` (String) The name of the Quality Profile
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `is_default` (Boolean) Quality Profile default
+- `key` (String) The key of the Quality Profile
+- `language` (String) Quality Profile language

docs/data-sources/rule.md

@@ -0,0 +1,36 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "sonarqube_rule Data Source - terraform-provider-sonarqube"
+subcategory: ""
+description: |-
+  Use this data source to get a Sonarqube rule resource
+---
+
+# sonarqube_rule (Data Source)
+
+Use this data source to get a Sonarqube rule resource
+
+## Example Usage
+
+```terraform
+data "sonarqube_rule" "rule" {
+  key = "squid:forbidSonar"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `key` (String) The key of the sonarqube rule. Should be <repo>:<name>. https://next.sonarqube.com/sonarqube/web_api/api/rules?query=api%2Frules%2Fcreate
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `markdown_description` (String) Rule description
+- `name` (String) Rule name
+- `severity` (String) Rule severity
+- `status` (String) Rule status
+- `template_key` (String) Key of the template rule
+- `type` (String) Rule type