Skip to content

Commit 5d4ec2d

Browse files
authored
Improve documentation for group_type and group_id values (#571)
**Description** This PR improves the documentation for: - `group_type` in `harbor_group` - `group_id` in `harbor_project_member_group` **Changes** - Replaced the previous hardcoded note (`group type 3 is OIDC group`) with a complete mapping of all valid numeric values. - Clearly documented the allowed values: - `1` = `ldap` - `2` = `internal` - `3` = `oidc` **Why** The previous documentation only mentioned that value `3` corresponds to OIDC, which was incomplete and potentially confusing. --------- Signed-off-by: Yann ILAS <yann.ilas@gmail.com>
1 parent 08e699a commit 5d4ec2d

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

docs/resources/group.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ resource "harbor_group" "storage-group" {
2525
### Required
2626

2727
- `group_name` (String) The name of the group.
28-
- `group_type` (Number) 3. Note: group type 3 is OIDC group.
28+
- `group_type` (Number) The numeric identifier of the group type. Valid values are `1`, `2`, or `3` :
29+
- `1` = `ldap`
30+
- `2` = `internal`
31+
- `3` = `oidc`
2932

3033
### Optional
3134

docs/resources/project_member_group.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@ resource "harbor_project_member_group" "main" {
3838

3939
### Optional
4040

41-
- `group_id` (Number) 3. Note: group type 3 is OIDC group.
41+
- `group_id` (Number) The numeric identifier of the group type. Valid values are `1`, `2`, or `3` :
42+
- `1` = `ldap`
43+
- `2` = `internal`
44+
- `3` = `oidc`
4245
- `group_name` (String) The name of the group member entity.
4346
- `ldap_group_dn` (String) The distinguished name of the group within AD/LDAP.
4447

0 commit comments

Comments
 (0)