From 49f8f7e815185c99f182bb8bb6928d50792a4f55 Mon Sep 17 00:00:00 2001 From: Camden Cheek Date: Mon, 3 Feb 2025 17:32:03 -0700 Subject: [PATCH] clarify accepted values for projectQuery --- docs/admin/code_hosts/gitlab.mdx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/admin/code_hosts/gitlab.mdx b/docs/admin/code_hosts/gitlab.mdx index 289ddf33e..c12e7525c 100644 --- a/docs/admin/code_hosts/gitlab.mdx +++ b/docs/admin/code_hosts/gitlab.mdx @@ -44,7 +44,10 @@ Example config: There are three fields for configuring which projects are mirrored/synchronized: - [`projects`](/admin/code_hosts/gitlab#configuration): A list of projects in `{"name": "group/name"}` or `{"id": id}` format. The order determines the order in which we sync project metadata and is safe to change. -- [`projectQuery`](/admin/code_hosts/gitlab#configuration): A list of strings with one pre-defined option (`none`), and/or an URL path and query that targets the [GitLab Projects API endpoint](https://docs.gitlab.com/ee/api/projects.html), returning a list of projects. +- [`projectQuery`](/admin/code_hosts/gitlab#configuration): A list of strings. Accepted values include: + - The special value `none`, which will sync no repositories. + - Query parameters for the [GitLab Projects API endpoint](https://docs.gitlab.com/ee/api/projects.html). For example, `?archived=false`. + - A path and set of query parameters for any GitLab API endpoint that returns a list of repos. For example, `groups/mygroup/projects?visibility=public`. - [`exclude`](/admin/code_hosts/gitlab#configuration): A list of projects to exclude which takes precedence over the `projects`, and `projectQuery` fields. It has the same format as `projects`. ### Troubleshooting