Skip to content

Commit 7d339b6

Browse files
authored
Merge pull request #54 from jetstack/ca_prod_docs
Add docs for CA Product data source
2 parents b03ba02 + 8c0f42f commit 7d339b6

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

docs/data-sources/ca_product.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "tlspc_ca_product Data Source - tlspc"
44
subcategory: ""
55
description: |-
6-
6+
Look up the ID of a Certificate Authority Product Option
77
---
88

99
# tlspc_ca_product (Data Source)
1010

11-
11+
Look up the ID of a Certificate Authority Product Option
1212

1313
## Example Usage
1414

@@ -25,9 +25,19 @@ data "tlspc_ca_product" "built_in" {
2525

2626
### Required
2727

28-
- `ca_name` (String)
29-
- `product_option` (String)
30-
- `type` (String)
28+
- `ca_name` (String) Name of Certificate Authority
29+
- `product_option` (String) Name of Product Option
30+
- `type` (String) Type of Certificate Authority, valid values include:
31+
* BUILTIN
32+
* DIGICERT
33+
* GLOBALSIGN
34+
* ENTRUST
35+
* MICROSOFT
36+
* ACME
37+
* ZTPKI
38+
* GLOBALSIGNMSSL
39+
* TPP
40+
* CONNECTOR
3141

3242
### Read-Only
3343

internal/provider/ca_product_data_source.go

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,32 @@ func (d *caProductDataSource) Metadata(_ context.Context, req datasource.Metadat
5959
// Schema defines the schema for the data source.
6060
func (d *caProductDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
6161
resp.Schema = schema.Schema{
62+
MarkdownDescription: "Look up the ID of a Certificate Authority Product Option",
6263
Attributes: map[string]schema.Attribute{
6364
"id": schema.StringAttribute{
6465
Computed: true,
6566
},
6667
"type": schema.StringAttribute{
6768
Required: true,
69+
MarkdownDescription: `Type of Certificate Authority, valid values include:
70+
* BUILTIN
71+
* DIGICERT
72+
* GLOBALSIGN
73+
* ENTRUST
74+
* MICROSOFT
75+
* ACME
76+
* ZTPKI
77+
* GLOBALSIGNMSSL
78+
* TPP
79+
* CONNECTOR`,
6880
},
6981
"ca_name": schema.StringAttribute{
70-
Required: true,
82+
Required: true,
83+
MarkdownDescription: "Name of Certificate Authority",
7184
},
7285
"product_option": schema.StringAttribute{
73-
Required: true,
86+
Required: true,
87+
MarkdownDescription: "Name of Product Option",
7488
},
7589
},
7690
}

0 commit comments

Comments
 (0)