Skip to content

Commit 8d9e4a6

Browse files
committed
docs: Add Gerrit REST API authentication documentation link
- Add comment linking to official Gerrit auth documentation - Clarifies why we use /a/ prefix for authenticated endpoints Addresses: brendan-kellam's request for documentation link
1 parent 947f5ab commit 8d9e4a6

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

packages/backend/src/gerrit.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export const getGerritReposFromConfig = async (
109109

110110
const fetchAllProjects = async (url: string, auth?: GerritAuthConfig): Promise<GerritProject[]> => {
111111
// Use authenticated endpoint if auth is provided, otherwise use public endpoint
112+
// See: https://gerrit-review.googlesource.com/Documentation/rest-api.html#:~:text=Protocol%20Details-,Authentication,-By%20default%20all
112113
const projectsEndpoint = auth ? `${url}a/projects/` : `${url}projects/`;
113114
let allProjects: GerritProject[] = [];
114115
let start = 0; // Start offset for pagination

0 commit comments

Comments
 (0)