docs: Update docs

mmmake-gmbh · Sep 17, 2021 · 3ce5af8 · 3ce5af8
1 parent 0815397
commit 3ce5af8
Show file tree

Hide file tree

Showing 13 changed files with 229 additions and 243 deletions.
diff --git a/docs/data-sources/dns_record.md b/docs/data-sources/dns_record.md
diff --git a/docs/data-sources/dns_records.md b/docs/data-sources/dns_records.md
diff --git a/docs/data-sources/dns_zone.md b/docs/data-sources/dns_zone.md
diff --git a/docs/data-sources/dns_zones.md b/docs/data-sources/dns_zones.md
diff --git a/docs/data-sources/pinto_dns_record.md b/docs/data-sources/pinto_dns_record.md
@@ -0,0 +1,36 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "pinto_dns_record Data Source - terraform-provider-project-pinto"
+subcategory: ""
+description: |-
+  
+---
+
+# pinto_dns_record (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **name** (String)
+- **type** (String)
+- **zone** (String)
+
+### Optional
+
+- **pinto_environment** (String)
+- **pinto_provider** (String)
+
+### Read-Only
+
+- **class** (String)
+- **data** (String)
+- **id** (String) The ID of this resource.
+- **ttl** (Number)
+
+
diff --git a/docs/data-sources/pinto_dns_records.md b/docs/data-sources/pinto_dns_records.md
@@ -0,0 +1,46 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "pinto_dns_records Data Source - terraform-provider-project-pinto"
+subcategory: ""
+description: |-
+  
+---
+
+# pinto_dns_records (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **zone** (String)
+
+### Optional
+
+- **name** (String)
+- **pinto_environment** (String)
+- **pinto_provider** (String)
+- **record_type** (String)
+
+### Read-Only
+
+- **id** (String) The ID of this resource.
+- **records** (List of Object) (see [below for nested schema](#nestedatt--records))
+
+<a id="nestedatt--records"></a>
+### Nested Schema for `records`
+
+Read-Only:
+
+- **class** (String)
+- **data** (String)
+- **id** (String)
+- **name** (String)
+- **ttl** (Number)
+- **type** (String)
+
+
diff --git a/docs/data-sources/pinto_dns_zone.md b/docs/data-sources/pinto_dns_zone.md
@@ -0,0 +1,31 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "pinto_dns_zone Data Source - terraform-provider-project-pinto"
+subcategory: ""
+description: |-
+  
+---
+
+# pinto_dns_zone (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- **name** (String)
+
+### Optional
+
+- **pinto_environment** (String)
+- **pinto_provider** (String)
+
+### Read-Only
+
+- **id** (String) The ID of this resource.
+
+
diff --git a/docs/data-sources/pinto_dns_zones.md b/docs/data-sources/pinto_dns_zones.md
@@ -0,0 +1,36 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "pinto_dns_zones Data Source - terraform-provider-project-pinto"
+subcategory: ""
+description: |-
+  
+---
+
+# pinto_dns_zones (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- **pinto_environment** (String)
+- **pinto_provider** (String)
+
+### Read-Only
+
+- **id** (String) The ID of this resource.
+- **zones** (List of Object) (see [below for nested schema](#nestedatt--zones))
+
+<a id="nestedatt--zones"></a>
+### Nested Schema for `zones`
+
+Read-Only:
+
+- **id** (String)
+- **name** (String)
+
+
diff --git a/docs/index.md b/docs/index.md
@@ -1,37 +1,31 @@
 ---
-page_title: "Project Pinto Provider"
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "project-pinto Provider"
 subcategory: ""
 description: |-
-  Terraform provider for interacting with Pinto API.
+  
 ---
 
-# Project Pinto Provider
+# project-pinto Provider
 
-The Project Pinto Provider can be used to interact with [Pinto](https://pinto.irgendwo.co/api/dns/swagger/index.html).
 
-## Example Usage
 
-Do not keep your authentication password in HCL for production environments, use Terraform environment variables.
 
-```terraform
-provider "pinto" {
-  base_url      = "https://pinto.irgendwo.co"
-  token_url     = "https://auth.pinto.irgendwo.co/connect/token"
-  client_id     = "client"
-  client_secret = "test123"
-  client_scope  = "openapigateway,nexus"
-}
-```
 
-## Argument Reference
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-The following arguments are supported:
+### Required
 
-- `base_url` - (String, Required) Overwrite the base-url of Pinto
-- `client_id` - (String, Optional) Client ID for client-credentials authentication (either this or API Key has to be set)
-- `client_secret` - (String, Optional) Client Secret for client-credentials authentication
-- `client_scope` - (String, Optional) Has to be "openapigateway,nexus"
-- `pinto_provider` - (String, Optional) Provider that pinto will use to store DNS entries
-- `pinto_environment` - (String, Optional) Environment at the provider that will be used to sore DNS entries
-- `api_key` - (String, Optional) API-Key to interact with Pinto (either this or client-credentials has to be set)
-- `token_url` - (String, Optional) Overrite token-url for authentication
+- **base_url** (String)
+- **credentials_id** (String)
+
+### Optional
+
+- **api_key** (String)
+- **client_id** (String)
+- **client_scope** (String)
+- **client_secret** (String, Sensitive)
+- **pinto_environment** (String)
+- **pinto_provider** (String)
+- **token_url** (String)