forked from sourcegraph/sourcegraph-public-snapshot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgitlab.schema.json
More file actions
281 lines (281 loc) · 12.3 KB
/
gitlab.schema.json
File metadata and controls
281 lines (281 loc) · 12.3 KB
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "gitlab.schema.json#",
"title": "GitLabConnection",
"description": "Configuration for a connection to GitLab (GitLab.com or GitLab self-managed).",
"allowComments": true,
"type": "object",
"additionalProperties": false,
"required": ["url", "token", "projectQuery"],
"properties": {
"url": {
"description": "URL of a GitLab instance, such as https://gitlab.example.com or (for GitLab.com) https://gitlab.com.",
"type": "string",
"pattern": "^https?://",
"not": {
"type": "string",
"pattern": "example\\.com"
},
"format": "uri",
"examples": ["https://gitlab.com", "https://gitlab.example.com"]
},
"token": {
"description": "A GitLab access token with \"api\" scope. Can be a personal access token (PAT) or an OAuth token. If you are enabling permissions with identity provider type \"external\", this token should also have \"sudo\" scope.",
"type": "string",
"minLength": 1
},
"token.type": {
"description": "The type of the token",
"type": "string",
"enum": ["pat", "oauth"],
"default": "pat"
},
"rateLimit": {
"description": "Rate limit applied when making background API requests to GitLab.",
"title": "GitLabRateLimit",
"type": "object",
"required": ["enabled", "requestsPerHour"],
"properties": {
"enabled": {
"description": "true if rate limiting is enabled.",
"type": "boolean",
"default": true
},
"requestsPerHour": {
"description": "Requests per hour permitted. This is an average, calculated per second. Internally the burst limit is set to 100, which implies that for a requests per hour limit as low as 1, users will continue to be able to send a maximum of 100 requests immediately, provided that the complexity cost of each request is 1.",
"type": "number",
"default": 36000,
"minimum": 0
}
},
"default": {
"enabled": true,
"requestsPerHour": 36000
}
},
"gitURLType": {
"description": "The type of Git URLs to use for cloning and fetching Git repositories on this GitLab instance.\n\nIf \"http\", Sourcegraph will access GitLab repositories using Git URLs of the form http(s)://gitlab.example.com/myteam/myproject.git (using https: if the GitLab instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access GitLab repositories using Git URLs of the form [email protected]:myteam/myproject.git. See the documentation for how to provide SSH private keys and known_hosts: https://docs.sourcegraph.com/admin/repo/auth#repositories-that-need-http-s-or-ssh-authentication.",
"type": "string",
"enum": ["http", "ssh"],
"default": "http"
},
"certificate": {
"description": "TLS certificate of the GitLab instance. This is only necessary if the certificate is self-signed or signed by an internal CA. To get the certificate run `openssl s_client -connect HOST:443 -showcerts < /dev/null 2> /dev/null | openssl x509 -outform PEM`. To escape the value into a JSON string, you may want to use a tool like https://json-escape-text.now.sh.",
"type": "string",
"pattern": "^-----BEGIN CERTIFICATE-----\n",
"examples": ["-----BEGIN CERTIFICATE-----\n..."]
},
"projects": {
"description": "A list of projects to mirror from this GitLab instance. Supports including by name ({\"name\": \"group/name\"}) or by ID ({\"id\": 42}).",
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"title": "GitLabProject",
"additionalProperties": false,
"oneOf": [{ "required": ["name"] }, { "required": ["id"] }],
"properties": {
"name": {
"description": "The name of a GitLab project (\"group/name\") to mirror.",
"type": "string",
"pattern": "^[\\w.-]+(/[\\w.-]+)+$"
},
"id": {
"description": "The ID of a GitLab project (as returned by the GitLab instance's API) to mirror.",
"type": "integer"
}
}
},
"examples": [
[{ "name": "group/name" }, { "id": 42 }],
[{ "name": "gnachman/iterm2" }, { "name": "gitlab-org/gitlab-ce" }]
]
},
"exclude": {
"description": "A list of projects to never mirror from this GitLab instance. Takes precedence over \"projects\" and \"projectQuery\" configuration. Supports excluding by name ({\"name\": \"group/name\"}) or by ID ({\"id\": 42}).",
"type": "array",
"items": {
"type": "object",
"title": "ExcludedGitLabProject",
"additionalProperties": false,
"anyOf": [{ "required": ["name"] }, { "required": ["id"] }],
"properties": {
"name": {
"description": "The name of a GitLab project (\"group/name\") to exclude from mirroring.",
"type": "string",
"pattern": "^[\\w.-]+(/[\\w.-]+)+$"
},
"id": {
"description": "The ID of a GitLab project (as returned by the GitLab instance's API) to exclude from mirroring.",
"type": "integer"
}
}
},
"examples": [
[{ "name": "group/name" }, { "id": 42 }],
[{ "name": "gitlab-org/gitlab-ee" }, { "name": "gitlab-com/www-gitlab-com" }]
]
},
"projectQuery": {
"description": "An array of strings specifying which GitLab projects to mirror on Sourcegraph. Each string is a URL path and query that targets a GitLab API endpoint returning a list of projects. If the string only contains a query, then \"projects\" is used as the path. Examples: \"?membership=true&search=foo\", \"groups/mygroup/projects\".\n\nThe special string \"none\" can be used as the only element to disable this feature. Projects matched by multiple query strings are only imported once. Here are a few endpoints that return a list of projects: https://docs.gitlab.com/ee/api/projects.html#list-all-projects, https://docs.gitlab.com/ee/api/groups.html#list-a-groups-projects, https://docs.gitlab.com/ee/api/search.html#scope-projects.",
"type": "array",
"default": ["none"],
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"examples": [["?membership=true&search=foo", "groups/mygroup/projects"]]
},
"repositoryPathPattern": {
"description": "The pattern used to generate a the corresponding Sourcegraph repository name for a GitLab project. In the pattern, the variable \"{host}\" is replaced with the GitLab URL's host (such as gitlab.example.com), and \"{pathWithNamespace}\" is replaced with the GitLab project's \"namespace/path\" (such as \"myteam/myproject\").\n\nFor example, if your GitLab is https://gitlab.example.com and your Sourcegraph is https://src.example.com, then a repositoryPathPattern of \"{host}/{pathWithNamespace}\" would mean that a GitLab project at https://gitlab.example.com/myteam/myproject is available on Sourcegraph at https://src.example.com/gitlab.example.com/myteam/myproject.\n\nIt is important that the Sourcegraph repository name generated with this pattern be unique to this code host. If different code hosts generate repository names that collide, Sourcegraph's behavior is undefined.",
"type": "string",
"default": "{host}/{pathWithNamespace}"
},
"nameTransformations": {
"description": "An array of transformations will apply to the repository name. Currently, only regex replacement is supported. All transformations happen after \"repositoryPathPattern\" is processed.",
"type": "array",
"items": {
"$ref": "#/definitions/NameTransformation"
},
"examples": [
[
{
"regex": "\\.d/",
"replacement": "/"
},
{
"regex": "-git$",
"replacement": ""
}
]
]
},
"initialRepositoryEnablement": {
"description": "Deprecated and ignored field which will be removed entirely in the next release. GitLab repositories can no longer be enabled or disabled explicitly.",
"type": "boolean"
},
"authorization": {
"title": "GitLabAuthorization",
"description": "If non-null, enforces GitLab repository permissions. This requires that there be an item in the `auth.providers` field of type \"gitlab\" with the same `url` field as specified in this `GitLabConnection`.",
"type": "object",
"additionalProperties": false,
"required": ["identityProvider"],
"properties": {
"identityProvider": {
"description": "The source of identity to use when computing permissions. This defines how to compute the GitLab identity to use for a given Sourcegraph user.",
"type": "object",
"required": ["type"],
"properties": {
"type": {
"type": "string",
"enum": ["oauth", "username", "external"]
}
},
"oneOf": [
{ "$ref": "#/definitions/OAuthIdentity" },
{ "$ref": "#/definitions/UsernameIdentity" },
{ "$ref": "#/definitions/ExternalIdentity" }
],
"!go": {
"taggedUnionType": true
}
}
}
},
"webhooks": {
"description": "An array of webhook configurations",
"type": "array",
"items": {
"type": "object",
"title": "GitLabWebhook",
"required": ["secret"],
"additionalProperties": false,
"properties": {
"secret": {
"description": "The secret used to authenticate incoming webhook requests",
"type": "string",
"minLength": 1
}
}
}
},
"cloudGlobal": {
"title": "CloudGlobal",
"description": "When set to true, this external service will be chosen as our 'Global' GitLab service. Only valid on Sourcegraph.com. Only one service can have this flag set.",
"type": "boolean",
"default": false,
"deprecationMessage": "DEPRECATED: The cloud_default flag should be set in the database instead"
},
"cloudDefault": {
"title": "CloudDefault",
"description": "Only used to override the cloud_default column from a config file specified by EXTSVC_CONFIG_FILE",
"type": "boolean",
"default": false
}
},
"definitions": {
"OAuthIdentity": {
"type": "object",
"additionalProperties": false,
"required": ["type"],
"properties": {
"type": {
"type": "string",
"const": "oauth"
}
}
},
"UsernameIdentity": {
"type": "object",
"additionalProperties": false,
"required": ["type"],
"properties": {
"type": {
"type": "string",
"const": "username"
}
}
},
"ExternalIdentity": {
"type": "object",
"additionalProperties": false,
"required": ["type", "authProviderID", "authProviderType", "gitlabProvider"],
"properties": {
"type": {
"type": "string",
"const": "external"
},
"authProviderID": {
"type": "string",
"description": "The value of the `configID` field of the targeted authentication provider."
},
"authProviderType": {
"type": "string",
"description": "The `type` field of the targeted authentication provider."
},
"gitlabProvider": {
"type": "string",
"description": "The name that identifies the authentication provider to GitLab. This is passed to the `?provider=` query parameter in calls to the GitLab Users API. If you're not sure what this value is, you can look at the `identities` field of the GitLab Users API result (`curl -H 'PRIVATE-TOKEN: $YOUR_TOKEN' $GITLAB_URL/api/v4/users`)."
}
}
},
"NameTransformation": {
"title": "GitLabNameTransformation",
"type": "object",
"additionalProperties": false,
"anyOf": [{ "required": ["regex", "replacement"] }],
"properties": {
"regex": {
"type": "string",
"format": "regex",
"description": "The regex to match for the occurrences of its replacement."
},
"replacement": {
"type": "string",
"description": "The replacement used to replace all matched occurrences by the regex."
}
}
}
}
}