Add documentation

hkrutzer · Jan 7, 2025 · 3f670f7 · 3f670f7
1 parent 490d588
commit 3f670f7
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 13 deletions.
diff --git a/docs/data-sources/account.md b/docs/data-sources/account.md
@@ -0,0 +1,48 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "jambonz_account Data Source - jambonz"
+subcategory: ""
+description: |-
+  
+---
+
+# jambonz_account (Data Source)
+
+
+
+## Example Usage
+
+```terraform
+data "jambonz_account" "my_account" {
+  account_sid = "b42f0f47-3972-4361-a2a4-e69cf0e1e8c3"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `account_sid` (String)
+
+### Optional
+
+- `device_calling_application_sid` (String)
+- `registration_hook` (Attributes) (see [below for nested schema](#nestedatt--registration_hook))
+- `sip_realm` (String)
+
+### Read-Only
+
+- `name` (String)
+- `service_provider_sid` (String)
+
+<a id="nestedatt--registration_hook"></a>
+### Nested Schema for `registration_hook`
+
+Read-Only:
+
+- `method` (String)
+- `password` (String)
+- `url` (String)
+- `username` (String)
+- `webhook_sid` (String)
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,28 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "jambonz Provider"
+subcategory: ""
+description: |-
+  
+---
+
+# jambonz Provider
+
+
+
+## Example Usage
+
+```terraform
+provider "jambonz" {
+  endpoint = "https://jambonz.cloud/api/v1"
+  api_key  = "ff6dad71-6015-4a1a-af22-1dc97f71d3b1"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `api_key` (String) Jambonz API key. May also be provided via the JAMBONZ_API_KEY environment variable.
+- `endpoint` (String) Jambonz API endpoint. May also be provided via the JAMBONZ_ENDPOINT environment variable.
diff --git a/docs/resources/phone_number.md b/docs/resources/phone_number.md
@@ -0,0 +1,39 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "jambonz_phone_number Resource - jambonz"
+subcategory: ""
+description: |-
+  
+---
+
+# jambonz_phone_number (Resource)
+
+
+
+## Example Usage
+
+```terraform
+resource "jambonz_phone_number" "test_num" {
+  account_sid      = "85358b52-4264-4ec4-9d76-d5c5971b1ed5"
+  phone_number     = "45111111111"
+  voip_carrier_sid = "6cb36139-47bc-4a11-882d-80af726a022a"
+  application_sid  = "7e299ed5-53e5-4964-88d8-386a495b0c0c"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `account_sid` (String)
+- `phone_number` (String)
+- `voip_carrier_sid` (String)
+
+### Optional
+
+- `application_sid` (String)
+
+### Read-Only
+
+- `phone_number_sid` (String)
diff --git a/examples/data-sources/jambonz_account/data-source.tf b/examples/data-sources/jambonz_account/data-source.tf
@@ -0,0 +1,3 @@
+data "jambonz_account" "my_account" {
+  account_sid = "b42f0f47-3972-4361-a2a4-e69cf0e1e8c3"
+}
diff --git a/examples/data-sources/scaffolding_example/data-source.tf b/examples/data-sources/scaffolding_example/data-source.tf
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,3 +1,4 @@
-provider "scaffolding" {
-  # example configuration here
+provider "jambonz" {
+  endpoint = "https://jambonz.cloud/api/v1"
+  api_key  = "ff6dad71-6015-4a1a-af22-1dc97f71d3b1"
 }
diff --git a/examples/resources/jambonz_phone_number/resource.tf b/examples/resources/jambonz_phone_number/resource.tf
@@ -0,0 +1,6 @@
+resource "jambonz_phone_number" "test_num" {
+  account_sid      = "85358b52-4264-4ec4-9d76-d5c5971b1ed5"
+  phone_number     = "45111111111"
+  voip_carrier_sid = "6cb36139-47bc-4a11-882d-80af726a022a"
+  application_sid  = "7e299ed5-53e5-4964-88d8-386a495b0c0c"
+}
diff --git a/examples/resources/scaffolding_example/resource.tf b/examples/resources/scaffolding_example/resource.tf
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -42,12 +42,12 @@ func (p *JambonzProvider) Schema(ctx context.Context, req provider.SchemaRequest
 	resp.Schema = schema.Schema{
 		Attributes: map[string]schema.Attribute{
 			"endpoint": schema.StringAttribute{
-				MarkdownDescription: "Jambonz API endpoint",
-				Required:            true,
+				Description: "Jambonz API endpoint. May also be provided via the JAMBONZ_ENDPOINT environment variable.",
+				Required:    true,
 			},
 			"api_key": schema.StringAttribute{
-				MarkdownDescription: "Jambonz API key",
-				Required:            true,
+				Description: "Jambonz API key. May also be provided via the JAMBONZ_API_KEY environment variable.",
+				Required:    true,
 			},
 		},
 	}

diff --git a/tools/tools.go b/tools/tools.go
@@ -15,4 +15,4 @@ import (
 //go:generate terraform fmt -recursive ../examples/
 
 // Generate documentation.
-//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-dir .. -provider-name scaffolding
+//go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-dir .. -provider-name jambonz