Add support to Groups APIs for DefaultBranchDefaults #1971

RicePatrick · 2024-07-12T19:34:58Z

This Pull Request adds support for the new default_branch_protection_defaults attribute to the Group APIs. These were added in GitLab 17.0, replacing the default_branch_protection integer, so that attribute is now marked as deprecated as well.

Documentation: https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults

Note: The structure of the API requests is weird. Even though allowed_to_push and allowed_to_merge only expect 1 access level, they do in fact require an array of objects with "access_level" being the key.

Here is an example request and responss to show the API fingerprint, since I don't think it's exactly clear from the documentation how it's supposed to work 😆 :

{"default_branch_protection_defaults":{"allowed_to_push":[{"access_level": 40}], "allow_force_push":false, "allowed_to_merge":[{"access_level":30}], "developer_can_initial_push": true}}

{"id":3,"web_url":"http://dcfd377d91d2/groups/test","name":"test","path":"test","description":"","visibility":"public","share_with_group_lock":false,"require_two_factor_authentication":false,"two_factor_grace_period":48,"project_creation_level":"developer","auto_devops_enabled":null,"subgroup_creation_level":"maintainer","emails_disabled":false,"emails_enabled":true,"mentions_disabled":null,"lfs_enabled":true,"math_rendering_limits_enabled":true,"lock_math_rendering_limits_enabled":false,"default_branch":null,"default_branch_protection":2,"default_branch_protection_defaults":{"allowed_to_push":[{"access_level":40}],"allow_force_push":false,"allowed_to_merge":[{"access_level":30}],"developer_can_initial_push":true},"avatar_url":null,"request_access_enabled":true,"full_name":"test","full_path":"test","created_at":"2024-07-12T18:58:09.554Z","parent_id":null,"organization_id":1,"shared_runners_setting":"enabled","ldap_cn":null,"ldap_access":null,"marked_for_deletion_on":null,"wiki_access_level":"enabled","repository_storage":null,"duo_features_enabled":true,"lock_duo_features_enabled":false,"shared_with_groups":[],"runners_token":"GR13489413zpxPbiz-s5TLjsMNi7x","enabled_git_access_protocol":"all","prevent_sharing_groups_outside_hierarchy":false,"projects":[],"shared_projects":[],"shared_runners_minutes_limit":null,"extra_shared_runners_minutes_limit":null,"prevent_forking_outside_group":false,"service_access_tokens_expiration_enforced":true,"membership_lock":false,"ip_restriction_ranges":null}

RicePatrick · 2024-07-12T23:39:19Z

@svanharmelen - This should be ready for review. Let me know what you think about the naming for GroupAccessLevel, or if there's a better struct already for that use-case. It's an odd structure, so I was having trouble naming it 😄

svanharmelen

Have a few suggestion, but other then that I'm good with this...

svanharmelen · 2024-07-13T09:08:50Z

groups.go

@@ -90,6 +95,16 @@ type Group struct {

 	// Deprecated: Use EmailsEnabled instead
 	EmailsDisabled bool `json:"emails_disabled"`
+
+	// Deprecated: Use DefaultBranchProtectionDefaults instead
+	DefaultBranchProtection int `json:"default_branch_protection"`


I don't think this is deprecated looking at the docs.

@svanharmelen - Hm, some of the conversations I've had with the GitLab employees certainly seem to insinuate it is, so I never thought about the fact that it isn't documented that way 🤔

I'll talk with them on Monday and confirm it's status, then I'll either update the documentation or update this PR. Thanks for the great catch!

https://gitlab.com/gitlab-org/gitlab/-/issues/462164#note_1998263497 for the question to GitLab

groups.go

svanharmelen · 2024-07-13T09:13:38Z

groups.go

+	DefaultBranchProtection int `json:"default_branch_protection"`
+}
+
+// GroupAccessLevel represents an entry in a Group defining the access level for default protections


Suggested change

// GroupAccessLevel represents an entry in a Group defining the access level for default protections

// GroupAccessLevel represents default branch protection defaults access levels.

Still not great, but close enough.

svanharmelen · 2024-07-13T09:14:02Z

groups.go

+
+// GroupAccessLevel represents an entry in a Group defining the access level for default protections
+//
+// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults


Suggested change

// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults

// GitLab API docs:

// https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults

svanharmelen · 2024-07-13T09:14:51Z

groups.go


 	// Deprecated: Use EmailsEnabled instead
 	EmailsDisabled *bool `url:"emails_disabled,omitempty" json:"emails_disabled,omitempty"`
+
+	// Deprecated: User DefaultBranchProtectionDefaults instead
+	DefaultBranchProtection *int `url:"default_branch_protection,omitempty" json:"default_branch_protection,omitempty"`


Same for this one of course (re the deprecation).

svanharmelen · 2024-07-13T09:15:39Z

groups.go

+	DefaultBranchProtection *int `url:"default_branch_protection,omitempty" json:"default_branch_protection,omitempty"`
+}
+
+// DefaultBranchProtectionDefaultsOptions represents the available options for using default_branch_protection_defaults in CreateGroup() or UpdateGroup()


Please keep comments below 80 chars when possible...

Suggested change

