Merge branch 'refactor/expose-missing-mention-disabled-group-api' into 'master'

Expose missing disable mention value on group API

See merge request gitlab-org/gitlab!23070

app/graphql/types/group_type.rb

@@ -17,6 +17,9 @@ module Types
             group.avatar_url(only_path: false)
           end
 
+    field :mentions_disabled, GraphQL::BOOLEAN_TYPE, null: true,
+          description: 'Indicates if a group is disabled from getting mentioned'
+
     field :parent, GroupType, null: true,
           description: 'Parent group',
           resolve: -> (obj, _args, _ctx) { Gitlab::Graphql::Loaders::BatchModelLoader.new(Group, obj.parent_id).find }

changelogs/unreleased/refactor-expose-missing-mention-disabled-group-api.yml

+---
+title: Expose mentions_disabled value via group API
+merge_request: 23070
+author: Fabio Huser
+type: added

doc/api/graphql/reference/gitlab_schema.graphql

@@ -2594,6 +2594,11 @@ type Group {
   """
   lfsEnabled: Boolean
 
+  """
+  Indicates if a group is disabled from getting mentioned
+  """
+  mentionsDisabled: Boolean
+
   """
   Name of the namespace
   """

doc/api/graphql/reference/gitlab_schema.json

@@ -3460,6 +3460,20 @@
               "isDeprecated": false,
               "deprecationReason": null
             },
+            {
+              "name": "mentionsDisabled",
+              "description": "Indicates if a group is disabled from getting mentioned",
+              "args": [
+
+              ],
+              "type": {
+                "kind": "SCALAR",
+                "name": "Boolean",
+                "ofType": null
+              },
+              "isDeprecated": false,
+              "deprecationReason": null
+            },
             {
               "name": "name",
               "description": "Name of the namespace",

doc/api/graphql/reference/index.md

@@ -393,6 +393,7 @@ Autogenerated return type of EpicTreeReorder
 | `userPermissions` | GroupPermissions! | Permissions for the current user on the resource |
 | `webUrl` | String! | Web URL of the group |
 | `avatarUrl` | String | Avatar URL of the group |
+| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned |
 | `parent` | Group | Parent group |
 | `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace |
 | `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace |

doc/api/groups.md

@@ -40,6 +40,7 @@ GET /groups
     "auto_devops_enabled": null,
     "subgroup_creation_level": "owner",
     "emails_disabled": null,
+    "mentions_disabled": null,
     "lfs_enabled": true,
     "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
     "web_url": "http://localhost:3000/groups/foo-bar",
@@ -73,6 +74,7 @@ GET /groups?statistics=true
     "auto_devops_enabled": null,
     "subgroup_creation_level": "owner",
     "emails_disabled": null,
+    "mentions_disabled": null,
     "lfs_enabled": true,
     "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
     "web_url": "http://localhost:3000/groups/foo-bar",
@@ -144,6 +146,7 @@ GET /groups/:id/subgroups
     "auto_devops_enabled": null,
     "subgroup_creation_level": "owner",
     "emails_disabled": null,
+    "mentions_disabled": null,
     "lfs_enabled": true,
     "avatar_url": "http://gitlab.example.com/uploads/group/avatar/1/foo.jpg",
     "web_url": "http://gitlab.example.com/groups/foo-bar",
@@ -486,6 +489,7 @@ Parameters:
 | `auto_devops_enabled`                | boolean | no       | Default to Auto DevOps pipeline for all projects within this group. |
 | `subgroup_creation_level`            | integer | no       | Allowed to create subgroups. Can be `owner` (Owners), or `maintainer` (Maintainers). |
 | `emails_disabled`                    | boolean | no       | Disable email notifications |
+| `mentions_disabled`                  | boolean | no       | Disable the capability of a group from getting mentioned |
 | `lfs_enabled`                        | boolean | no       | Enable/disable Large File Storage (LFS) for the projects in this group. |
 | `request_access_enabled`             | boolean | no       | Allow users to request member access. |
 | `parent_id`                          | integer | no       | The parent group ID for creating nested group. |
@@ -531,6 +535,7 @@ PUT /groups/:id
 | `auto_devops_enabled`                | boolean | no       | Default to Auto DevOps pipeline for all projects within this group. |
 | `subgroup_creation_level`            | integer | no       | Allowed to create subgroups. Can be `owner` (Owners), or `maintainer` (Maintainers). |
 | `emails_disabled`                    | boolean | no       | Disable email notifications |
+| `mentions_disabled`                  | boolean | no       | Disable the capability of a group from getting mentioned |
 | `lfs_enabled` (optional)             | boolean | no       | Enable/disable Large File Storage (LFS) for the projects in this group. |
 | `request_access_enabled`             | boolean | no       | Allow users to request member access. |
 | `file_template_project_id`           | integer | no       | **(PREMIUM)** The ID of a project to load custom file templates from. |

lib/api/entities.rb

@@ -414,6 +414,7 @@ module API
       expose :auto_devops_enabled
       expose :subgroup_creation_level_str, as: :subgroup_creation_level
       expose :emails_disabled
+      expose :mentions_disabled
       expose :lfs_enabled?, as: :lfs_enabled
       expose :avatar_url do |group, options|
         group.avatar_url(only_path: false)

lib/api/helpers/groups_helpers.rb

@@ -18,6 +18,7 @@ module API
         optional :auto_devops_enabled, type: Boolean, desc: 'Default to Auto DevOps pipeline for all projects within this group'
         optional :subgroup_creation_level, type: String, values: ::Gitlab::Access.subgroup_creation_string_values, desc: 'Allowed to create subgroups', as: :subgroup_creation_level_str
         optional :emails_disabled, type: Boolean, desc: 'Disable email notifications'
+        optional :mentions_disabled, type: Boolean, desc: 'Disable a group from getting mentioned'
         optional :lfs_enabled, type: Boolean, desc: 'Enable/disable LFS for the projects in this group'
         optional :request_access_enabled, type: Boolean, desc: 'Allow users to request member access'
       end

spec/graphql/types/group_type_spec.rb

@@ -8,4 +8,10 @@ describe GitlabSchema.types['Group'] do
   it { expect(described_class.graphql_name).to eq('Group') }
 
   it { expect(described_class).to require_graphql_authorizations(:read_group) }
+
+  it 'has the expected fields' do
+    expected_fields = %w[web_url avatar_url mentions_disabled parent]
+
+    is_expected.to include_graphql_fields(*expected_fields)
+  end
 end

spec/requests/api/groups_spec.rb

@@ -358,6 +358,7 @@ describe API::Groups do
         expect(json_response['two_factor_grace_period']).to eq(group1.two_factor_grace_period)
         expect(json_response['auto_devops_enabled']).to eq(group1.auto_devops_enabled)
         expect(json_response['emails_disabled']).to eq(group1.emails_disabled)
+        expect(json_response['mentions_disabled']).to eq(group1.mentions_disabled)
         expect(json_response['project_creation_level']).to eq('maintainer')
         expect(json_response['subgroup_creation_level']).to eq('maintainer')
         expect(json_response['web_url']).to eq(group1.web_url)
@@ -556,6 +557,7 @@ describe API::Groups do
         expect(json_response['two_factor_grace_period']).to eq(48)
         expect(json_response['auto_devops_enabled']).to eq(nil)
         expect(json_response['emails_disabled']).to eq(nil)
+        expect(json_response['mentions_disabled']).to eq(nil)
         expect(json_response['project_creation_level']).to eq("noone")
         expect(json_response['subgroup_creation_level']).to eq("maintainer")
         expect(json_response['request_access_enabled']).to eq(true)