Skip to content

Commit bd2dc2a

Browse files
DaedalusGDaedalusG
committed
Update admin/code_hosts/gerrit.schema.json schema for v
1 parent 5f38a22 commit bd2dc2a

File tree

1 file changed

+96
-70
lines changed

1 file changed

+96
-70
lines changed

‎docs/admin/code_hosts/gerrit.mdx‎

Lines changed: 96 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -109,78 +109,104 @@ Gerrit connections support the following configuration options, which are specif
109109
### admin/code_hosts/gerrit.schema.json
110110

111111
{/* SCHEMA_SYNC_START: admin/code_hosts/gerrit.schema.json */}
112-
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
113-
{/* Last updated: 2025-07-10T00:07:32Z via sourcegraph/[email protected] */}
114112
```json
115113
{
116-
// If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type "gerrit" with the same `url` field as specified in this `GerritConnection`.
117-
"authorization": {
118-
"identityProvider": null
119-
},
120-
121-
// A list of repositories to never mirror from this Gerrit instance. Takes precedence over "projects" configuration.
122-
// Supports excluding by name ({"name": "owner/name"})
123-
// Other example values:
124-
// - [
125-
// {
126-
// "name": "docs"
127-
// },
128-
// {
129-
// "name": "php/php-src"
130-
// }
131-
// ]
132-
"exclude": null,
133-
134-
// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
135-
"gitSSHCipher": null,
136-
137-
// SSH keys to use when cloning Git repo.
138-
"gitSSHCredential": null,
139-
140-
// The type of Git URLs to use for cloning and fetching Git repositories on this Gerrit instance.
141-
// If "http", Sourcegraph will access Gerrit repositories using Git URLs of the form http(s)://gerrit.example.com/a/myteam/myproject.git (using https: if the Gerrit instance uses HTTPS).
142-
// If "ssh", Sourcegraph will access Gerrit repositories using Git URLs of the form [email protected]:myteam/myproject.git. The exact hostname and port will be fetched from /ssh_info. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.
143-
// Valid options: "http", "ssh"
144-
"gitURLType": "http",
145-
146-
// REQUIRED:
147-
// The password associated with the Gerrit username used for authentication.
148-
"password": null,
149-
150-
// Any number of query parameters as supported by the Gerrit REST API: https://gerrit-review.googlesource.com/Documentation/rest-api-projects.html
151-
// Other example values:
152-
// - "query=name:kubernetes"
153-
// - "r=.*test"
154-
"projectQuery": null,
155-
156-
// An array of project strings specifying which Gerrit projects to mirror on Sourcegraph. If empty, all projects will be mirrored.
157-
// Other example values:
158-
// - [
159-
// "name",
160-
// "owner/name"
161-
// ]
162-
// - [
163-
// "docs",
164-
// "kubernetes/kubernetes",
165-
// "golang/go",
166-
// "facebook/react"
167-
// ]
168-
"projects": null,
169-
170-
// The pattern used to generate the corresponding Sourcegraph repository name for a Gerrit repository. In the pattern, the variable "{host}" is replaced with the Gerrit host (such as gerrit.example.com), and "{name}" is replaced with the Gerrit repository's name (such as "myrepo").
171-
// For example, if your Gerrit URL is https://gerrit.example.com and your Sourcegraph URL is https://src.example.com, then a repositoryPathPattern of "{host}/{name}" would mean that a Gerrit repository at https://gerrit.example.com/myrepo is available on Sourcegraph at https://src.example.com/gerrit.example.com/myrepo.
172-
// It 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.
173-
"repositoryPathPattern": "{host}/{name}",
174-
175-
// REQUIRED:
176-
// URL of a Gerrit instance, such as https://gerrit.example.com.
177-
// Other example values:
178-
// - "https://gerrit.example.com"
179-
"url": null,
180-
181-
// REQUIRED:
182-
// A username for authentication with the Gerrit code host.
183-
"username": null
114+
"$schema": "http://json-schema.org/draft-07/schema#",
115+
"$id": "gerrit.schema.json#",
116+
"title": "GerritConnection",
117+
"description": "Configuration for a connection to Gerrit.",
118+
"allowComments": true,
119+
"type": "object",
120+
"additionalProperties": false,
121+
"required": ["url", "username", "password"],
122+
"properties": {
123+
"url": {
124+
"description": "URL of a Gerrit instance, such as https://gerrit.example.com.",
125+
"type": "string",
126+
"pattern": "^https?://",
127+
"not": {
128+
"type": "string",
129+
"pattern": "example\\.com"
130+
},
131+
"format": "uri",
132+
"examples": ["https://gerrit.example.com"],
133+
"!go": {
134+
"typeName": "NormalizedURL"
135+
}
136+
},
137+
"username": {
138+
"description": "A username for authentication with the Gerrit code host.",
139+
"type": "string",
140+
"minLength": 1
141+
},
142+
"password": {
143+
"description": "The password associated with the Gerrit username used for authentication.",
144+
"type": "string",
145+
"minLength": 1
146+
},
147+
"projects": {
148+
"description": "An array of project strings specifying which Gerrit projects to mirror on Sourcegraph. If empty, all projects will be mirrored.",
149+
"type": "array",
150+
"items": { "type": "string" },
151+
"examples": [
152+
["name", "owner/name"],
153+
["docs", "kubernetes/kubernetes", "golang/go", "facebook/react"]
154+
]
155+
},
156+
"projectQuery": {
157+
"description": "Any number of query parameters as supported by the Gerrit REST API: https://gerrit-review.googlesource.com/Documentation/rest-api-projects.html",
158+
"type": "string",
159+
"examples": ["query=name:kubernetes", "r=.*test"]
160+
},
161+
"gitURLType": {
162+
"description": "The type of Git URLs to use for cloning and fetching Git repositories on this Gerrit instance.\n\nIf \"http\", Sourcegraph will access Gerrit repositories using Git URLs of the form http(s)://gerrit.example.com/a/myteam/myproject.git (using https: if the Gerrit instance uses HTTPS).\n\nIf \"ssh\", Sourcegraph will access Gerrit repositories using Git URLs of the form [email protected]:myteam/myproject.git. The exact hostname and port will be fetched from /ssh_info. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.",
163+
"type": "string",
164+
"enum": ["http", "ssh"],
165+
"default": "http"
166+
},
167+
"gitSSHCredential": {
168+
"description": "SSH keys to use when cloning Git repo.",
169+
"$ref": "git.schema.json#/definitions/gitSSHCredential"
170+
},
171+
"gitSSHCipher": {
172+
"description": "SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.",
173+
"$ref": "git.schema.json#/definitions/gitSSHCipher"
174+
},
175+
"exclude": {
176+
"description": "A list of repositories to never mirror from this Gerrit instance. Takes precedence over \"projects\" configuration.\n\nSupports excluding by name ({\"name\": \"owner/name\"})",
177+
"type": "array",
178+
"minItems": 1,
179+
"items": {
180+
"type": "object",
181+
"title": "ExcludedGerritProject",
182+
"additionalProperties": false,
183+
"anyOf": [{ "required": ["name"] }],
184+
"properties": {
185+
"name": {
186+
"description": "The name of a Gerrit project to exclude from mirroring.",
187+
"type": "string"
188+
}
189+
}
190+
},
191+
"examples": [[{ "name": "docs" }, { "name": "php/php-src" }]]
192+
},
193+
"repositoryPathPattern": {
194+
"description": "The pattern used to generate the corresponding Sourcegraph repository name for a Gerrit repository. In the pattern, the variable \"{host}\" is replaced with the Gerrit host (such as gerrit.example.com), and \"{name}\" is replaced with the Gerrit repository's name (such as \"myrepo\").\n\nFor example, if your Gerrit URL is https://gerrit.example.com and your Sourcegraph URL is https://src.example.com, then a repositoryPathPattern of \"{host}/{name}\" would mean that a Gerrit repository at https://gerrit.example.com/myrepo is available on Sourcegraph at https://src.example.com/gerrit.example.com/myrepo.\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.",
195+
"type": "string",
196+
"default": "{host}/{name}"
197+
},
198+
"authorization": {
199+
"title": "GerritAuthorization",
200+
"description": "If non-null, enforces Gerrit repository permissions. This requires that there is an item in the [site configuration json](https://sourcegraph.com/docs/admin/config/site_config#auth-providers) `auth.providers` field, of type \"gerrit\" with the same `url` field as specified in this `GerritConnection`.",
201+
"type": "object",
202+
"properties": {
203+
"identityProvider": {
204+
"description": "The identity provider to use for user information. If not set, the `url` field is used.",
205+
"type": "string"
206+
}
207+
}
208+
}
209+
}
184210
}
185211
```
186212
{/* SCHEMA_SYNC_END: admin/code_hosts/gerrit.schema.json */}

0 commit comments

Comments
 (0)