Project Approval Rule API returns empty Users when supplying user IDs and group IDs
Summary
When making a request to the approval rules API, the response is inconsistent based on the parameters of the request. When both a Group ID and a User ID are provided, the response to https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-project-level-rules does not match what's in the documentation.
Steps to reproduce
- Create 2 users
- Create a group
- Add user 2 to the group.
The following curl request would return an empty users block, but with users 1 and 2 in the eligible approvers block.
Request
curl -X POST \
'http://gitlab-ee/api/v4/projects/PROJECTID/approval_rules?name=RULENAME&approvals_required=1&user_ids=USERID1&group_ids=GROUPID' \
-H 'PRIVATE-TOKEN: -'
Response
{
"id": 0,
"name": "RULENAME",
"rule_type": "regular",
"eligible_approvers": [
{
"id": 1,
"name": "User1",
"username": "user1",
"state": "active",
"avatar_url": "...",
"web_url": "..."
},
{
"id": 2,
"name": "User2",
"username": "user2",
"state": "active",
"avatar_url": "...",
"web_url": "..."
}
],
"approvals_required": 1,
"users": [],
"groups": [
{
"id": 0,
"web_url": "...",
"name": "TestGroup",
"path": "testgroup",
// ...
}
],
"contains_hidden_groups": false
}
What is the current bug behavior?
The "users" key in the response from http://gitlab-ee/api/v4/projects/PROJECTID/approval_rules should return the user information for User 1.
What is the expected correct behavior?
The "users" key in the response from http://gitlab-ee/api/v4/projects/PROJECTID/approval_rules is empty.
Output of checks
(If you are reporting a bug on GitLab.com, write: This bug happens on GitLab.com)
Results of GitLab environment info
Expand for output related to GitLab environment info
System information System: Proxy: no Current User: git Using RVM: no Ruby Version: 2.6.3p62 Gem Version: 2.7.9 Bundler Version:1.17.3 Rake Version: 12.3.3 Redis Version: 3.2.12 Git Version: 2.22.0 Sidekiq Version:5.2.7 Go Version: unknown
GitLab information Version: 12.4.0-ee Revision: 572e09f5e8f Directory: /opt/gitlab/embedded/service/gitlab-rails DB Adapter: PostgreSQL DB Version: 10.9 URL: http://6af4903507e1 HTTP Clone URL: http://6af4903507e1/some-group/some-project.git SSH Clone URL: git@6af4903507e1:some-group/some-project.git Elasticsearch: no Geo: no Using LDAP: no Using Omniauth: yes Omniauth Providers:
GitLab Shell Version: 10.2.0 Repository storage paths:
- default: /var/opt/gitlab/git-data/repositories GitLab Shell path: /opt/gitlab/embedded/service/gitlab-shell Git: /opt/gitlab/embedded/bin/git
Results of GitLab application Check
Expand for output related to the GitLab application check
Checking GitLab subtasks ...Checking GitLab Shell ...
GitLab Shell: ... GitLab Shell version >= 10.2.0 ? ... OK (10.2.0) Running /opt/gitlab/embedded/service/gitlab-shell/bin/check Internal API available: OK Redis available via internal API: OK gitlab-shell self-check successful
Checking GitLab Shell ... Finished
Checking Gitaly ...
Gitaly: ... default ... OK
Checking Gitaly ... Finished
Checking Sidekiq ...
Sidekiq: ... Running? ... yes Number of Sidekiq processes ... 1
Checking Sidekiq ... Finished
Checking Incoming Email ...
Incoming Email: ... Reply by email is disabled in config/gitlab.yml
Checking Incoming Email ... Finished
Checking LDAP ...
LDAP: ... LDAP is disabled in config/gitlab.yml
Checking LDAP ... Finished
Checking GitLab App ...
Git configured correctly? ... yes Database config exists? ... yes All migrations up? ... yes Database contains orphaned GroupMembers? ... no GitLab config exists? ... yes GitLab config up to date? ... yes Log directory writable? ... yes Tmp directory writable? ... yes Uploads directory exists? ... yes Uploads directory has correct permissions? ... yes Uploads directory tmp has correct permissions? ... skipped (no tmp uploads folder yet) Init script exists? ... skipped (omnibus-gitlab has no init script) Init script up-to-date? ... skipped (omnibus-gitlab has no init script) Projects have namespace: ... 1/10 ... yes Redis version >= 2.8.0? ... yes Ruby version >= 2.5.3 ? ... yes (2.6.3) Git version >= 2.22.0 ? ... yes (2.22.0) Git user has default SSH configuration? ... yes Active users: ... 3 Is authorized keys file accessible? ... yes Elasticsearch version 5.6 - 6.x? ... skipped (elasticsearch is disabled)
Checking GitLab App ... Finished
Checking GitLab subtasks ... Finished