// DefaultBranchProtectionDefaultsOptions represents the available options for using default_branch_protection_defaults in CreateGroup() or UpdateGroup()

// DefaultBranchProtectionDefaultsOptions represents the available options for

// using default_branch_protection_defaults in CreateGroup() or UpdateGroup()

svanharmelen · 2024-07-13T09:15:47Z

groups.go

+
+// DefaultBranchProtectionDefaultsOptions represents the available options for using default_branch_protection_defaults in CreateGroup() or UpdateGroup()
+//
+// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults


Suggested change

// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults

// GitLab API docs:

// https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults

svanharmelen · 2024-07-13T09:16:45Z

groups.go

+	AllowedToPush           []GroupAccessLevel `url:"allowed_to_push,omitempty" json:"allowed_to_push,omitempty"`
+	AllowForcePush          bool               `url:"allow_force_push,omitempty" json:"allow_force_push,omitempty"`
+	AllowedToMerge          []GroupAccessLevel `url:"allowed_to_merge.omitempty" json:"allowed_to_merge.omitempty"`
+	DeveloperCanInitialPush bool               `url:"developer_can_initial_push,omitempty" json:"developer_can_initial_push,omitempty"`


However weird it may be, these should all be pointers as this is an options struct...

Suggested change

AllowedToPush []GroupAccessLevel `url:"allowed_to_push,omitempty" json:"allowed_to_push,omitempty"`

AllowForcePush bool `url:"allow_force_push,omitempty" json:"allow_force_push,omitempty"`

AllowedToMerge []GroupAccessLevel `url:"allowed_to_merge.omitempty" json:"allowed_to_merge.omitempty"`

DeveloperCanInitialPush bool `url:"developer_can_initial_push,omitempty" json:"developer_can_initial_push,omitempty"`

AllowedToPush *[]*GroupAccessLevel `url:"allowed_to_push,omitempty" json:"allowed_to_push,omitempty"`

AllowForcePush *bool `url:"allow_force_push,omitempty" json:"allow_force_push,omitempty"`

AllowedToMerge *[]*GroupAccessLevel `url:"allowed_to_merge.omitempty" json:"allowed_to_merge.omitempty"`

DeveloperCanInitialPush *bool `url:"developer_can_initial_push,omitempty" json:"developer_can_initial_push,omitempty"`

svanharmelen · 2024-07-13T09:17:19Z

groups.go


 	// Deprecated: Use EmailsEnabled instead
 	EmailsDisabled *bool `url:"emails_disabled,omitempty" json:"emails_disabled,omitempty"`
+
+	// Deprecated: Use DefaultBranchProtectionDefaults instead
+	DefaultBranchProtection *int `url:"default_branch_protection,omitempty" json:"default_branch_protection,omitempty"`


RicePatrick · 2024-07-13T23:51:25Z

Everything other than the deprecation notices has been fixed; will update Deprecation noticed in either direction on Monday and let you know!

RicePatrick · 2024-07-15T13:46:45Z

@svanharmelen - Documentation is updated and now shows the fields as Deprecated, so having them labelled as deprecated is correct: https://docs.gitlab.com/ee/api/groups.html#new-group

Reference from conversations with GitLab: https://gitlab.com/gitlab-org/gitlab/-/issues/462164#note_1999148308

Add support to Groups APIs for DefaultBranchDefaults

7116698

svanharmelen suggested changes Jul 13, 2024

View reviewed changes

Fix comments and pointers

473bbdf

svanharmelen approved these changes Jul 16, 2024

View reviewed changes

svanharmelen merged commit 32b7839 into xanzy:main Jul 16, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support to Groups APIs for DefaultBranchDefaults #1971

Add support to Groups APIs for DefaultBranchDefaults #1971

RicePatrick commented Jul 12, 2024

RicePatrick commented Jul 12, 2024

svanharmelen left a comment

svanharmelen Jul 13, 2024

RicePatrick Jul 13, 2024

RicePatrick Jul 13, 2024

svanharmelen Jul 13, 2024

svanharmelen Jul 13, 2024

svanharmelen Jul 13, 2024

svanharmelen Jul 13, 2024

svanharmelen Jul 13, 2024

svanharmelen Jul 13, 2024

svanharmelen Jul 13, 2024

RicePatrick commented Jul 13, 2024

RicePatrick commented Jul 15, 2024

	// GroupAccessLevel represents an entry in a Group defining the access level for default protections
	// GroupAccessLevel represents default branch protection defaults access levels.

	// GitLab API docs: https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults
	// GitLab API docs:
	// https://docs.gitlab.com/ee/api/groups.html#options-for-default_branch_protection_defaults

	// DefaultBranchProtectionDefaultsOptions represents the available options for using default_branch_protection_defaults in CreateGroup() or UpdateGroup()
	// DefaultBranchProtectionDefaultsOptions represents the available options for
	// using default_branch_protection_defaults in CreateGroup() or UpdateGroup()

Add support to Groups APIs for DefaultBranchDefaults #1971

Add support to Groups APIs for DefaultBranchDefaults #1971

Conversation

RicePatrick commented Jul 12, 2024

RicePatrick commented Jul 12, 2024

svanharmelen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RicePatrick commented Jul 13, 2024

RicePatrick commented Jul 15, 2024