Skip to content

Commit 2b9be35

Browse files
doc: Add missed ID attribute on data github_app
1 parent 4349001 commit 2b9be35

4 files changed

Lines changed: 39 additions & 39 deletions

File tree

docs/data-sources/app.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
page_title: "github_app (Data Source) - GitHub"
3+
subcategory: ""
34
description: |-
45
Get information about an app.
56
---
67

78
# github_app (Data Source)
89

9-
Use this data source to retrieve information about an app.
10+
Get information about an app.
1011

1112
## Example Usage
1213

@@ -16,18 +17,16 @@ data "github_app" "foobar" {
1617
}
1718
```
1819

19-
## Argument Reference
20+
<!-- schema generated by tfplugindocs -->
21+
## Schema
2022

21-
The following arguments are supported:
23+
### Required
2224

23-
- `slug` - (Required) The URL-friendly name of your GitHub App.
25+
- `slug` (String) The URL-friendly name of your GitHub App.
2426

25-
## Attribute Reference
27+
### Read-Only
2628

27-
The following additional attributes are exported:
28-
29-
- `description` - The app's description.
30-
31-
- `name` - The app's full name.
32-
33-
- `node_id` - The Node ID of the app.
29+
- `description` (String) The app's description.
30+
- `id` (String) The ID of the app.
31+
- `name` (String) The app's full name.
32+
- `node_id` (String) The Node ID of the app.
File renamed without changes.

github/data_source_github_app.go

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,33 @@ import (
1111
func dataSourceGithubApp() *schema.Resource {
1212
return &schema.Resource{
1313
ReadContext: dataSourceGithubAppRead,
14+
Description: "Get information about an app.",
1415

1516
Schema: map[string]*schema.Schema{
17+
"id": {
18+
Type: schema.TypeString,
19+
Computed: true,
20+
Description: "The ID of the app.",
21+
},
1622
"slug": {
17-
Type: schema.TypeString,
18-
Required: true,
23+
Type: schema.TypeString,
24+
Required: true,
25+
Description: "The URL-friendly name of your GitHub App.",
1926
},
2027
"description": {
21-
Type: schema.TypeString,
22-
Computed: true,
28+
Type: schema.TypeString,
29+
Computed: true,
30+
Description: "The app's description.",
2331
},
2432
"name": {
25-
Type: schema.TypeString,
26-
Computed: true,
33+
Type: schema.TypeString,
34+
Computed: true,
35+
Description: "The app's full name.",
2736
},
2837
"node_id": {
29-
Type: schema.TypeString,
30-
Computed: true,
38+
Type: schema.TypeString,
39+
Computed: true,
40+
Description: "The Node ID of the app.",
3141
},
3242
},
3343
}

templates/data-sources/app.md.tmpl

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,20 @@
11
---
22
page_title: "{{.Name}} ({{.Type}}) - {{.RenderedProviderName}}"
3+
subcategory: ""
34
description: |-
4-
Get information about an app.
5+
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
56
---
67

78
# {{.Name}} ({{.Type}})
89

9-
Use this data source to retrieve information about an app.
10+
{{ .Description | trimspace }}
1011

11-
## Example Usage
12-
13-
{{ tffile "examples/data-sources/app/example_1.tf" }}
14-
15-
## Argument Reference
16-
17-
The following arguments are supported:
18-
19-
- `slug` - (Required) The URL-friendly name of your GitHub App.
12+
{{- if .HasExamples }}
2013

21-
## Attribute Reference
22-
23-
The following additional attributes are exported:
24-
25-
- `description` - The app's description.
26-
27-
- `name` - The app's full name.
14+
## Example Usage
15+
{{ range .ExampleFiles }}
16+
{{ tffile . }}
17+
{{- end }}
18+
{{- end }}
2819

29-
- `node_id` - The Node ID of the app.
20+
{{ .SchemaMarkdown | trimspace }}

0 commit comments

Comments
 (0)