Skip to content

Commit 66f6b7c

Browse files
authored
Clarify accepted values for projectQuery (#950)
It's not clear from reading that this config supports endpoints other than the `/projects` endpoint. This attempts to clarify.
1 parent d59bbdd commit 66f6b7c

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/admin/code_hosts/gitlab.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,10 @@ Example config:
4444
There are three fields for configuring which projects are mirrored/synchronized:
4545

4646
- [`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.
47-
- [`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.
47+
- [`projectQuery`](/admin/code_hosts/gitlab#configuration): A list of strings. Accepted values include:
48+
- The special value `none`, which will sync no repositories.
49+
- Query parameters for the [GitLab Projects API endpoint](https://docs.gitlab.com/ee/api/projects.html). For example, `?archived=false`.
50+
- 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`.
4851
- [`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`.
4952

5053
### Troubleshooting

0 commit comments

Comments
 (0)