sourcebot/schemas/v3/gitlab.json at a83f8043d30ca494a20a511111ce9fa65d4e9ef4 · sourcebot-dev/sourcebot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "GitlabConnectionConfig",
    "properties": {
        "type": {
            "const": "gitlab",
            "description": "GitLab Configuration"
        },
        "token": {
            "$ref": "./shared.json#/definitions/Token",
            "description": "An authentication token."
        },
        "url": {
            "type": "string",
            "format": "url",
            "default": "https://gitlab.com",
            "description": "The URL of the GitLab host. Defaults to https://gitlab.com",
            "examples": [
                "https://gitlab.com",
                "https://gitlab.example.com"
            ],
            "pattern": "^https?:\\/\\/[^\\s/$.?#].[^\\s]*$"
        },
        "all": {
            "type": "boolean",
            "default": false,
            "description": "Sync all projects visible to the provided `token` (if any) in the GitLab instance. This option is ignored if `url` is either unset or set to https://gitlab.com ."
        },
        "users": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "description": "List of users to sync with. All projects owned by the user and visible to the provided `token` (if any) will be synced, unless explicitly defined in the `exclude` property."
        },
        "groups": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "examples": [
                [
                    "my-group"
                ],
                [
                    "my-group/sub-group-a",
                    "my-group/sub-group-b"
                ]
            ],
            "description": "List of groups to sync with. All projects in the group (and recursive subgroups) visible to the provided `token` (if any) will be synced, unless explicitly defined in the `exclude` property. Subgroups can be specified by providing the path to the subgroup (e.g. `my-group/sub-group-a`)."
        },
        "projects": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "examples": [
                [
                    "my-group/my-project"
                ],
                [
                    "my-group/my-sub-group/my-project"
                ]
            ],
            "description": "List of individual projects to sync with. The project's namespace must be specified. See: https://docs.gitlab.com/ee/user/namespace/"
        },
        "projectQuery": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "examples": [
                [
                    "groups/group1/projects?include_subgroups=true",
                    "projects?topic=devops"
                ]
            ],
            "description": "List of GitLab API query paths to fetch projects from. Each string should be a path relative to the GitLab API root (e.g. `groups/my-group/projects`)."
        },
        "topics": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "minItems": 1,
            "description": "List of project topics to include when syncing. Only projects that match at least one of the provided `topics` will be synced. If not specified, all projects will be synced, unless explicitly defined in the `exclude` property. Glob patterns are supported.",
            "examples": [
                [
                    "docs",
                    "core"
                ]
            ]
        },
        "exclude": {
            "type": "object",
            "properties": {
                "forks": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude forked projects from syncing."
                },
                "archived": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude archived projects from syncing."
                },
                "userOwnedProjects": {
                    "type": "boolean",
                    "default": false,
                    "description": "Exclude user-owned projects from syncing."
                },
                "projects": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "default": [],
                    "examples": [
                        [
                            "my-group/my-project"
                        ]
                    ],
                    "description": "List of projects to exclude from syncing. Glob patterns are supported. The project's namespace must be specified, see: https://docs.gitlab.com/ee/user/namespace/"
                },
                "topics": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "description": "List of project topics to exclude when syncing. Projects that match one of the provided `topics` will be excluded from syncing. Glob patterns are supported.",
                    "examples": [
                        [
                            "tests",
                            "ci"
                        ]
                    ]
                }
            },
            "additionalProperties": false
        },
        "revisions": {
            "$ref": "./shared.json#/definitions/GitRevisions"
        }
    },
    "required": [
        "type"
    ],
    "additionalProperties": false
}