Skip to content

Commit 0ca380b

Browse files
committed
Update resource docs to match a consistent upstream API pattern
1 parent 706f719 commit 0ca380b

12 files changed

+19
-14
lines changed

docs/data-sources/project_issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: |-
1111

1212
The `gitlab_project_issue` data source allows to retrieve details about an issue in a project.
1313

14-
**Upstream API:** [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
14+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
1515

1616
## Example Usage
1717

docs/data-sources/project_issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: |-
1111

1212
The `gitlab_project_issues` data source allows to retrieve details about issues in a project.
1313

14-
**Upstream API:** [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
14+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
1515

1616
## Example Usage
1717

docs/data-sources/project_tag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_project_tag Data Source - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_project_tag data source allows details of a project tag to be retrieved by its name.
7-
Upstream API : GitLab API docs https://docs.gitlab.com/ee/api/tags.html
7+
Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/tags.html
88
---
99

1010
# gitlab_project_tag (Data Source)
1111

1212
The `gitlab_project_tag` data source allows details of a project tag to be retrieved by its name.
1313

14-
**Upstream API** : [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html)
14+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html)
1515

1616
## Example Usage
1717

docs/resources/group.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ subcategory: ""
55
description: |-
66
This resource allows you to create and manage GitLab groups.
77
Note your provider will need to be configured with admin-level access for this resource to work.
8+
Upstream API: GitLab Groups API https://docs.gitlab.com/ee/api/groups.html
89
---
910

1011
# gitlab_group (Resource)
1112

1213
This resource allows you to create and manage GitLab groups.
14+
1315
Note your provider will need to be configured with admin-level access for this resource to work.
1416

17+
**Upstream API**: [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html)
18+
1519
## Example Usage
1620

1721
```terraform

docs/resources/project_issue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `gitlab_project_issue` resource allows to manage the lifecycle of an issue w
1717

1818
~> **Experimental**: while the base functionality of this resource works, it may be subject to minor change.
1919

20-
**Upstream API:** [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
20+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)
2121

2222
## Example Usage
2323

docs/resources/project_tag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ page_title: "gitlab_project_tag Resource - terraform-provider-gitlab"
44
subcategory: ""
55
description: |-
66
The gitlab_project_tag resource allows to manage the lifecycle of a tag in a project.
7-
Upstream API : GitLab API docs https://docs.gitlab.com/ee/api/tags.html
7+
Upstream API: GitLab API docs https://docs.gitlab.com/ee/api/tags.html
88
---
99

1010
# gitlab_project_tag (Resource)
1111

1212
The `gitlab_project_tag` resource allows to manage the lifecycle of a tag in a project.
1313

14-
**Upstream API** : [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html)
14+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html)
1515

1616
## Example Usage
1717

internal/provider/data_source_gitlab_project_issue.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var _ = registerDataSource("gitlab_project_issue", func() *schema.Resource {
1212
return &schema.Resource{
1313
Description: `The ` + "`gitlab_project_issue`" + ` data source allows to retrieve details about an issue in a project.
1414
15-
**Upstream API:** [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)`,
15+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)`,
1616

1717
ReadContext: dataSourceGitlabProjectIssueRead,
1818
Schema: datasourceSchemaFromResourceSchema(gitlabProjectIssueGetSchema(), "project", "iid"),

internal/provider/data_source_gitlab_project_issues.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var _ = registerDataSource("gitlab_project_issues", func() *schema.Resource {
3131
return &schema.Resource{
3232
Description: `The ` + "`gitlab_project_issues`" + ` data source allows to retrieve details about issues in a project.
3333
34-
**Upstream API:** [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)`,
34+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/issues.html)`,
3535

3636
ReadContext: dataSourceGitlabProjectIssuesRead,
3737
Schema: map[string]*schema.Schema{

internal/provider/data_source_gitlab_project_tag.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ var _ = registerDataSource("gitlab_project_tag", func() *schema.Resource {
1313
return &schema.Resource{
1414
Description: `The ` + "`gitlab_project_tag`" + ` data source allows details of a project tag to be retrieved by its name.
1515
16-
**Upstream API** : [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html)`,
16+
**Upstream API**: [GitLab API docs](https://docs.gitlab.com/ee/api/tags.html)`,
1717

1818
ReadContext: dataSourceGitlabProjectTagRead,
1919
Schema: map[string]*schema.Schema{

internal/provider/resource_gitlab_group.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ import (
1717

1818
var _ = registerResource("gitlab_group", func() *schema.Resource {
1919
return &schema.Resource{
20-
Description: "This resource allows you to create and manage GitLab groups.\n" +
21-
"Note your provider will need to be configured with admin-level access for this resource to work.",
20+
Description: "This resource allows you to create and manage GitLab groups.\n\n" +
21+
"Note your provider will need to be configured with admin-level access for this resource to work.\n\n" +
22+
"**Upstream API**: [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html)",
2223

2324
CreateContext: resourceGitlabGroupCreate,
2425
ReadContext: resourceGitlabGroupRead,

0 commit comments

Comments
 (0)