@mintlify/validation 0.1.967 → 0.1.969
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/mint-config/schemas/v2/index.d.ts +38 -0
- package/dist/mint-config/schemas/v2/properties/api.d.ts +10 -0
- package/dist/mint-config/schemas/v2/properties/navigation/divisionNav.d.ts +10 -0
- package/dist/mint-config/schemas/v2/properties/navigation/groups.d.ts +4 -0
- package/dist/mint-config/schemas/v2/properties/navigation/index.d.ts +16 -0
- package/dist/mint-config/schemas/v2/properties/navigation/pages.d.ts +4 -0
- package/dist/mint-config/schemas/v2/properties/reusable/openapi.d.ts +12 -0
- package/dist/mint-config/schemas/v2/properties/reusable/openapi.js +18 -2
- package/dist/mint-config/schemas/v2/themes/almond.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/aspen.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/linden.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/luma.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/maple.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/mint.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/palm.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/reusable/index.d.ts +26 -0
- package/dist/mint-config/schemas/v2/themes/sequoia.d.ts +38 -0
- package/dist/mint-config/schemas/v2/themes/willow.d.ts +38 -0
- package/dist/mint-config/validateConfig.d.ts +108 -0
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/dist/types/deployment/assistant.d.ts +2 -1
- package/package.json +2 -2
|
@@ -67,26 +67,32 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
67
67
|
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
|
|
68
68
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
69
69
|
directory: z.ZodOptional<z.ZodString>;
|
|
70
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
70
71
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
71
72
|
}, "strict", z.ZodTypeAny, {
|
|
72
73
|
source: string;
|
|
73
74
|
directory?: string | undefined;
|
|
75
|
+
slug?: "summary" | "operationId" | undefined;
|
|
74
76
|
overlays?: string[] | undefined;
|
|
75
77
|
}, {
|
|
76
78
|
source: string;
|
|
77
79
|
directory?: string | undefined;
|
|
80
|
+
slug?: "summary" | "operationId" | undefined;
|
|
78
81
|
overlays?: string[] | undefined;
|
|
79
82
|
}>]>, "many">, z.ZodObject<{
|
|
80
83
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
81
84
|
directory: z.ZodOptional<z.ZodString>;
|
|
85
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
82
86
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
83
87
|
}, "strict", z.ZodTypeAny, {
|
|
84
88
|
source: string;
|
|
85
89
|
directory?: string | undefined;
|
|
90
|
+
slug?: "summary" | "operationId" | undefined;
|
|
86
91
|
overlays?: string[] | undefined;
|
|
87
92
|
}, {
|
|
88
93
|
source: string;
|
|
89
94
|
directory?: string | undefined;
|
|
95
|
+
slug?: "summary" | "operationId" | undefined;
|
|
90
96
|
overlays?: string[] | undefined;
|
|
91
97
|
}>]>>;
|
|
92
98
|
asyncapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
|
|
@@ -174,10 +180,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
174
180
|
openapi?: string | {
|
|
175
181
|
source: string;
|
|
176
182
|
directory?: string | undefined;
|
|
183
|
+
slug?: "summary" | "operationId" | undefined;
|
|
177
184
|
overlays?: string[] | undefined;
|
|
178
185
|
} | (string | {
|
|
179
186
|
source: string;
|
|
180
187
|
directory?: string | undefined;
|
|
188
|
+
slug?: "summary" | "operationId" | undefined;
|
|
181
189
|
overlays?: string[] | undefined;
|
|
182
190
|
})[] | undefined;
|
|
183
191
|
playground?: {
|
|
@@ -212,10 +220,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
212
220
|
openapi?: string | {
|
|
213
221
|
source: string;
|
|
214
222
|
directory?: string | undefined;
|
|
223
|
+
slug?: "summary" | "operationId" | undefined;
|
|
215
224
|
overlays?: string[] | undefined;
|
|
216
225
|
} | (string | {
|
|
217
226
|
source: string;
|
|
218
227
|
directory?: string | undefined;
|
|
228
|
+
slug?: "summary" | "operationId" | undefined;
|
|
219
229
|
overlays?: string[] | undefined;
|
|
220
230
|
})[] | undefined;
|
|
221
231
|
playground?: {
|
|
@@ -696,10 +706,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
696
706
|
openapi?: string | {
|
|
697
707
|
source: string;
|
|
698
708
|
directory?: string | undefined;
|
|
709
|
+
slug?: "summary" | "operationId" | undefined;
|
|
699
710
|
overlays?: string[] | undefined;
|
|
700
711
|
} | (string | {
|
|
701
712
|
source: string;
|
|
702
713
|
directory?: string | undefined;
|
|
714
|
+
slug?: "summary" | "operationId" | undefined;
|
|
703
715
|
overlays?: string[] | undefined;
|
|
704
716
|
})[] | undefined;
|
|
705
717
|
asyncapi?: string | string[] | {
|
|
@@ -740,10 +752,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
740
752
|
openapi?: string | {
|
|
741
753
|
source: string;
|
|
742
754
|
directory?: string | undefined;
|
|
755
|
+
slug?: "summary" | "operationId" | undefined;
|
|
743
756
|
overlays?: string[] | undefined;
|
|
744
757
|
} | (string | {
|
|
745
758
|
source: string;
|
|
746
759
|
directory?: string | undefined;
|
|
760
|
+
slug?: "summary" | "operationId" | undefined;
|
|
747
761
|
overlays?: string[] | undefined;
|
|
748
762
|
})[] | undefined;
|
|
749
763
|
asyncapi?: string | string[] | {
|
|
@@ -786,10 +800,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
786
800
|
openapi?: string | {
|
|
787
801
|
source: string;
|
|
788
802
|
directory?: string | undefined;
|
|
803
|
+
slug?: "summary" | "operationId" | undefined;
|
|
789
804
|
overlays?: string[] | undefined;
|
|
790
805
|
} | (string | {
|
|
791
806
|
source: string;
|
|
792
807
|
directory?: string | undefined;
|
|
808
|
+
slug?: "summary" | "operationId" | undefined;
|
|
793
809
|
overlays?: string[] | undefined;
|
|
794
810
|
})[] | undefined;
|
|
795
811
|
asyncapi?: string | string[] | {
|
|
@@ -837,10 +853,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
837
853
|
openapi?: string | {
|
|
838
854
|
source: string;
|
|
839
855
|
directory?: string | undefined;
|
|
856
|
+
slug?: "summary" | "operationId" | undefined;
|
|
840
857
|
overlays?: string[] | undefined;
|
|
841
858
|
} | (string | {
|
|
842
859
|
source: string;
|
|
843
860
|
directory?: string | undefined;
|
|
861
|
+
slug?: "summary" | "operationId" | undefined;
|
|
844
862
|
overlays?: string[] | undefined;
|
|
845
863
|
})[] | undefined;
|
|
846
864
|
asyncapi?: string | string[] | {
|
|
@@ -894,10 +912,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
894
912
|
openapi?: string | {
|
|
895
913
|
source: string;
|
|
896
914
|
directory?: string | undefined;
|
|
915
|
+
slug?: "summary" | "operationId" | undefined;
|
|
897
916
|
overlays?: string[] | undefined;
|
|
898
917
|
} | (string | {
|
|
899
918
|
source: string;
|
|
900
919
|
directory?: string | undefined;
|
|
920
|
+
slug?: "summary" | "operationId" | undefined;
|
|
901
921
|
overlays?: string[] | undefined;
|
|
902
922
|
})[] | undefined;
|
|
903
923
|
asyncapi?: string | string[] | {
|
|
@@ -938,10 +958,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
938
958
|
openapi?: string | {
|
|
939
959
|
source: string;
|
|
940
960
|
directory?: string | undefined;
|
|
961
|
+
slug?: "summary" | "operationId" | undefined;
|
|
941
962
|
overlays?: string[] | undefined;
|
|
942
963
|
} | (string | {
|
|
943
964
|
source: string;
|
|
944
965
|
directory?: string | undefined;
|
|
966
|
+
slug?: "summary" | "operationId" | undefined;
|
|
945
967
|
overlays?: string[] | undefined;
|
|
946
968
|
})[] | undefined;
|
|
947
969
|
asyncapi?: string | string[] | {
|
|
@@ -984,10 +1006,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
984
1006
|
openapi?: string | {
|
|
985
1007
|
source: string;
|
|
986
1008
|
directory?: string | undefined;
|
|
1009
|
+
slug?: "summary" | "operationId" | undefined;
|
|
987
1010
|
overlays?: string[] | undefined;
|
|
988
1011
|
} | (string | {
|
|
989
1012
|
source: string;
|
|
990
1013
|
directory?: string | undefined;
|
|
1014
|
+
slug?: "summary" | "operationId" | undefined;
|
|
991
1015
|
overlays?: string[] | undefined;
|
|
992
1016
|
})[] | undefined;
|
|
993
1017
|
asyncapi?: string | string[] | {
|
|
@@ -1035,10 +1059,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
1035
1059
|
openapi?: string | {
|
|
1036
1060
|
source: string;
|
|
1037
1061
|
directory?: string | undefined;
|
|
1062
|
+
slug?: "summary" | "operationId" | undefined;
|
|
1038
1063
|
overlays?: string[] | undefined;
|
|
1039
1064
|
} | (string | {
|
|
1040
1065
|
source: string;
|
|
1041
1066
|
directory?: string | undefined;
|
|
1067
|
+
slug?: "summary" | "operationId" | undefined;
|
|
1042
1068
|
overlays?: string[] | undefined;
|
|
1043
1069
|
})[] | undefined;
|
|
1044
1070
|
asyncapi?: string | string[] | {
|
|
@@ -2139,10 +2165,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
2139
2165
|
openapi?: string | {
|
|
2140
2166
|
source: string;
|
|
2141
2167
|
directory?: string | undefined;
|
|
2168
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2142
2169
|
overlays?: string[] | undefined;
|
|
2143
2170
|
} | (string | {
|
|
2144
2171
|
source: string;
|
|
2145
2172
|
directory?: string | undefined;
|
|
2173
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2146
2174
|
overlays?: string[] | undefined;
|
|
2147
2175
|
})[] | undefined;
|
|
2148
2176
|
asyncapi?: string | string[] | {
|
|
@@ -2190,10 +2218,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
2190
2218
|
openapi?: string | {
|
|
2191
2219
|
source: string;
|
|
2192
2220
|
directory?: string | undefined;
|
|
2221
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2193
2222
|
overlays?: string[] | undefined;
|
|
2194
2223
|
} | (string | {
|
|
2195
2224
|
source: string;
|
|
2196
2225
|
directory?: string | undefined;
|
|
2226
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2197
2227
|
overlays?: string[] | undefined;
|
|
2198
2228
|
})[] | undefined;
|
|
2199
2229
|
asyncapi?: string | string[] | {
|
|
@@ -2241,10 +2271,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
2241
2271
|
openapi?: string | {
|
|
2242
2272
|
source: string;
|
|
2243
2273
|
directory?: string | undefined;
|
|
2274
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2244
2275
|
overlays?: string[] | undefined;
|
|
2245
2276
|
} | (string | {
|
|
2246
2277
|
source: string;
|
|
2247
2278
|
directory?: string | undefined;
|
|
2279
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2248
2280
|
overlays?: string[] | undefined;
|
|
2249
2281
|
})[] | undefined;
|
|
2250
2282
|
playground?: {
|
|
@@ -2622,10 +2654,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
2622
2654
|
openapi?: string | {
|
|
2623
2655
|
source: string;
|
|
2624
2656
|
directory?: string | undefined;
|
|
2657
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2625
2658
|
overlays?: string[] | undefined;
|
|
2626
2659
|
} | (string | {
|
|
2627
2660
|
source: string;
|
|
2628
2661
|
directory?: string | undefined;
|
|
2662
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2629
2663
|
overlays?: string[] | undefined;
|
|
2630
2664
|
})[] | undefined;
|
|
2631
2665
|
asyncapi?: string | string[] | {
|
|
@@ -2673,10 +2707,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
2673
2707
|
openapi?: string | {
|
|
2674
2708
|
source: string;
|
|
2675
2709
|
directory?: string | undefined;
|
|
2710
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2676
2711
|
overlays?: string[] | undefined;
|
|
2677
2712
|
} | (string | {
|
|
2678
2713
|
source: string;
|
|
2679
2714
|
directory?: string | undefined;
|
|
2715
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2680
2716
|
overlays?: string[] | undefined;
|
|
2681
2717
|
})[] | undefined;
|
|
2682
2718
|
asyncapi?: string | string[] | {
|
|
@@ -2725,10 +2761,12 @@ export declare const docsConfigUnifiedSchema: z.ZodObject<{
|
|
|
2725
2761
|
openapi?: string | {
|
|
2726
2762
|
source: string;
|
|
2727
2763
|
directory?: string | undefined;
|
|
2764
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2728
2765
|
overlays?: string[] | undefined;
|
|
2729
2766
|
} | (string | {
|
|
2730
2767
|
source: string;
|
|
2731
2768
|
directory?: string | undefined;
|
|
2769
|
+
slug?: "summary" | "operationId" | undefined;
|
|
2732
2770
|
overlays?: string[] | undefined;
|
|
2733
2771
|
})[] | undefined;
|
|
2734
2772
|
playground?: {
|
|
@@ -3,26 +3,32 @@ export declare const apiSchema: z.ZodObject<{
|
|
|
3
3
|
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
|
|
4
4
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
5
5
|
directory: z.ZodOptional<z.ZodString>;
|
|
6
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
6
7
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
7
8
|
}, "strict", z.ZodTypeAny, {
|
|
8
9
|
source: string;
|
|
9
10
|
directory?: string | undefined;
|
|
11
|
+
slug?: "summary" | "operationId" | undefined;
|
|
10
12
|
overlays?: string[] | undefined;
|
|
11
13
|
}, {
|
|
12
14
|
source: string;
|
|
13
15
|
directory?: string | undefined;
|
|
16
|
+
slug?: "summary" | "operationId" | undefined;
|
|
14
17
|
overlays?: string[] | undefined;
|
|
15
18
|
}>]>, "many">, z.ZodObject<{
|
|
16
19
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
17
20
|
directory: z.ZodOptional<z.ZodString>;
|
|
21
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
18
22
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
19
23
|
}, "strict", z.ZodTypeAny, {
|
|
20
24
|
source: string;
|
|
21
25
|
directory?: string | undefined;
|
|
26
|
+
slug?: "summary" | "operationId" | undefined;
|
|
22
27
|
overlays?: string[] | undefined;
|
|
23
28
|
}, {
|
|
24
29
|
source: string;
|
|
25
30
|
directory?: string | undefined;
|
|
31
|
+
slug?: "summary" | "operationId" | undefined;
|
|
26
32
|
overlays?: string[] | undefined;
|
|
27
33
|
}>]>>;
|
|
28
34
|
asyncapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
|
|
@@ -110,10 +116,12 @@ export declare const apiSchema: z.ZodObject<{
|
|
|
110
116
|
openapi?: string | {
|
|
111
117
|
source: string;
|
|
112
118
|
directory?: string | undefined;
|
|
119
|
+
slug?: "summary" | "operationId" | undefined;
|
|
113
120
|
overlays?: string[] | undefined;
|
|
114
121
|
} | (string | {
|
|
115
122
|
source: string;
|
|
116
123
|
directory?: string | undefined;
|
|
124
|
+
slug?: "summary" | "operationId" | undefined;
|
|
117
125
|
overlays?: string[] | undefined;
|
|
118
126
|
})[] | undefined;
|
|
119
127
|
playground?: {
|
|
@@ -148,10 +156,12 @@ export declare const apiSchema: z.ZodObject<{
|
|
|
148
156
|
openapi?: string | {
|
|
149
157
|
source: string;
|
|
150
158
|
directory?: string | undefined;
|
|
159
|
+
slug?: "summary" | "operationId" | undefined;
|
|
151
160
|
overlays?: string[] | undefined;
|
|
152
161
|
} | (string | {
|
|
153
162
|
source: string;
|
|
154
163
|
directory?: string | undefined;
|
|
164
|
+
slug?: "summary" | "operationId" | undefined;
|
|
155
165
|
overlays?: string[] | undefined;
|
|
156
166
|
})[] | undefined;
|
|
157
167
|
playground?: {
|
|
@@ -17,26 +17,32 @@ declare const SomeApiSchema: z.ZodObject<{
|
|
|
17
17
|
openapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
|
|
18
18
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
19
19
|
directory: z.ZodOptional<z.ZodString>;
|
|
20
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
20
21
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
21
22
|
}, "strict", z.ZodTypeAny, {
|
|
22
23
|
source: string;
|
|
23
24
|
directory?: string | undefined;
|
|
25
|
+
slug?: "summary" | "operationId" | undefined;
|
|
24
26
|
overlays?: string[] | undefined;
|
|
25
27
|
}, {
|
|
26
28
|
source: string;
|
|
27
29
|
directory?: string | undefined;
|
|
30
|
+
slug?: "summary" | "operationId" | undefined;
|
|
28
31
|
overlays?: string[] | undefined;
|
|
29
32
|
}>]>, "many">, z.ZodObject<{
|
|
30
33
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
31
34
|
directory: z.ZodOptional<z.ZodString>;
|
|
35
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
32
36
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
33
37
|
}, "strict", z.ZodTypeAny, {
|
|
34
38
|
source: string;
|
|
35
39
|
directory?: string | undefined;
|
|
40
|
+
slug?: "summary" | "operationId" | undefined;
|
|
36
41
|
overlays?: string[] | undefined;
|
|
37
42
|
}, {
|
|
38
43
|
source: string;
|
|
39
44
|
directory?: string | undefined;
|
|
45
|
+
slug?: "summary" | "operationId" | undefined;
|
|
40
46
|
overlays?: string[] | undefined;
|
|
41
47
|
}>]>>;
|
|
42
48
|
asyncapi: z.ZodOptional<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">, z.ZodObject<{
|
|
@@ -53,10 +59,12 @@ declare const SomeApiSchema: z.ZodObject<{
|
|
|
53
59
|
openapi?: string | {
|
|
54
60
|
source: string;
|
|
55
61
|
directory?: string | undefined;
|
|
62
|
+
slug?: "summary" | "operationId" | undefined;
|
|
56
63
|
overlays?: string[] | undefined;
|
|
57
64
|
} | (string | {
|
|
58
65
|
source: string;
|
|
59
66
|
directory?: string | undefined;
|
|
67
|
+
slug?: "summary" | "operationId" | undefined;
|
|
60
68
|
overlays?: string[] | undefined;
|
|
61
69
|
})[] | undefined;
|
|
62
70
|
asyncapi?: string | string[] | {
|
|
@@ -67,10 +75,12 @@ declare const SomeApiSchema: z.ZodObject<{
|
|
|
67
75
|
openapi?: string | {
|
|
68
76
|
source: string;
|
|
69
77
|
directory?: string | undefined;
|
|
78
|
+
slug?: "summary" | "operationId" | undefined;
|
|
70
79
|
overlays?: string[] | undefined;
|
|
71
80
|
} | (string | {
|
|
72
81
|
source: string;
|
|
73
82
|
directory?: string | undefined;
|
|
83
|
+
slug?: "summary" | "operationId" | undefined;
|
|
74
84
|
overlays?: string[] | undefined;
|
|
75
85
|
})[] | undefined;
|
|
76
86
|
asyncapi?: string | string[] | {
|
|
@@ -185,10 +185,12 @@ export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
|
185
185
|
openapi?: string | {
|
|
186
186
|
source: string;
|
|
187
187
|
directory?: string | undefined;
|
|
188
|
+
slug?: "summary" | "operationId" | undefined;
|
|
188
189
|
overlays?: string[] | undefined;
|
|
189
190
|
} | (string | {
|
|
190
191
|
source: string;
|
|
191
192
|
directory?: string | undefined;
|
|
193
|
+
slug?: "summary" | "operationId" | undefined;
|
|
192
194
|
overlays?: string[] | undefined;
|
|
193
195
|
})[] | undefined;
|
|
194
196
|
asyncapi?: string | string[] | {
|
|
@@ -229,10 +231,12 @@ export declare const groupsSchema: z.ZodArray<z.ZodType<{
|
|
|
229
231
|
openapi?: string | {
|
|
230
232
|
source: string;
|
|
231
233
|
directory?: string | undefined;
|
|
234
|
+
slug?: "summary" | "operationId" | undefined;
|
|
232
235
|
overlays?: string[] | undefined;
|
|
233
236
|
} | (string | {
|
|
234
237
|
source: string;
|
|
235
238
|
directory?: string | undefined;
|
|
239
|
+
slug?: "summary" | "operationId" | undefined;
|
|
236
240
|
overlays?: string[] | undefined;
|
|
237
241
|
})[] | undefined;
|
|
238
242
|
asyncapi?: string | string[] | {
|
|
@@ -177,10 +177,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
177
177
|
openapi?: string | {
|
|
178
178
|
source: string;
|
|
179
179
|
directory?: string | undefined;
|
|
180
|
+
slug?: "summary" | "operationId" | undefined;
|
|
180
181
|
overlays?: string[] | undefined;
|
|
181
182
|
} | (string | {
|
|
182
183
|
source: string;
|
|
183
184
|
directory?: string | undefined;
|
|
185
|
+
slug?: "summary" | "operationId" | undefined;
|
|
184
186
|
overlays?: string[] | undefined;
|
|
185
187
|
})[] | undefined;
|
|
186
188
|
asyncapi?: string | string[] | {
|
|
@@ -221,10 +223,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
221
223
|
openapi?: string | {
|
|
222
224
|
source: string;
|
|
223
225
|
directory?: string | undefined;
|
|
226
|
+
slug?: "summary" | "operationId" | undefined;
|
|
224
227
|
overlays?: string[] | undefined;
|
|
225
228
|
} | (string | {
|
|
226
229
|
source: string;
|
|
227
230
|
directory?: string | undefined;
|
|
231
|
+
slug?: "summary" | "operationId" | undefined;
|
|
228
232
|
overlays?: string[] | undefined;
|
|
229
233
|
})[] | undefined;
|
|
230
234
|
asyncapi?: string | string[] | {
|
|
@@ -267,10 +271,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
267
271
|
openapi?: string | {
|
|
268
272
|
source: string;
|
|
269
273
|
directory?: string | undefined;
|
|
274
|
+
slug?: "summary" | "operationId" | undefined;
|
|
270
275
|
overlays?: string[] | undefined;
|
|
271
276
|
} | (string | {
|
|
272
277
|
source: string;
|
|
273
278
|
directory?: string | undefined;
|
|
279
|
+
slug?: "summary" | "operationId" | undefined;
|
|
274
280
|
overlays?: string[] | undefined;
|
|
275
281
|
})[] | undefined;
|
|
276
282
|
asyncapi?: string | string[] | {
|
|
@@ -318,10 +324,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
318
324
|
openapi?: string | {
|
|
319
325
|
source: string;
|
|
320
326
|
directory?: string | undefined;
|
|
327
|
+
slug?: "summary" | "operationId" | undefined;
|
|
321
328
|
overlays?: string[] | undefined;
|
|
322
329
|
} | (string | {
|
|
323
330
|
source: string;
|
|
324
331
|
directory?: string | undefined;
|
|
332
|
+
slug?: "summary" | "operationId" | undefined;
|
|
325
333
|
overlays?: string[] | undefined;
|
|
326
334
|
})[] | undefined;
|
|
327
335
|
asyncapi?: string | string[] | {
|
|
@@ -375,10 +383,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
375
383
|
openapi?: string | {
|
|
376
384
|
source: string;
|
|
377
385
|
directory?: string | undefined;
|
|
386
|
+
slug?: "summary" | "operationId" | undefined;
|
|
378
387
|
overlays?: string[] | undefined;
|
|
379
388
|
} | (string | {
|
|
380
389
|
source: string;
|
|
381
390
|
directory?: string | undefined;
|
|
391
|
+
slug?: "summary" | "operationId" | undefined;
|
|
382
392
|
overlays?: string[] | undefined;
|
|
383
393
|
})[] | undefined;
|
|
384
394
|
asyncapi?: string | string[] | {
|
|
@@ -419,10 +429,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
419
429
|
openapi?: string | {
|
|
420
430
|
source: string;
|
|
421
431
|
directory?: string | undefined;
|
|
432
|
+
slug?: "summary" | "operationId" | undefined;
|
|
422
433
|
overlays?: string[] | undefined;
|
|
423
434
|
} | (string | {
|
|
424
435
|
source: string;
|
|
425
436
|
directory?: string | undefined;
|
|
437
|
+
slug?: "summary" | "operationId" | undefined;
|
|
426
438
|
overlays?: string[] | undefined;
|
|
427
439
|
})[] | undefined;
|
|
428
440
|
asyncapi?: string | string[] | {
|
|
@@ -465,10 +477,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
465
477
|
openapi?: string | {
|
|
466
478
|
source: string;
|
|
467
479
|
directory?: string | undefined;
|
|
480
|
+
slug?: "summary" | "operationId" | undefined;
|
|
468
481
|
overlays?: string[] | undefined;
|
|
469
482
|
} | (string | {
|
|
470
483
|
source: string;
|
|
471
484
|
directory?: string | undefined;
|
|
485
|
+
slug?: "summary" | "operationId" | undefined;
|
|
472
486
|
overlays?: string[] | undefined;
|
|
473
487
|
})[] | undefined;
|
|
474
488
|
asyncapi?: string | string[] | {
|
|
@@ -516,10 +530,12 @@ export declare const navigationSchema: z.ZodUnion<[z.ZodObject<{
|
|
|
516
530
|
openapi?: string | {
|
|
517
531
|
source: string;
|
|
518
532
|
directory?: string | undefined;
|
|
533
|
+
slug?: "summary" | "operationId" | undefined;
|
|
519
534
|
overlays?: string[] | undefined;
|
|
520
535
|
} | (string | {
|
|
521
536
|
source: string;
|
|
522
537
|
directory?: string | undefined;
|
|
538
|
+
slug?: "summary" | "operationId" | undefined;
|
|
523
539
|
overlays?: string[] | undefined;
|
|
524
540
|
})[] | undefined;
|
|
525
541
|
asyncapi?: string | string[] | {
|
|
@@ -39,10 +39,12 @@ export declare const pagesSchema: z.ZodArray<z.ZodType<string | NavigationLinkCo
|
|
|
39
39
|
openapi?: string | {
|
|
40
40
|
source: string;
|
|
41
41
|
directory?: string | undefined;
|
|
42
|
+
slug?: "summary" | "operationId" | undefined;
|
|
42
43
|
overlays?: string[] | undefined;
|
|
43
44
|
} | (string | {
|
|
44
45
|
source: string;
|
|
45
46
|
directory?: string | undefined;
|
|
47
|
+
slug?: "summary" | "operationId" | undefined;
|
|
46
48
|
overlays?: string[] | undefined;
|
|
47
49
|
})[] | undefined;
|
|
48
50
|
asyncapi?: string | string[] | {
|
|
@@ -83,10 +85,12 @@ export declare const pagesSchema: z.ZodArray<z.ZodType<string | NavigationLinkCo
|
|
|
83
85
|
openapi?: string | {
|
|
84
86
|
source: string;
|
|
85
87
|
directory?: string | undefined;
|
|
88
|
+
slug?: "summary" | "operationId" | undefined;
|
|
86
89
|
overlays?: string[] | undefined;
|
|
87
90
|
} | (string | {
|
|
88
91
|
source: string;
|
|
89
92
|
directory?: string | undefined;
|
|
93
|
+
slug?: "summary" | "operationId" | undefined;
|
|
90
94
|
overlays?: string[] | undefined;
|
|
91
95
|
})[] | undefined;
|
|
92
96
|
asyncapi?: string | string[] | {
|
|
@@ -1,48 +1,60 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
export declare const openapiStringSchema: z.ZodEffects<z.ZodString, string, string>;
|
|
3
|
+
export declare const openapiSlugSchema: z.ZodEnum<["summary", "operationId"]>;
|
|
3
4
|
export declare const openapiObjSchema: z.ZodObject<{
|
|
4
5
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
5
6
|
directory: z.ZodOptional<z.ZodString>;
|
|
7
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
6
8
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
7
9
|
}, "strict", z.ZodTypeAny, {
|
|
8
10
|
source: string;
|
|
9
11
|
directory?: string | undefined;
|
|
12
|
+
slug?: "summary" | "operationId" | undefined;
|
|
10
13
|
overlays?: string[] | undefined;
|
|
11
14
|
}, {
|
|
12
15
|
source: string;
|
|
13
16
|
directory?: string | undefined;
|
|
17
|
+
slug?: "summary" | "operationId" | undefined;
|
|
14
18
|
overlays?: string[] | undefined;
|
|
15
19
|
}>;
|
|
16
20
|
export declare const openApiSchema: z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodString, string, string>, z.ZodObject<{
|
|
17
21
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
18
22
|
directory: z.ZodOptional<z.ZodString>;
|
|
23
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
19
24
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
20
25
|
}, "strict", z.ZodTypeAny, {
|
|
21
26
|
source: string;
|
|
22
27
|
directory?: string | undefined;
|
|
28
|
+
slug?: "summary" | "operationId" | undefined;
|
|
23
29
|
overlays?: string[] | undefined;
|
|
24
30
|
}, {
|
|
25
31
|
source: string;
|
|
26
32
|
directory?: string | undefined;
|
|
33
|
+
slug?: "summary" | "operationId" | undefined;
|
|
27
34
|
overlays?: string[] | undefined;
|
|
28
35
|
}>]>, "many">, z.ZodObject<{
|
|
29
36
|
source: z.ZodEffects<z.ZodString, string, string>;
|
|
30
37
|
directory: z.ZodOptional<z.ZodString>;
|
|
38
|
+
slug: z.ZodOptional<z.ZodEnum<["summary", "operationId"]>>;
|
|
31
39
|
overlays: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
|
|
32
40
|
}, "strict", z.ZodTypeAny, {
|
|
33
41
|
source: string;
|
|
34
42
|
directory?: string | undefined;
|
|
43
|
+
slug?: "summary" | "operationId" | undefined;
|
|
35
44
|
overlays?: string[] | undefined;
|
|
36
45
|
}, {
|
|
37
46
|
source: string;
|
|
38
47
|
directory?: string | undefined;
|
|
48
|
+
slug?: "summary" | "operationId" | undefined;
|
|
39
49
|
overlays?: string[] | undefined;
|
|
40
50
|
}>]>;
|
|
41
51
|
export type OpenApiObjConfig = z.infer<typeof openapiObjSchema>;
|
|
42
52
|
export type OpenApiConfig = z.infer<typeof openApiSchema>;
|
|
53
|
+
export type OpenApiSlugSource = z.infer<typeof openapiSlugSchema>;
|
|
43
54
|
export type OpenApiConfigEntry = {
|
|
44
55
|
source: string;
|
|
45
56
|
directory?: string;
|
|
57
|
+
slug?: OpenApiSlugSource;
|
|
46
58
|
overlays?: string[];
|
|
47
59
|
};
|
|
48
60
|
/** Normalizes any accepted `openapi` config shape into a flat list of entries. */
|
|
@@ -30,10 +30,14 @@ export const openapiStringSchema = z
|
|
|
30
30
|
return normalizeRelativePath(value);
|
|
31
31
|
}
|
|
32
32
|
});
|
|
33
|
+
export const openapiSlugSchema = z
|
|
34
|
+
.enum(['summary', 'operationId'])
|
|
35
|
+
.describe('What the last segment of each generated endpoint slug is derived from. "summary" (default) kebab-cases the operation summary. "operationId" kebab-cases the operationId and falls back to the summary when an operation has none. The directory and tag folders are unaffected.');
|
|
33
36
|
export const openapiObjSchema = z
|
|
34
37
|
.object({
|
|
35
38
|
source: openapiStringSchema,
|
|
36
39
|
directory: z.string().trim().optional(),
|
|
40
|
+
slug: openapiSlugSchema.optional(),
|
|
37
41
|
overlays: z
|
|
38
42
|
.array(openapiStringSchema)
|
|
39
43
|
.optional()
|
|
@@ -56,7 +60,19 @@ export const extractOpenApiEntries = (config) => {
|
|
|
56
60
|
if (Array.isArray(config)) {
|
|
57
61
|
return config.map((entry) => typeof entry === 'string'
|
|
58
62
|
? { source: entry }
|
|
59
|
-
: {
|
|
63
|
+
: {
|
|
64
|
+
source: entry.source,
|
|
65
|
+
directory: entry.directory,
|
|
66
|
+
slug: entry.slug,
|
|
67
|
+
overlays: entry.overlays,
|
|
68
|
+
});
|
|
60
69
|
}
|
|
61
|
-
return [
|
|
70
|
+
return [
|
|
71
|
+
{
|
|
72
|
+
source: config.source,
|
|
73
|
+
directory: config.directory,
|
|
74
|
+
slug: config.slug,
|
|
75
|
+
overlays: config.overlays,
|
|
76
|
+
},
|
|
77
|
+
];
|
|
62
78
|
};
|