Skip to content

Commit d832465

Browse files
kriswestkriswest
committed
docs: better links in schemas and regenerate ref docs from schema
1 parent ee313d1 commit d832465

File tree

3 files changed

+150
-31
lines changed

3 files changed

+150
-31
lines changed

‎config.schema.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
},
3333
"gitleaks": {
3434
"type": "object",
35-
"description": "Configuration for the gitleaks (https://github.com/gitleaks/gitleaks) plugin",
35+
"description": "Configuration for the gitleaks [https://github.com/gitleaks/gitleaks](https://github.com/gitleaks/gitleaks) plugin",
3636
"properties": {
3737
"enabled": { "type": "boolean" },
3838
"ignoreGitleaksAllow": { "type": "boolean" },
@@ -391,18 +391,18 @@
391391
"enabled": { "type": "boolean" },
392392
"connectionString": {
393393
"type": "string",
394-
"description": "mongoDB Client connection string, see https://www.mongodb.com/docs/manual/reference/connection-string/"
394+
"description": "mongoDB Client connection string, see [https://www.mongodb.com/docs/manual/reference/connection-string/](https://www.mongodb.com/docs/manual/reference/connection-string/)"
395395
},
396396
"options": {
397397
"type": "object",
398-
"description": "mongoDB Client connection options. Please note that only custom options are described here, see https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/ for all config options.",
398+
"description": "mongoDB Client connection options. Please note that only custom options are described here, see [https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/](https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/) for all config options.",
399399
"properties": {
400400
"authMechanismProperties": {
401401
"type": "object",
402402
"properties": {
403403
"AWS_CREDENTIAL_PROVIDER": {
404404
"type": "boolean",
405-
"description": "If set to true fromNodeProviderChain() from @aws-sdk/credential-providers is passed as the AWS_CREDENTIAL_PROVIDER"
405+
"description": "If set to true, the `fromNodeProviderChain()` function from @aws-sdk/credential-providers is passed as the `AWS_CREDENTIAL_PROVIDER`"
406406
}
407407
},
408408
"additionalProperties": true

‎src/config/generated/config.ts‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ export interface GitProxyConfig {
112112
*/
113113
export interface API {
114114
/**
115-
* Configuration for the gitleaks (https://github.com/gitleaks/gitleaks) plugin
115+
* Configuration for the gitleaks
116+
* [https://github.com/gitleaks/gitleaks](https://github.com/gitleaks/gitleaks) plugin
116117
*/
117118
gitleaks?: Gitleaks;
118119
/**
@@ -124,7 +125,8 @@ export interface API {
124125
}
125126

126127
/**
127-
* Configuration for the gitleaks (https://github.com/gitleaks/gitleaks) plugin
128+
* Configuration for the gitleaks
129+
* [https://github.com/gitleaks/gitleaks](https://github.com/gitleaks/gitleaks) plugin
128130
*/
129131
export interface Gitleaks {
130132
configPath?: string;
@@ -482,13 +484,14 @@ export interface RateLimit {
482484
export interface Database {
483485
/**
484486
* mongoDB Client connection string, see
485-
* https://www.mongodb.com/docs/manual/reference/connection-string/
487+
* [https://www.mongodb.com/docs/manual/reference/connection-string/](https://www.mongodb.com/docs/manual/reference/connection-string/)
486488
*/
487489
connectionString?: string;
488490
enabled: boolean;
489491
/**
490492
* mongoDB Client connection options. Please note that only custom options are described
491-
* here, see https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/
493+
* here, see
494+
* [https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/](https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/)
492495
* for all config options.
493496
*/
494497
options?: Options;
@@ -502,7 +505,8 @@ export interface Database {
502505

503506
/**
504507
* mongoDB Client connection options. Please note that only custom options are described
505-
* here, see https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/
508+
* here, see
509+
* [https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/](https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/)
506510
* for all config options.
507511
*/
508512
export interface Options {
@@ -512,8 +516,8 @@ export interface Options {
512516

513517
export interface AuthMechanismProperties {
514518
/**
515-
* If set to true fromNodeProviderChain() from @aws-sdk/credential-providers is passed as
516-
* the AWS_CREDENTIAL_PROVIDER
519+
* If set to true, the `fromNodeProviderChain()` function from @aws-sdk/credential-providers
520+
* is passed as the `AWS_CREDENTIAL_PROVIDER`
517521
*/
518522
AWS_CREDENTIAL_PROVIDER?: boolean;
519523
[property: string]: any;

‎website/docs/configuration/reference.mdx‎

Lines changed: 135 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ description: JSON schema reference documentation for GitProxy
124124
| **Required** | No |
125125
| **Additional properties** | Any type allowed |
126126

127-
**Description:** Configuration for the gitleaks (https://github.com/gitleaks/gitleaks) plugin
127+
**Description:** Configuration for the gitleaks [https://github.com/gitleaks/gitleaks](https://github.com/gitleaks/gitleaks) plugin
128128

129129
<details>
130130
<summary>
@@ -635,6 +635,8 @@ description: JSON schema reference documentation for GitProxy
635635
| **Type** | `string` |
636636
| **Required** | Yes |
637637

638+
**Description:** Tooltip text
639+
638640
</blockquote>
639641
</details>
640642

@@ -649,6 +651,8 @@ description: JSON schema reference documentation for GitProxy
649651
| **Type** | `array of object` |
650652
| **Required** | No |
651653

654+
**Description:** An array of links to display under the tooltip text, providing additional context about the question
655+
652656
| Each item of this array must be | Description |
653657
| --------------------------------------------------------------------- | ----------- |
654658
| [links items](#attestationConfig_questions_items_tooltip_links_items) | - |
@@ -663,30 +667,34 @@ description: JSON schema reference documentation for GitProxy
663667

664668
<details>
665669
<summary>
666-
<strong> <a name="attestationConfig_questions_items_tooltip_links_items_text"></a>6.1.1.2.2.1.1. [Optional] Property GitProxy configuration file > attestationConfig > questions > Question > tooltip > links > links items > text</strong>
670+
<strong> <a name="attestationConfig_questions_items_tooltip_links_items_text"></a>6.1.1.2.2.1.1. [Required] Property GitProxy configuration file > attestationConfig > questions > Question > tooltip > links > links items > text</strong>
667671
</summary>
668672
<blockquote>
669673

670674
| | |
671675
| ------------ | -------- |
672676
| **Type** | `string` |
673-
| **Required** | No |
677+
| **Required** | Yes |
678+
679+
**Description:** Link text
674680

675681
</blockquote>
676682
</details>
677683

678684
<details>
679685
<summary>
680-
<strong> <a name="attestationConfig_questions_items_tooltip_links_items_url"></a>6.1.1.2.2.1.2. [Optional] Property GitProxy configuration file > attestationConfig > questions > Question > tooltip > links > links items > url</strong>
686+
<strong> <a name="attestationConfig_questions_items_tooltip_links_items_url"></a>6.1.1.2.2.1.2. [Required] Property GitProxy configuration file > attestationConfig > questions > Question > tooltip > links > links items > url</strong>
681687
</summary>
682688
<blockquote>
683689

684690
| | |
685691
| ------------ | -------- |
686692
| **Type** | `string` |
687-
| **Required** | No |
693+
| **Required** | Yes |
688694
| **Format** | `url` |
689695

696+
**Description:** Link URL
697+
690698
</blockquote>
691699
</details>
692700

@@ -1013,36 +1021,59 @@ description: JSON schema reference documentation for GitProxy
10131021

10141022
**Description:** List of database sources. The first source in the configuration with enabled=true will be used.
10151023

1016-
| Each item of this array must be | Description |
1017-
| ------------------------------- | ----------- |
1018-
| [database](#sink_items) | - |
1024+
| Each item of this array must be | Description |
1025+
| ------------------------------- | ---------------------------------- |
1026+
| [database](#sink_items) | Configuration entry for a database |
10191027

10201028
### <a name="autogenerated_heading_10"></a>15.1. GitProxy configuration file > sink > database
10211029

10221030
| | |
10231031
| ------------------------- | ---------------------- |
1024-
| **Type** | `object` |
1032+
| **Type** | `combining` |
10251033
| **Required** | No |
10261034
| **Additional properties** | Any type allowed |
10271035
| **Defined in** | #/definitions/database |
10281036

1037+
**Description:** Configuration entry for a database
1038+
1039+
<blockquote>
1040+
1041+
| One of(Option) |
1042+
| ------------------------------ |
1043+
| [item 0](#sink_items_oneOf_i0) |
1044+
| [item 1](#sink_items_oneOf_i1) |
1045+
1046+
<blockquote>
1047+
1048+
#### <a name="sink_items_oneOf_i0"></a>15.1.1. Property `GitProxy configuration file > sink > sink items > oneOf > item 0`
1049+
1050+
| | |
1051+
| ------------------------- | ---------------- |
1052+
| **Type** | `object` |
1053+
| **Required** | No |
1054+
| **Additional properties** | Any type allowed |
1055+
1056+
**Description:** Connection properties for mongoDB. Options may be passed in either the connection string or broken out in the options object
1057+
10291058
<details>
10301059
<summary>
1031-
<strong> <a name="sink_items_type"></a>15.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong>
1060+
<strong> <a name="sink_items_oneOf_i0_type"></a>15.1.1.1. [Required] Property GitProxy configuration file > sink > sink items > oneOf > item 0 > type</strong>
10321061
</summary>
10331062
<blockquote>
10341063

1035-
| | |
1036-
| ------------ | -------- |
1037-
| **Type** | `string` |
1038-
| **Required** | Yes |
1064+
| | |
1065+
| ------------ | ------- |
1066+
| **Type** | `const` |
1067+
| **Required** | Yes |
1068+
1069+
Specific value: `"mongo"`
10391070

10401071
</blockquote>
10411072
</details>
10421073

10431074
<details>
10441075
<summary>
1045-
<strong> <a name="sink_items_enabled"></a>15.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong>
1076+
<strong> <a name="sink_items_oneOf_i0_enabled"></a>15.1.1.2. [Required] Property GitProxy configuration file > sink > sink items > oneOf > item 0 > enabled</strong>
10461077
</summary>
10471078
<blockquote>
10481079

@@ -1056,36 +1087,114 @@ description: JSON schema reference documentation for GitProxy
10561087

10571088
<details>
10581089
<summary>
1059-
<strong> <a name="sink_items_connectionString"></a>15.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong>
1090+
<strong> <a name="sink_items_oneOf_i0_connectionString"></a>15.1.1.3. [Required] Property GitProxy configuration file > sink > sink items > oneOf > item 0 > connectionString</strong>
10601091
</summary>
10611092
<blockquote>
10621093

10631094
| | |
10641095
| ------------ | -------- |
10651096
| **Type** | `string` |
1066-
| **Required** | No |
1097+
| **Required** | Yes |
1098+
1099+
**Description:** mongoDB Client connection string, see [https://www.mongodb.com/docs/manual/reference/connection-string/](https://www.mongodb.com/docs/manual/reference/connection-string/)
10671100

10681101
</blockquote>
10691102
</details>
10701103

10711104
<details>
10721105
<summary>
1073-
<strong> <a name="sink_items_options"></a>15.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong>
1106+
<strong> <a name="sink_items_oneOf_i0_options"></a>15.1.1.4. [Optional] Property GitProxy configuration file > sink > sink items > oneOf > item 0 > options</strong>
1107+
</summary>
1108+
<blockquote>
1109+
1110+
| | |
1111+
| ------------------------- | ---------------- |
1112+
| **Type** | `object` |
1113+
| **Required** | No |
1114+
| **Additional properties** | Any type allowed |
1115+
1116+
**Description:** mongoDB Client connection options. Please note that only custom options are described here, see [https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/](https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/) for all config options.
1117+
1118+
<details>
1119+
<summary>
1120+
<strong> <a name="sink_items_oneOf_i0_options_authMechanismProperties"></a>15.1.1.4.1. [Optional] Property GitProxy configuration file > sink > sink items > oneOf > item 0 > options > authMechanismProperties</strong>
1121+
</summary>
1122+
<blockquote>
1123+
1124+
| | |
1125+
| ------------------------- | ---------------- |
1126+
| **Type** | `object` |
1127+
| **Required** | No |
1128+
| **Additional properties** | Any type allowed |
1129+
1130+
<details>
1131+
<summary>
1132+
<strong> <a name="sink_items_oneOf_i0_options_authMechanismProperties_AWS_CREDENTIAL_PROVIDER"></a>15.1.1.4.1.1. [Optional] Property GitProxy configuration file > sink > sink items > oneOf > item 0 > options > authMechanismProperties > AWS_CREDENTIAL_PROVIDER</strong>
10741133
</summary>
10751134
<blockquote>
10761135

1136+
| | |
1137+
| ------------ | --------- |
1138+
| **Type** | `boolean` |
1139+
| **Required** | No |
1140+
1141+
**Description:** If set to true, the `fromNodeProviderChain()` function from @aws-sdk/credential-providers is passed as the `AWS_CREDENTIAL_PROVIDER`
1142+
1143+
</blockquote>
1144+
</details>
1145+
1146+
</blockquote>
1147+
</details>
1148+
1149+
</blockquote>
1150+
</details>
1151+
1152+
</blockquote>
1153+
<blockquote>
1154+
1155+
#### <a name="sink_items_oneOf_i1"></a>15.1.2. Property `GitProxy configuration file > sink > sink items > oneOf > item 1`
1156+
10771157
| | |
10781158
| ------------------------- | ---------------- |
10791159
| **Type** | `object` |
10801160
| **Required** | No |
10811161
| **Additional properties** | Any type allowed |
10821162

1163+
**Description:** Connection properties for an neDB file-based database
1164+
1165+
<details>
1166+
<summary>
1167+
<strong> <a name="sink_items_oneOf_i1_type"></a>15.1.2.1. [Required] Property GitProxy configuration file > sink > sink items > oneOf > item 1 > type</strong>
1168+
</summary>
1169+
<blockquote>
1170+
1171+
| | |
1172+
| ------------ | ------- |
1173+
| **Type** | `const` |
1174+
| **Required** | Yes |
1175+
1176+
Specific value: `"fs"`
1177+
10831178
</blockquote>
10841179
</details>
10851180

10861181
<details>
10871182
<summary>
1088-
<strong> <a name="sink_items_params"></a>15.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong>
1183+
<strong> <a name="sink_items_oneOf_i1_enabled"></a>15.1.2.2. [Required] Property GitProxy configuration file > sink > sink items > oneOf > item 1 > enabled</strong>
1184+
</summary>
1185+
<blockquote>
1186+
1187+
| | |
1188+
| ------------ | --------- |
1189+
| **Type** | `boolean` |
1190+
| **Required** | Yes |
1191+
1192+
</blockquote>
1193+
</details>
1194+
1195+
<details>
1196+
<summary>
1197+
<strong> <a name="sink_items_oneOf_i1_params"></a>15.1.2.3. [Optional] Property GitProxy configuration file > sink > sink items > oneOf > item 1 > params</strong>
10891198
</summary>
10901199
<blockquote>
10911200

@@ -1095,9 +1204,15 @@ description: JSON schema reference documentation for GitProxy
10951204
| **Required** | No |
10961205
| **Additional properties** | Any type allowed |
10971206

1207+
**Description:** Legacy config property not currently used
1208+
10981209
</blockquote>
10991210
</details>
11001211

1212+
</blockquote>
1213+
1214+
</blockquote>
1215+
11011216
</blockquote>
11021217
</details>
11031218

@@ -1931,4 +2046,4 @@ Specific value: `"jwt"`
19312046
</details>
19322047

19332048
----------------------------------------------------------------------------------------------------------------------------
1934-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-11-18 at 19:51:24 +0900
2049+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-12-12 at 12:07:48 +0000

0 commit comments

Comments
 (0)