Skip to content

Commit a49b3ad

Browse files
committed
(Generated) Generate all documentation from schemas
1 parent 5862436 commit a49b3ad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+1884
-1655
lines changed

docs/data-sources/group.md

Lines changed: 33 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,53 @@
1-
# gitlab\_group
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
Provide details about a specific group in the gitlab provider.
7+
Note: exactly one of groupid or fullpath must be provided.
8+
---
9+
10+
# gitlab_group (Data Source)
211

312
Provide details about a specific group in the gitlab provider.
413

5-
## Example Usage
14+
> **Note**: exactly one of group_id or full_path must be provided.
615
7-
### By group's ID
16+
## Example Usage
817

9-
```hcl
18+
```terraform
19+
# By group's ID
1020
data "gitlab_group" "foo" {
1121
group_id = 123
1222
}
13-
```
1423
15-
### By group's full path
16-
17-
```hcl
24+
# By group's full path
1825
data "gitlab_group" "foo" {
1926
full_path = "foo/bar"
2027
}
2128
```
2229

23-
## Argument Reference
24-
25-
The following arguments are supported:
26-
27-
* `group_id` - (Optional) The ID of the group.
28-
29-
* `full_path` - (Optional) The full path of the group.
30-
31-
> **Note**: exactly one of group_id or full_path must be provided.
32-
33-
## Attributes Reference
34-
35-
The resource exports the following attributes:
36-
37-
* `id` - The unique ID assigned to the group.
38-
39-
* `name` - The name of this group.
40-
41-
* `path` - The path of the group.
42-
43-
* `description` - The description of the group.
44-
45-
* `lfs_enabled` - Boolean, is LFS enabled for projects in this group.
46-
47-
* `request_access_enabled` - Boolean, is request for access enabled to the group.
48-
49-
* `visibility_level` - Visibility level of the group. Possible values are `private`, `internal`, `public`.
30+
<!-- schema generated by tfplugindocs -->
31+
## Schema
5032

51-
* `parent_id` - Integer, ID of the parent group.
52-
53-
* `full_path` - The full path of the group.
33+
### Optional
5434

55-
* `full_name` - The full name of the group.
35+
- **full_path** (String) The full path of the group.
36+
- **group_id** (Number) The ID of the group.
37+
- **id** (String) The ID of this resource.
5638

57-
* `web_url` - Web URL of the group.
39+
### Read-Only
5840

59-
* `runners_token` - The group level registration token to use during runner setup.
41+
- **default_branch_protection** (Number) Whether developers and maintainers can push to the applicable default branch.
42+
- **description** (String) The description of the group.
43+
- **full_name** (String) The full name of the group.
44+
- **lfs_enabled** (Boolean) Boolean, is LFS enabled for projects in this group.
45+
- **name** (String) The name of this group.
46+
- **parent_id** (Number) Integer, ID of the parent group.
47+
- **path** (String) The path of the group.
48+
- **request_access_enabled** (Boolean) Boolean, is request for access enabled to the group.
49+
- **runners_token** (String, Sensitive) The group level registration token to use during runner setup.
50+
- **visibility_level** (String) Visibility level of the group. Possible values are `private`, `internal`, `public`.
51+
- **web_url** (String) Web URL of the group.
6052

61-
* `default_branch_protection` - Whether developers and maintainers can push to the applicable default branch.
6253

63-
[doc]: https://docs.gitlab.com/ee/api/groups.html#details-of-a-group

docs/data-sources/group_membership.md

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,58 @@
1-
# gitlab\_group\_membership
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_group_membership Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
Provide details about a list of group members in the gitlab provider. The results include id, username, name and more about the requested members.
7+
Note: exactly one of groupid or fullpath must be provided.
8+
---
9+
10+
# gitlab_group_membership (Data Source)
211

312
Provide details about a list of group members in the gitlab provider. The results include id, username, name and more about the requested members.
413

5-
## Example Usage
14+
> **Note**: exactly one of group_id or full_path must be provided.
615
7-
### By group's ID
16+
## Example Usage
817

9-
```hcl
18+
```terraform
19+
# By group's ID
1020
data "gitlab_group_membership" "example" {
1121
group_id = 123
1222
}
13-
```
14-
15-
### By group's full path
1623
17-
```hcl
24+
# By group's full path
1825
data "gitlab_group_membership" "example" {
1926
full_path = "foo/bar"
2027
}
2128
```
2229

