Add docs for CA Product data source

jetstack · Mar 4, 2025 · aa8d708 · aa8d708
1 parent 84d5445
commit aa8d708
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 7 deletions.
diff --git a/docs/data-sources/ca_product.md b/docs/data-sources/ca_product.md
@@ -3,12 +3,12 @@
 page_title: "tlspc_ca_product Data Source - tlspc"
 subcategory: ""
 description: |-
-  
+  Look up the ID of a CA Product Option
 ---
 
 # tlspc_ca_product (Data Source)
 
-
+Look up the ID of a CA Product Option
 
 ## Example Usage
 
@@ -25,9 +25,19 @@ data "tlspc_ca_product" "built_in" {
 
 ### Required
 
-- `ca_name` (String)
-- `product_option` (String)
-- `type` (String)
+- `ca_name` (String) Name of Certificate Authority
+- `product_option` (String) Name of Product Option
+- `type` (String) Type of Certificate Authority, valid values include:
+    * BUILTIN
+    * DIGICERT
+    * GLOBALSIGN
+    * ENTRUST
+    * MICROSOFT
+    * ACME
+    * ZTPKI
+    * GLOBALSIGNMSSL
+    * TPP
+    * CONNECTOR
 
 ### Read-Only
 

diff --git a/internal/provider/ca_product_data_source.go b/internal/provider/ca_product_data_source.go
@@ -59,18 +59,32 @@ func (d *caProductDataSource) Metadata(_ context.Context, req datasource.Metadat
 // Schema defines the schema for the data source.
 func (d *caProductDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
+		MarkdownDescription: "Look up the ID of a CA Product Option",
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Computed: true,
 			},
 			"type": schema.StringAttribute{
 				Required: true,
+				MarkdownDescription: `Type of Certificate Authority, valid values include:
+    * BUILTIN
+    * DIGICERT
+    * GLOBALSIGN
+    * ENTRUST
+    * MICROSOFT
+    * ACME
+    * ZTPKI
+    * GLOBALSIGNMSSL
+    * TPP
+    * CONNECTOR`,
 			},
 			"ca_name": schema.StringAttribute{
-				Required: true,
+				Required:            true,
+				MarkdownDescription: "Name of Certificate Authority",
 			},
 			"product_option": schema.StringAttribute{
-				Required: true,
+				Required:            true,
+				MarkdownDescription: "Name of Product Option",
 			},
 		},
 	}