Add API to query collaborators permission for a repository #18761

flozzone · 2022-02-14T08:40:43Z

Adds a collaborator permissions API endpoint according to GitHub API: https://docs.github.com/en/rest/collaborators/collaborators#get-repository-permissions-for-a-user to retrieve a collaborators permissions for a specific repository.

Checks the repository permissions of a collaborator.

GET /repos/{owner}/{repo}/collaborators/{collaborator}/permission

Possible permission values are admin, write, read, owner, none.

{
  "permission": "admin",
  "role_name": "admin",
  "user": {}
}

Where permission and role_name hold the same permission value and user is filled with the user API object. Only admins are allowed to use this API endpoint.

codecov-commenter · 2022-04-27T07:18:22Z

Codecov Report

❗ No coverage uploaded for pull request base (main@8eb1cd9). Click here to learn what that means.
The diff coverage is 81.66%.

@@           Coverage Diff           @@
##             main   #18761   +/-   ##
=======================================
  Coverage        ?   47.37%           
=======================================
  Files           ?      952           
  Lines           ?   132516           
  Branches        ?        0           
=======================================
  Hits            ?    62776           
  Misses          ?    62178           
  Partials        ?     7562

Impacted Files	Coverage Δ
routers/api/v1/repo/collaborators.go	`41.09% <77.08%> (ø)`
modules/convert/user.go	`79.16% <100.00%> (ø)`
routers/api/v1/api.go	`75.75% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8eb1cd9...1ba8b23. Read the comment docs.

flozzone · 2022-04-27T07:35:53Z

GitHub API endpoint returns the permissions admin, write, read, and none. But Gitea also has owner in AccessMode. Should we just map the owner permission to the admin permission to be compatible with GitHub API or should we return the owner permission if the given user is also a owner of the repository?

Since this is a design question, I would really be happy to get a input from a author.

lunny · 2022-04-27T08:07:55Z

GitHub API endpoint returns the permissions admin, write, read, and none. But Gitea also has owner in AccessMode. Should we just map the owner permission to the admin permission to be compatible with GitHub API or should we return the owner permission if the given user is also a owner of the repository?

Since this is a design question, I would really be happy to get a input from a author.

I vote to have an owner permission which should be equal to admin in Github.

flozzone · 2022-04-27T08:38:24Z

The current solution is to return the serialized form of AccessMode, which returns either: admin, write, read, owner, none.

I'll mention this in the PR description.

routers/api/v1/api.go

lunny

see my comment

routers/api/v1/api.go

integrations/api_repo_collaborator_test.go

models/repo_collaboration.go

routers/api/v1/repo/collaborators.go

models/repo_collaboration.go

6543 · 2022-04-27T13:34:12Z

make generate-swagger

…14936)

flozzone · 2022-04-27T13:39:00Z

you should not squash, that will only make reviews harder - it will be squash merged by us

Ok, I was actually not sure about this, I won't squash next time 👍

integrations/api_repo_collaborator_test.go

6543 · 2022-04-27T13:42:02Z

you can test your tests localy too:

make clean backend test-sqlite\#TestAPIRepoCollaboratorPermission

6543

how could i overlooke that 😅 - thats why tests are nice - works localy

routers/api/v1/repo/collaborators.go

6543 · 2022-04-29T12:24:07Z

🚀

…18761) Targeting go-gitea#14936, go-gitea#15332 Adds a collaborator permissions API endpoint according to GitHub API: https://docs.github.com/en/rest/collaborators/collaborators#get-repository-permissions-for-a-user to retrieve a collaborators permissions for a specific repository. ### Checks the repository permissions of a collaborator. `GET` `/repos/{owner}/{repo}/collaborators/{collaborator}/permission` Possible `permission` values are `admin`, `write`, `read`, `owner`, `none`. ```json { "permission": "admin", "role_name": "admin", "user": {} } ``` Where `permission` and `role_name` hold the same `permission` value and `user` is filled with the user API object. Only admins are allowed to use this API endpoint.

* giteaofficial/main: Avoid MoreThanOne Error (go-gitea#19557) [skip ci] Updated licenses and gitignores Simplify loops to copy (go-gitea#19569) Use middleware to open gitRepo (go-gitea#19559) Added X-Mailer header to outgoing emails (go-gitea#19562) fix go-gitea#19545 (go-gitea#19563) [skip ci] Updated translations via Crowdin Respect DefaultUserIsRestricted system default when creating new user (go-gitea#19310) Mute link in diff header (go-gitea#19556) Add API to query collaborators permission for a repository (go-gitea#18761) Permalink files In PR diff (go-gitea#19534) Fix Pull Request comment filename word breaks (go-gitea#19535) Don't error when branch's commit doesn't exist (go-gitea#19547)

…18761) Targeting go-gitea#14936, go-gitea#15332 Adds a collaborator permissions API endpoint according to GitHub API: https://docs.github.com/en/rest/collaborators/collaborators#get-repository-permissions-for-a-user to retrieve a collaborators permissions for a specific repository. `GET` `/repos/{owner}/{repo}/collaborators/{collaborator}/permission` Possible `permission` values are `admin`, `write`, `read`, `owner`, `none`. ```json { "permission": "admin", "role_name": "admin", "user": {} } ``` Where `permission` and `role_name` hold the same `permission` value and `user` is filled with the user API object. Only admins are allowed to use this API endpoint.

zeripath changed the title ~~Add API to query collaborators permission for a repository (#14936)~~ Add API to query collaborators permission for a repository Feb 14, 2022

zeripath added modifies/api This PR adds API routes or modifies them type/enhancement An improvement of existing functionality labels Feb 14, 2022

zeripath added this to the 1.17.0 milestone Feb 14, 2022

flozzone force-pushed the fix-14936 branch from 7c91cab to 4842d08 Compare February 14, 2022 10:29

flozzone force-pushed the fix-14936 branch 2 times, most recently from d0490e8 to 10c0876 Compare April 27, 2022 06:53

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Apr 27, 2022

lunny reviewed Apr 27, 2022

View reviewed changes

routers/api/v1/api.go Show resolved Hide resolved

lunny previously requested changes Apr 27, 2022

View reviewed changes

flozzone force-pushed the fix-14936 branch from 10c0876 to c35bd2c Compare April 27, 2022 12:10

flozzone requested a review from lunny April 27, 2022 12:16