23-
## Argument Reference
30+
<!-- schema generated by tfplugindocs -->
31+
## Schema
2432

25-
The following arguments are supported:
33+
### Optional
2634

27-
* `group_id` - (Optional) The ID of the group.
35+
- **access_level** (String) Only return members with the desired access level. Acceptable values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.
36+
- **full_path** (String) The full path of the group.
37+
- **group_id** (Number) The ID of the group.
38+
- **id** (String) The ID of this resource.
2839

29-
* `full_path` - (Optional) The full path of the group.
40+
### Read-Only
3041

31-
* `access_level` - (Optional) Only return members with the desired access level. Acceptable values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.
42+
- **members** (List of Object) The list of group members. (see [below for nested schema](#nestedatt--members))
3243

33-
> **Note**: exactly one of group_id or full_path must be provided.
44+
<a id="nestedatt--members"></a>
45+
### Nested Schema for `members`
46+
47+
Read-Only:
3448

35-
## Attributes Reference
49+
- **access_level** (String)
50+
- **avatar_url** (String)
51+
- **expires_at** (String)
52+
- **id** (Number)
53+
- **name** (String)
54+
- **state** (String)
55+
- **username** (String)
56+
- **web_url** (String)
3657

37-
The following attributes are exported:
3858

39-
* `members` - The list of group members.
40-
* `id` - The unique id assigned to the user by the gitlab server.
41-
* `username` - The username of the user.
42-
* `name` - The name of the user.
43-
* `state` - Whether the user is active or blocked.
44-
* `avatar_url` - The avatar URL of the user.
45-
* `web_url` - User's website URL.
46-
* `access_level` - One of five levels of access to the group.
47-
* `expires_at` - Expiration date for the group membership.

docs/data-sources/project.md

Lines changed: 57 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,73 @@
1-
# gitlab\_project
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "gitlab_project Data Source - terraform-provider-gitlab"
4+
subcategory: ""
5+
description: |-
6+
Provide details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.
7+
---
8+
9+
# gitlab_project (Data Source)
210

311
Provide details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.
412

513
## Example Usage
614

7-
```hcl
15+
```terraform
816
data "gitlab_project" "example" {
917
id = 30
1018
}
11-
```
1219
13-
```hcl
1420
data "gitlab_project" "example" {
1521
id = "foo/bar/baz"
1622
}
1723
```
1824

19-
## Argument Reference
20-
21-
The following arguments are supported:
22-
23-
* `id` - (Required) The integer or path with namespace that uniquely identifies the project within the gitlab install.
24-
25-
## Attributes Reference
26-
27-
The following attributes are exported:
28-
29-
* `path` - The path of the repository.
30-
31-
* `path_with_namespace` - The path of the repository with namespace.
32-
33-
* `namespace_id` - The namespace (group or user) of the project. Defaults to your user.
34-
See [`gitlab_group`](../resources/group) for an example.
35-
36-
* `description` - A description of the project.
37-
38-
* `default_branch` - The default branch for the project.
39-
40-
* `request_access_enabled` - Allow users to request member access.
41-
42-
* `issues_enabled` - Enable issue tracking for the project.
43-
44-
* `merge_requests_enabled` - Enable merge requests for the project.
45-
46-
* `pipelines_enabled` - Enable pipelines for the project.
47-
48-
* `wiki_enabled` - Enable wiki for the project.
49-
50-
* `snippets_enabled` - Enable snippets for the project.
51-
52-
* `lfs_enabled` - Enable LFS for the project.
53-
54-
* `visibility_level` - Repositories are created as private by default.
55-
56-
* `id` - Integer that uniquely identifies the project within the gitlab install.
57-
58-
* `ssh_url_to_repo` - URL that can be provided to `git clone` to clone the
59-
repository via SSH.
60-
61-
* `http_url_to_repo` - URL that can be provided to `git clone` to clone the
62-
repository via HTTP.
63-
64-
* `web_url` - URL that can be used to find the project in a browser.
65-
66-
* `runners_token` - Registration token to use during runner setup.
67-
68-
* `archived` - Whether the project is in read-only mode (archived).
69-
70-
* `remove_source_branch_after_merge` - Enable `Delete source branch` option by default for all new merge requests
71-
72-
* `packages_enabled` - Enable packages repository for the project.
73-
74-
* `push_rules` Push rules for the project (documented below).
75-
76-
## Nested Blocks
77-
78-
### push_rules
79-
80-
For information on push rules, consult the [GitLab documentation](https://docs.gitlab.com/ce/push_rules/push_rules.html#push-rules).
81-
82-
#### Attributes
83-
84-
* `author_email_regex` - All commit author emails must match this regex, e.g. `@my-company.com$`.
85-
86-
* `branch_name_regex` - All branch names must match this regex, e.g. `(feature|hotfix)\/*`.
87-
88-
* `commit_message_regex` - All commit messages must match this regex, e.g. `Fixed \d+\..*`.
89-
90-
* `commit_message_negative_regex` - No commit message is allowed to match this regex, for example `ssh\:\/\/`.
91-
92-
* `file_name_regex` - All commited filenames must not match this regex, e.g. `(jar|exe)$`.
93-
94-
* `commit_committer_check` - Users can only push commits to this repository that were committed with one of their own verified emails.
95-
96-
* `deny_delete_tag` - Deny deleting a tag.
97-
98-
* `member_check` - Restrict commits by author (email) to existing GitLab users.
99-
100-
* `prevent_secrets` - GitLab will reject any files that are likely to contain secrets.
25+
<!-- schema generated by tfplugindocs -->
26+
## Schema
27+
28+
### Optional
29+
30+
- **id** (String) The integer or path with namespace that uniquely identifies the project within the gitlab install.
31+
- **path_with_namespace** (String) The path of the repository with namespace.
32+
33+
### Read-Only
34+
35+
- **archived** (Boolean) Whether the project is in read-only mode (archived).
36+
- **default_branch** (String) The default branch for the project.
37+
- **description** (String) A description of the project.
38+
- **http_url_to_repo** (String) URL that can be provided to `git clone` to clone the
39+
- **issues_enabled** (Boolean) Enable issue tracking for the project.
40+
- **lfs_enabled** (Boolean) Enable LFS for the project.
41+
- **merge_requests_enabled** (Boolean) Enable merge requests for the project.
42+
- **name** (String) The name of the project.
43+
- **namespace_id** (Number) The namespace (group or user) of the project. Defaults to your user.
44+
- **path** (String) The path of the repository.
45+
- **pipelines_enabled** (Boolean) Enable pipelines for the project.
46+
- **push_rules** (List of Object) Push rules for the project. (see [below for nested schema](#nestedatt--push_rules))
47+
- **remove_source_branch_after_merge** (Boolean) Enable `Delete source branch` option by default for all new merge requests
48+
- **request_access_enabled** (Boolean) Allow users to request member access.
49+
- **runners_token** (String) Registration token to use during runner setup.
50+
- **snippets_enabled** (Boolean) Enable snippets for the project.
51+
- **ssh_url_to_repo** (String) URL that can be provided to `git clone` to clone the
52+
- **visibility_level** (String) Repositories are created as private by default.
53+
- **web_url** (String) URL that can be used to find the project in a browser.
54+
- **wiki_enabled** (Boolean) Enable wiki for the project.
55+
56+
<a id="nestedatt--push_rules"></a>
57+
### Nested Schema for `push_rules`
58+
59+
Read-Only:
60+
61+
- **author_email_regex** (String)
62+
- **branch_name_regex** (String)
63+
- **commit_committer_check** (Boolean)
64+
- **commit_message_negative_regex** (String)
65+
- **commit_message_regex** (String)
66+
- **deny_delete_tag** (Boolean)
67+
- **file_name_regex** (String)
68+
- **max_file_size** (Number)
69+
- **member_check** (Boolean)
70+
- **prevent_secrets** (Boolean)
71+
- **reject_unsigned_commits** (Boolean)
10172

102-
* `reject_unsigned_commits` - Reject commit when it’s not signed through GPG.
10373

104-
* `max_file_size` - Maximum file size (MB).

0 commit comments

Comments
 (0)