From b6a637dc0c9889f204c841bff23ec92d210c83d6 Mon Sep 17 00:00:00 2001 From: Sami Hiltunen Date: Thu, 9 Dec 2021 18:45:33 +0200 Subject: Correct documentation of GLID parameter of internal/allowed GLID is currently documented as identifying the repository. This is incorrect and the parameter actually carries the information to identify the user performing the operation. Fix the documentation. --- internal/gitlab/client.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/internal/gitlab/client.go b/internal/gitlab/client.go index 093f818a2..6c99c9ddc 100644 --- a/internal/gitlab/client.go +++ b/internal/gitlab/client.go @@ -16,7 +16,11 @@ type AllowedParams struct { // For example, `project-19` specifies the code repository of project with id 19 // and `wiki-19` specifies the wiki repository of the same project. GLRepository string - // GLID is an identifier of the repository. + // GLID is the identifier of the actor performing the operation. + // + // This value is opaque to Gitaly but is formatted as `-`. For example, + // 'user-13' specifies the operation was performed by user with ID 13. If username of + // user 13 is 'exampleuser', GLID 'username-exampleuser' would identify the same user. GLID string // GLProtocol is a protocol used for operation. GLProtocol string -- cgit v1.2.3