Skip to content

Commit 6231db0

Browse files
kriswestkriswest
committed
chore: regenerate schema doc
1 parent 65c508d commit 6231db0

1 file changed

Lines changed: 137 additions & 6 deletions

File tree

‎website/docs/configuration/reference.mdx‎

Lines changed: 137 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,38 @@ Must be one of:
787787

788788
<details>
789789
<summary>
790-
<strong> <a name="tls"></a>18. [Optional] Property GitProxy configuration file > tls</strong>
790+
<strong> <a name="apiAuthentication"></a>18. [Optional] Property GitProxy configuration file > apiAuthentication</strong>
791+
</summary>
792+
<blockquote>
793+
794+
| | |
795+
| ------------ | ------- |
796+
| **Type** | `array` |
797+
| **Required** | No |
798+
799+
**Description:** List of authentication sources for API endpoints. May be empty, in which case all endpoints are public.
800+
801+
| Each item of this array must be | Description |
802+
| ------------------------------------------ | ------------------------------------------ |
803+
| [authentication](#apiAuthentication_items) | Configuration for an authentication source |
804+
805+
### <a name="autogenerated_heading_6"></a>18.1. GitProxy configuration file > apiAuthentication > authentication
806+
807+
| | |
808+
| ------------------------- | --------------------------------------------- |
809+
| **Type** | `object` |
810+
| **Required** | No |
811+
| **Additional properties** | Any type allowed |
812+
| **Same definition as** | [authentication_items](#authentication_items) |
813+
814+
**Description:** Configuration for an authentication source
815+
816+
</blockquote>
817+
</details>
818+
819+
<details>
820+
<summary>
821+
<strong> <a name="tls"></a>19. [Optional] Property GitProxy configuration file > tls</strong>
791822
</summary>
792823
<blockquote>
793824

@@ -801,7 +832,7 @@ Must be one of:
801832

802833
<details>
803834
<summary>
804-
<strong> <a name="tls_enabled"></a>18.1. [Required] Property GitProxy configuration file > tls > enabled</strong>
835+
<strong> <a name="tls_enabled"></a>19.1. [Required] Property GitProxy configuration file > tls > enabled</strong>
805836
</summary>
806837
<blockquote>
807838

@@ -815,7 +846,7 @@ Must be one of:
815846

816847
<details>
817848
<summary>
818-
<strong> <a name="tls_key"></a>18.2. [Required] Property GitProxy configuration file > tls > key</strong>
849+
<strong> <a name="tls_key"></a>19.2. [Required] Property GitProxy configuration file > tls > key</strong>
819850
</summary>
820851
<blockquote>
821852

@@ -829,7 +860,7 @@ Must be one of:
829860

830861
<details>
831862
<summary>
832-
<strong> <a name="tls_cert"></a>18.3. [Required] Property GitProxy configuration file > tls > cert</strong>
863+
<strong> <a name="tls_cert"></a>19.3. [Required] Property GitProxy configuration file > tls > cert</strong>
833864
</summary>
834865
<blockquote>
835866

@@ -846,7 +877,7 @@ Must be one of:
846877

847878
<details>
848879
<summary>
849-
<strong> <a name="configurationSources"></a>19. [Optional] Property GitProxy configuration file > configurationSources</strong>
880+
<strong> <a name="configurationSources"></a>20. [Optional] Property GitProxy configuration file > configurationSources</strong>
850881
</summary>
851882
<blockquote>
852883

@@ -859,5 +890,105 @@ Must be one of:
859890
</blockquote>
860891
</details>
861892

893+
<details>
894+
<summary>
895+
<strong> <a name="uiRouteAuth"></a>21. [Optional] Property GitProxy configuration file > uiRouteAuth</strong>
896+
</summary>
897+
<blockquote>
898+
899+
| | |
900+
| ------------------------- | ---------------- |
901+
| **Type** | `object` |
902+
| **Required** | No |
903+
| **Additional properties** | Any type allowed |
904+
905+
**Description:** UI routes that require authentication (logged in or admin)
906+
907+
<details>
908+
<summary>
909+
<strong> <a name="uiRouteAuth_enabled"></a>21.1. [Optional] Property GitProxy configuration file > uiRouteAuth > enabled</strong>
910+
</summary>
911+
<blockquote>
912+
913+
| | |
914+
| ------------ | --------- |
915+
| **Type** | `boolean` |
916+
| **Required** | No |
917+
918+
</blockquote>
919+
</details>
920+
921+
<details>
922+
<summary>
923+
<strong> <a name="uiRouteAuth_rules"></a>21.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules</strong>
924+
</summary>
925+
<blockquote>
926+
927+
| | |
928+
| ------------ | ------- |
929+
| **Type** | `array` |
930+
| **Required** | No |
931+
932+
| Each item of this array must be | Description |
933+
| ----------------------------------------- | ----------- |
934+
| [routeAuthRule](#uiRouteAuth_rules_items) | - |
935+
936+
#### <a name="autogenerated_heading_7"></a>21.2.1. GitProxy configuration file > uiRouteAuth > rules > routeAuthRule
937+
938+
| | |
939+
| ------------------------- | --------------------------- |
940+
| **Type** | `object` |
941+
| **Required** | No |
942+
| **Additional properties** | Any type allowed |
943+
| **Defined in** | #/definitions/routeAuthRule |
944+
945+
<details>
946+
<summary>
947+
<strong> <a name="uiRouteAuth_rules_items_pattern"></a>21.2.1.1. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > pattern</strong>
948+
</summary>
949+
<blockquote>
950+
951+
| | |
952+
| ------------ | -------- |
953+
| **Type** | `string` |
954+
| **Required** | No |
955+
956+
</blockquote>
957+
</details>
958+
959+
<details>
960+
<summary>
961+
<strong> <a name="uiRouteAuth_rules_items_adminOnly"></a>21.2.1.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > adminOnly</strong>
962+
</summary>
963+
<blockquote>
964+
965+
| | |
966+
| ------------ | --------- |
967+
| **Type** | `boolean` |
968+
| **Required** | No |
969+
970+
</blockquote>
971+
</details>
972+
973+
<details>
974+
<summary>
975+
<strong> <a name="uiRouteAuth_rules_items_loginRequired"></a>21.2.1.3. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > loginRequired</strong>
976+
</summary>
977+
<blockquote>
978+
979+
| | |
980+
| ------------ | --------- |
981+
| **Type** | `boolean` |
982+
| **Required** | No |
983+
984+
</blockquote>
985+
</details>
986+
987+
</blockquote>
988+
</details>
989+
990+
</blockquote>
991+
</details>
992+
862993
----------------------------------------------------------------------------------------------------------------------------
863-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-05-22 at 11:28:04 +0100
994+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-03 at 17:56:55 +0100

0 commit comments

Comments
 (0)