Skip to content

Commit f85c47d

Browse files
github-actions[bot]vmvarela
authored andcommitted
docs: add top-level Description fields to enterprise team resources
- Add Description field to github_enterprise_team resource schema - Add Description field to github_enterprise_team_membership resource schema - Descriptions match the documentation pages and will be used for generated docs
1 parent 06226e1 commit f85c47d

2 files changed

Lines changed: 17 additions & 15 deletions

File tree

github/resource_github_enterprise_team.go

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import (
1818

1919
func resourceGithubEnterpriseTeam() *schema.Resource {
2020
return &schema.Resource{
21+
Description: "Manages a GitHub enterprise team.",
2122
CreateContext: resourceGithubEnterpriseTeamCreate,
2223
ReadContext: resourceGithubEnterpriseTeamRead,
2324
UpdateContext: resourceGithubEnterpriseTeamUpdate,
@@ -32,16 +33,16 @@ func resourceGithubEnterpriseTeam() *schema.Resource {
3233

3334
Schema: map[string]*schema.Schema{
3435
"enterprise_slug": {
35-
Type: schema.TypeString,
36-
Required: true,
37-
ForceNew: true,
38-
Description: "The slug of the enterprise (e.g. from the enterprise URL).",
36+
Type: schema.TypeString,
37+
Required: true,
38+
ForceNew: true,
39+
Description: "The slug of the enterprise (e.g. from the enterprise URL).",
3940
ValidateDiagFunc: validation.ToDiagFunc(validation.StringLenBetween(1, 255)),
4041
},
4142
"name": {
42-
Type: schema.TypeString,
43-
Required: true,
44-
Description: "The name of the enterprise team.",
43+
Type: schema.TypeString,
44+
Required: true,
45+
Description: "The name of the enterprise team.",
4546
ValidateDiagFunc: validation.ToDiagFunc(validation.StringLenBetween(1, 255)),
4647
},
4748
"description": {

github/resource_github_enterprise_team_membership.go

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,25 @@ import (
1515

1616
func resourceGithubEnterpriseTeamMembership() *schema.Resource {
1717
return &schema.Resource{
18+
Description: "Manages membership in a GitHub enterprise team.",
1819
CreateContext: resourceGithubEnterpriseTeamMembershipCreate,
1920
ReadContext: resourceGithubEnterpriseTeamMembershipRead,
2021
DeleteContext: resourceGithubEnterpriseTeamMembershipDelete,
2122
Importer: &schema.ResourceImporter{StateContext: resourceGithubEnterpriseTeamMembershipImport},
2223

2324
Schema: map[string]*schema.Schema{
2425
"enterprise_slug": {
25-
Type: schema.TypeString,
26-
Required: true,
27-
ForceNew: true,
28-
Description: "The slug of the enterprise.",
26+
Type: schema.TypeString,
27+
Required: true,
28+
ForceNew: true,
29+
Description: "The slug of the enterprise.",
2930
ValidateDiagFunc: validation.ToDiagFunc(validation.StringLenBetween(1, 255)),
3031
},
3132
"enterprise_team": {
32-
Type: schema.TypeString,
33-
Required: true,
34-
ForceNew: true,
35-
Description: "The slug or ID of the enterprise team.",
33+
Type: schema.TypeString,
34+
Required: true,
35+
ForceNew: true,
36+
Description: "The slug or ID of the enterprise team.",
3637
ValidateDiagFunc: validation.ToDiagFunc(validation.StringLenBetween(1, 255)),
3738
},
3839
"username": {

0 commit comments

Comments
 (0)