Listing subgroups of a group (API)

Description

Listing subgroups of a group (API)

Proposal

Hello,

Why I cannot list subgroups of a group?

If I request: https://gitlab.com/api/v4/groups/:id

All the projects of this group will be listed, but the projects of subgroups will be missing, and I cannot find a way to list the subgroups.

Links / references

/label feature proposal

@dericeira It looks like it hasn't been implemented yet. It should be possible to tie things together using the parent_id for a subgroup to determine it's parent group.

Would you be willing to provide this functionality by creating a Merge Request for the Community Edition project?

added ~480950 ~13884 feature proposal subgroups labels

changed the description

Yes, this would be indeed helpful, to view all subgroups of a group, so that you can recursively craw through all subgroups of a given parent group.

How it's possible to get the ID of a subgroup? In my "group" list on API I can see only the "groups". @markglenfletcher

I am currently untrained in ruby, so I will not risk it. Unfortunately.

@dericeira Each group result will have an id and a parent_id attribute. If this is populated (not null), you know that the group is a subgroup and not a top-level group. You can use this ID to match up it's parent and build up your tree of groups.

For example:

Gather groups you have access to:

curl -H "Content-Type: application/json" \
-H "PRIVATE-TOKEN: token" \
https://gitlab.com/api/v4/groups | jq

[
  {
    "id": 785414,
    "name": "issue-reproduce",
    "path": "issue-reproduce",
    "description": "",
    "visibility": "public",
    "ldap_cn": null,
    "ldap_access": null,
    "lfs_enabled": true,
    "avatar_url": "https://gitlab.com/uploads/group/avatar/785414/blog_dilbert_bug.jpg",
    "web_url": "https://gitlab.com/groups/issue-reproduce",
    "request_access_enabled": true,
    "full_name": "issue-reproduce",
    "full_path": "issue-reproduce",
    "parent_id": null
  },
  {
    "id": 1440683,
    "name": "api-access-levels",
    "path": "api-access-levels",
    "description": "",
    "visibility": "public",
    "ldap_cn": null,
    "ldap_access": null,
    "lfs_enabled": true,
    "avatar_url": null,
    "web_url": "https://gitlab.com/groups/issue-reproduce/api-access-levels",
    "request_access_enabled": false,
    "full_name": "issue-reproduce / api-access-levels",
    "full_path": "issue-reproduce/api-access-levels",
    "parent_id": 785414
  }
]

Here we can see that the first group is a top-level group and the second group is a subgroup of the first, based on the parent_id.

@markglenfletcher It is not possible because subgroups are not listed on /groups route. In this way, subgroups seems to be unreachable by gitlab API.

@dericeira The results above were from the /groups endpoint. The subgroups are listed there

@markglenfletcher Got it. This is weird. In my company we have a private repository with about 10 subgroups, totaling more than 250 projects. On this route I can only list the parent repositories. I don't know, but maybe It will only work with public groups.

You're passing a token with access to the group?

The response is paginated, 20 results at a time by default. Could they be on another page?

Not a possible. I have owner status in all groups and subgroups. I am using the correct access key, on /groups route I can only see the 3 main groups of our parent group.

@dericeira Please can you add requests and responses like I provided above? We'll need more information.

mentioned in issue #36577 (closed)

@markglenfletcher, I am experiencing the same issue as @dericeira. From the public API, https://gitlab.com/api/v4/groups, I see the results with subgroups listed. Inside my company we are using the GitLab Enterprise Edition (9.4.4). I do not see any subgroups with a similar request. If I include ?all_available=true, I do get subgroups. However, I will now need to sort through several hundred groups to find the groups and subgroups I am interested in. This is too cumbersome.

@justgrumpy Yes, the example is merely a workaround for the current implementation. The feature proposal here still stands to implement this properly to list subgroups beneath the parent group.

moved to gitlab#10007

Hey!

GitLab is moving all development for both GitLab Community Edition and Enterprise Edition into a single codebase. The current gitlab-ce repository will become a read-only mirror, without any proprietary code. All development is moved to the current gitlab-ee repository, which we will rename to just gitlab in the coming weeks. As part of this migration, issues will be moved to the current gitlab-ee project.

If you have any questions about all of this, please ask them in our dedicated FAQ issue.

https://gitlab.com/gitlab-org/gitlab-ee/issues/13855

You can also find more information here:

• https://gitlab.com/gitlab-org/gitlab-ee/issues/13304
• https://about.gitlab.com/2019/08/23/a-single-codebase-for-gitlab-community-and-enterprise-edition/

Frequently Asked Questions

For an up to date list of questions and answers, please take a look at https://gitlab.com/gitlab-org/gitlab-ee/issues/13855

What will we do with the repository names?

https://gitlab.com/gitlab-org/gitlab-ee/ will become https://gitlab.com/gitlab-org/gitlab, and https://gitlab.com/gitlab-org/gitlab-ce will become https://gitlab.com/gitlab-org/gitlab-foss.

Why rename gitlab-ce to gitlab-foss?

Using "gitlab" and "gitlab-ce" would be confusing, so we decided to rename gitlab-ce to gitlab-foss to make the purpose of this FOSS repository more clear

I created a merge requests for CE, and this got closed. What do I need to do?

You will need to create a merge request at https://gitlab.com/gitlab-org/gitlab-ee/. This link will eventually redirect to https://gitlab.com/gitlab-org/gitlab.

How does the licensing work in this new setup?

Everything in the ee/ directory is proprietary. Everything else is free and open source software. If your merge request does not change anything in the ee/ directory, the process of contributing changes is the same as when using the gitlab-ce repository.

Will you accept merge requests on the gitlab-ce/gitlab-foss project after it has been renamed?

No. Merge requests submitted to this project will be closed automatically.

Will I still be able to view old issues and merge requests in gitlab-ce/gitlab-foss?

Yes.

How will this affect users of GitLab CE using Omnibus?

No changes will be necessary, as the packages built remain the same.

How will this affect users of GitLab CE that build from source?

Once the project has been renamed, you will need to change your Git remotes to use this new URL. GitLab will take care of redirecting Git operations so there is no hard deadline, but we recommend doing this as soon as the projects have been renamed.

Where can I see a timeline of the remaining steps?

https://gitlab.com/gitlab-org/gitlab-ee/issues/13304

Will community contributions submitted to the new "gitlab" repository be available in the new gitlab-foss repository?

Yes, these changes will be synced to gitlab-foss automatically, several times per day.

locked this issue

mentioned in merge request !14785