Skip to content

Commit 663bd3d

Browse files
committed
Update actions_organization_oidc_subject_claim_customization_template docs to generate from Schema contents
Signed-off-by: Timo Sand <[email protected]>
1 parent 03bb0ef commit 663bd3d

3 files changed

Lines changed: 12 additions & 15 deletions

docs/data-sources/actions_organization_oidc_subject_claim_customization_template.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ data "github_actions_organization_oidc_subject_claim_customization_template" "ex
1515
}
1616
```
1717
18-
## Argument Reference
18+
<!-- schema generated by tfplugindocs -->
19+
## Schema
1920
20-
## Attributes Reference
21+
### Read-Only
2122
22-
- `include_claim_keys` - The list of OpenID Connect claim keys.
23+
- `id` (String) The ID of this resource.
24+
- `include_claim_keys` (List of String) The list of OpenID Connect claim keys

github/data_source_github_actions_organization_oidc_subject_claim_customization_template.go

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ func dataSourceGithubActionsOrganizationOIDCSubjectClaimCustomizationTemplate()
88
return &schema.Resource{
99
Read: dataSourceGithubActionsOrganizationOIDCSubjectClaimCustomizationTemplateRead,
1010

11+
Description: "Use this data source to retrieve the OpenID Connect subject claim customization template for an organization",
12+
1113
Schema: map[string]*schema.Schema{
1214
"include_claim_keys": {
13-
Type: schema.TypeList,
14-
Computed: true,
15+
Type: schema.TypeList,
16+
Computed: true,
17+
Description: "The list of OpenID Connect claim keys",
1518
Elem: &schema.Schema{
1619
Type: schema.TypeString,
1720
},

templates/data-sources/actions_organization_oidc_subject_claim_customization_template.md.tmpl

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,12 @@ description: |-
44
Get a GitHub Actions organization OpenID Connect customization template
55
---
66
7-
{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates.
8-
9-
For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}}
10-
117
# {{.Name}} ({{.Type}})
128
13-
Use this data source to retrieve the OpenID Connect subject claim customization template for an organization
9+
{{ .Description | trimspace }}
1410
1511
## Example Usage
1612
1713
{{tffile "examples/data-sources/actions_organization_oidc_subject_claim_customization_template/example_1.tf"}}
1814
19-
## Argument Reference
20-
21-
## Attributes Reference
22-
23-
- `include_claim_keys` - The list of OpenID Connect claim keys.
15+
{{ .SchemaMarkdown | trimspace }}

0 commit comments

Comments
 (0)