@scalar/oas-utils 0.4.32 → 0.5.0
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/CHANGELOG.md +32 -0
- package/dist/entities/cookie/cookie.d.ts +2 -17
- package/dist/entities/cookie/cookie.d.ts.map +1 -1
- package/dist/entities/environment/environment.d.ts +2 -14
- package/dist/entities/environment/environment.d.ts.map +1 -1
- package/dist/entities/shared/utility.d.ts +1 -1
- package/dist/entities/shared/utility.d.ts.map +1 -1
- package/dist/entities/spec/collection.d.ts +76 -501
- package/dist/entities/spec/collection.d.ts.map +1 -1
- package/dist/entities/spec/operation.d.ts +60 -290
- package/dist/entities/spec/operation.d.ts.map +1 -1
- package/dist/entities/spec/parameters.d.ts +33 -50
- package/dist/entities/spec/parameters.d.ts.map +1 -1
- package/dist/entities/spec/request-examples.d.ts +161 -998
- package/dist/entities/spec/request-examples.d.ts.map +1 -1
- package/dist/entities/spec/request-examples.js +11 -6
- package/dist/entities/spec/request-examples.js.map +2 -2
- package/dist/entities/spec/requests.d.ts +102 -595
- package/dist/entities/spec/requests.d.ts.map +1 -1
- package/dist/entities/spec/server.d.ts +12 -156
- package/dist/entities/spec/server.d.ts.map +1 -1
- package/dist/entities/spec/spec-objects.d.ts +37 -229
- package/dist/entities/spec/spec-objects.d.ts.map +1 -1
- package/dist/entities/spec/x-scalar-environments.d.ts +8 -56
- package/dist/entities/spec/x-scalar-environments.d.ts.map +1 -1
- package/dist/entities/spec/x-scalar-secrets.d.ts +2 -14
- package/dist/entities/spec/x-scalar-secrets.d.ts.map +1 -1
- package/dist/entities/workspace/workspace.d.ts +218 -98
- package/dist/entities/workspace/workspace.d.ts.map +1 -1
- package/dist/entities/workspace/workspace.js +4 -5
- package/dist/entities/workspace/workspace.js.map +2 -2
- package/dist/helpers/parse.js +1 -1
- package/dist/helpers/parse.js.map +2 -2
- package/dist/helpers/schema-model.d.ts +3 -3
- package/dist/helpers/schema-model.d.ts.map +1 -1
- package/dist/helpers/schema-model.js.map +1 -1
- package/dist/helpers/security/get-schemes.d.ts +27 -27
- package/dist/helpers/security/get-schemes.d.ts.map +1 -1
- package/dist/migrations/v-2.5.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.5.0/migration.js.map +2 -2
- package/dist/spec-getters/get-example-from-schema.d.ts +26 -23
- package/dist/spec-getters/get-example-from-schema.d.ts.map +1 -1
- package/dist/spec-getters/get-example-from-schema.js +330 -174
- package/dist/spec-getters/get-example-from-schema.js.map +2 -2
- package/package.json +9 -9
- package/dist/helpers/operation-to-har/index.d.ts +0 -2
- package/dist/helpers/operation-to-har/index.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/index.js +0 -5
- package/dist/helpers/operation-to-har/index.js.map +0 -7
- package/dist/helpers/operation-to-har/operation-to-har.d.ts +0 -49
- package/dist/helpers/operation-to-har/operation-to-har.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/operation-to-har.js +0 -68
- package/dist/helpers/operation-to-har/operation-to-har.js.map +0 -7
- package/dist/helpers/operation-to-har/process-body.d.ts +0 -12
- package/dist/helpers/operation-to-har/process-body.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-body.js +0 -80
- package/dist/helpers/operation-to-har/process-body.js.map +0 -7
- package/dist/helpers/operation-to-har/process-parameters.d.ts +0 -19
- package/dist/helpers/operation-to-har/process-parameters.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-parameters.js +0 -261
- package/dist/helpers/operation-to-har/process-parameters.js.map +0 -7
- package/dist/helpers/operation-to-har/process-security-schemes.d.ts +0 -15
- package/dist/helpers/operation-to-har/process-security-schemes.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-security-schemes.js +0 -62
- package/dist/helpers/operation-to-har/process-security-schemes.js.map +0 -7
- package/dist/helpers/operation-to-har/process-server-url.d.ts +0 -6
- package/dist/helpers/operation-to-har/process-server-url.d.ts.map +0 -1
- package/dist/helpers/operation-to-har/process-server-url.js +0 -27
- package/dist/helpers/operation-to-har/process-server-url.js.map +0 -7
|
@@ -37,675 +37,182 @@ export type RequestEvent = {
|
|
|
37
37
|
};
|
|
38
38
|
/** Open API Compliant Request Validator */
|
|
39
39
|
export declare const oasRequestSchema: z.ZodObject<{
|
|
40
|
-
|
|
41
|
-
* A list of tags for API documentation control. Tags can be used for logical
|
|
42
|
-
* grouping of operations by resources or any other qualifier.
|
|
43
|
-
*
|
|
44
|
-
* These tags are the openapi spec tag names, not uids
|
|
45
|
-
*/
|
|
46
|
-
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
47
|
-
/** A short summary of what the operation does. */
|
|
40
|
+
tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
48
41
|
summary: z.ZodOptional<z.ZodString>;
|
|
49
|
-
/** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
|
|
50
42
|
description: z.ZodOptional<z.ZodString>;
|
|
51
|
-
/**
|
|
52
|
-
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
|
|
53
|
-
* The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an
|
|
54
|
-
* operation, therefore, it is RECOMMENDED to follow bin common programming naming conventions./
|
|
55
|
-
*/
|
|
56
43
|
operationId: z.ZodOptional<z.ZodString>;
|
|
57
|
-
|
|
58
|
-
* A declaration of which security mechanisms can be used across the API. The list of
|
|
59
|
-
* values includes alternative security requirement objects that can be used. Only
|
|
60
|
-
* one of the security requirement objects need to be satisfied to authorize a request.
|
|
61
|
-
* Individual operations can override this definition. To make security optional, an empty
|
|
62
|
-
* security requirement ({}) can be included in the array.
|
|
63
|
-
*/
|
|
64
|
-
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>;
|
|
65
|
-
/**
|
|
66
|
-
* The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
|
|
67
|
-
* HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the
|
|
68
|
-
* HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined
|
|
69
|
-
* semantics and SHOULD be avoided if possible.
|
|
70
|
-
*/
|
|
44
|
+
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>>>>;
|
|
71
45
|
requestBody: z.ZodOptional<z.ZodAny>;
|
|
72
|
-
/**
|
|
73
|
-
* Request parameters
|
|
74
|
-
*/
|
|
75
46
|
parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
76
|
-
in: z.ZodEnum<
|
|
47
|
+
in: z.ZodEnum<{
|
|
48
|
+
cookie: "cookie";
|
|
49
|
+
path: "path";
|
|
50
|
+
query: "query";
|
|
51
|
+
header: "header";
|
|
52
|
+
}>;
|
|
77
53
|
name: z.ZodString;
|
|
78
54
|
description: z.ZodOptional<z.ZodString>;
|
|
79
55
|
required: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
80
56
|
deprecated: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
81
57
|
schema: z.ZodOptional<z.ZodUnknown>;
|
|
82
58
|
content: z.ZodOptional<z.ZodUnknown>;
|
|
83
|
-
style: z.ZodOptional<z.ZodEnum<
|
|
59
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
60
|
+
matrix: "matrix";
|
|
61
|
+
simple: "simple";
|
|
62
|
+
form: "form";
|
|
63
|
+
label: "label";
|
|
64
|
+
spaceDelimited: "spaceDelimited";
|
|
65
|
+
pipeDelimited: "pipeDelimited";
|
|
66
|
+
deepObject: "deepObject";
|
|
67
|
+
}>>;
|
|
84
68
|
explode: z.ZodOptional<z.ZodBoolean>;
|
|
85
69
|
example: z.ZodOptional<z.ZodUnknown>;
|
|
86
|
-
examples: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
70
|
+
examples: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
87
71
|
value: z.ZodOptional<z.ZodUnknown>;
|
|
88
72
|
summary: z.ZodOptional<z.ZodString>;
|
|
89
73
|
externalValue: z.ZodOptional<z.ZodString>;
|
|
90
|
-
},
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
externalValue?: string | undefined;
|
|
94
|
-
}, {
|
|
95
|
-
value?: unknown;
|
|
96
|
-
summary?: string | undefined;
|
|
97
|
-
externalValue?: string | undefined;
|
|
98
|
-
}>>, z.ZodArray<z.ZodUnknown, "many">]>>;
|
|
99
|
-
}, "strip", z.ZodTypeAny, {
|
|
100
|
-
name: string;
|
|
101
|
-
required: boolean;
|
|
102
|
-
deprecated: boolean;
|
|
103
|
-
in: "cookie" | "path" | "query" | "header";
|
|
104
|
-
description?: string | undefined;
|
|
105
|
-
example?: unknown;
|
|
106
|
-
content?: unknown;
|
|
107
|
-
schema?: unknown;
|
|
108
|
-
examples?: unknown[] | Record<string, {
|
|
109
|
-
value?: unknown;
|
|
110
|
-
summary?: string | undefined;
|
|
111
|
-
externalValue?: string | undefined;
|
|
112
|
-
}> | undefined;
|
|
113
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
114
|
-
explode?: boolean | undefined;
|
|
115
|
-
}, {
|
|
116
|
-
name: string;
|
|
117
|
-
in: "cookie" | "path" | "query" | "header";
|
|
118
|
-
description?: string | undefined;
|
|
119
|
-
required?: boolean | undefined;
|
|
120
|
-
example?: unknown;
|
|
121
|
-
content?: unknown;
|
|
122
|
-
schema?: unknown;
|
|
123
|
-
examples?: unknown[] | Record<string, {
|
|
124
|
-
value?: unknown;
|
|
125
|
-
summary?: string | undefined;
|
|
126
|
-
externalValue?: string | undefined;
|
|
127
|
-
}> | undefined;
|
|
128
|
-
deprecated?: boolean | undefined;
|
|
129
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
130
|
-
explode?: boolean | undefined;
|
|
131
|
-
}>, "many">>;
|
|
132
|
-
/**
|
|
133
|
-
* External documentation object
|
|
134
|
-
*/
|
|
135
|
-
externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
74
|
+
}, z.core.$strip>>, z.ZodArray<z.ZodUnknown>]>>;
|
|
75
|
+
}, z.core.$strip>>>;
|
|
76
|
+
externalDocs: z.ZodOptional<z.ZodPipe<z.ZodObject<{
|
|
136
77
|
description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
137
78
|
url: z.ZodString;
|
|
138
|
-
},
|
|
79
|
+
}, z.core.$strip>, z.ZodTransform<{
|
|
139
80
|
url: string;
|
|
140
81
|
description?: string | undefined;
|
|
141
82
|
}, {
|
|
142
|
-
url: string;
|
|
143
|
-
description?: unknown;
|
|
144
|
-
}>, {
|
|
145
83
|
url: string;
|
|
146
84
|
description?: string | undefined;
|
|
147
|
-
}
|
|
148
|
-
url: string;
|
|
149
|
-
description?: unknown;
|
|
150
|
-
}>>;
|
|
85
|
+
}>>>;
|
|
151
86
|
deprecated: z.ZodOptional<z.ZodBoolean>;
|
|
152
|
-
/** Response formats */
|
|
153
87
|
responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
154
|
-
/** Callbacks */
|
|
155
88
|
callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>>;
|
|
156
|
-
/** xScalar examples */
|
|
157
89
|
'x-scalar-examples': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
158
90
|
name: z.ZodOptional<z.ZodString>;
|
|
159
91
|
body: z.ZodOptional<z.ZodObject<{
|
|
160
|
-
encoding: z.ZodEnum<
|
|
161
|
-
|
|
92
|
+
encoding: z.ZodEnum<{
|
|
93
|
+
binary: "binary";
|
|
94
|
+
"application/json": "application/json";
|
|
95
|
+
"text/plain": "text/plain";
|
|
96
|
+
"text/html": "text/html";
|
|
97
|
+
"application/javascript": "application/javascript";
|
|
98
|
+
"application/xml": "application/xml";
|
|
99
|
+
"application/yaml": "application/yaml";
|
|
100
|
+
"application/edn": "application/edn";
|
|
101
|
+
"application/octet-stream": "application/octet-stream";
|
|
102
|
+
"application/x-www-form-urlencoded": "application/x-www-form-urlencoded";
|
|
103
|
+
"multipart/form-data": "multipart/form-data";
|
|
104
|
+
}>;
|
|
105
|
+
content: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodString]>;
|
|
162
106
|
file: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
163
107
|
url: z.ZodString;
|
|
164
108
|
base64: z.ZodOptional<z.ZodString>;
|
|
165
|
-
},
|
|
166
|
-
|
|
167
|
-
base64?: string | undefined;
|
|
168
|
-
}, {
|
|
169
|
-
url: string;
|
|
170
|
-
base64?: string | undefined;
|
|
171
|
-
}>>>;
|
|
172
|
-
}, "strip", z.ZodTypeAny, {
|
|
173
|
-
content: string | Record<string, any>;
|
|
174
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
175
|
-
file?: {
|
|
176
|
-
url: string;
|
|
177
|
-
base64?: string | undefined;
|
|
178
|
-
} | null | undefined;
|
|
179
|
-
}, {
|
|
180
|
-
content: string | Record<string, any>;
|
|
181
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
182
|
-
file?: {
|
|
183
|
-
url: string;
|
|
184
|
-
base64?: string | undefined;
|
|
185
|
-
} | null | undefined;
|
|
186
|
-
}>>;
|
|
109
|
+
}, z.core.$strip>>>;
|
|
110
|
+
}, z.core.$strip>>;
|
|
187
111
|
parameters: z.ZodObject<{
|
|
188
112
|
path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
189
113
|
query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
190
114
|
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
191
115
|
cookies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
192
|
-
},
|
|
193
|
-
|
|
194
|
-
headers?: Record<string, string> | undefined;
|
|
195
|
-
query?: Record<string, string> | undefined;
|
|
196
|
-
cookies?: Record<string, string> | undefined;
|
|
197
|
-
}, {
|
|
198
|
-
path?: Record<string, string> | undefined;
|
|
199
|
-
headers?: Record<string, string> | undefined;
|
|
200
|
-
query?: Record<string, string> | undefined;
|
|
201
|
-
cookies?: Record<string, string> | undefined;
|
|
202
|
-
}>;
|
|
203
|
-
}, "strip", z.ZodTypeAny, {
|
|
204
|
-
parameters: {
|
|
205
|
-
path?: Record<string, string> | undefined;
|
|
206
|
-
headers?: Record<string, string> | undefined;
|
|
207
|
-
query?: Record<string, string> | undefined;
|
|
208
|
-
cookies?: Record<string, string> | undefined;
|
|
209
|
-
};
|
|
210
|
-
name?: string | undefined;
|
|
211
|
-
body?: {
|
|
212
|
-
content: string | Record<string, any>;
|
|
213
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
214
|
-
file?: {
|
|
215
|
-
url: string;
|
|
216
|
-
base64?: string | undefined;
|
|
217
|
-
} | null | undefined;
|
|
218
|
-
} | undefined;
|
|
219
|
-
}, {
|
|
220
|
-
parameters: {
|
|
221
|
-
path?: Record<string, string> | undefined;
|
|
222
|
-
headers?: Record<string, string> | undefined;
|
|
223
|
-
query?: Record<string, string> | undefined;
|
|
224
|
-
cookies?: Record<string, string> | undefined;
|
|
225
|
-
};
|
|
226
|
-
name?: string | undefined;
|
|
227
|
-
body?: {
|
|
228
|
-
content: string | Record<string, any>;
|
|
229
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
230
|
-
file?: {
|
|
231
|
-
url: string;
|
|
232
|
-
base64?: string | undefined;
|
|
233
|
-
} | null | undefined;
|
|
234
|
-
} | undefined;
|
|
235
|
-
}>>>;
|
|
236
|
-
/** Hide operations */
|
|
116
|
+
}, z.core.$strip>;
|
|
117
|
+
}, z.core.$strip>>>;
|
|
237
118
|
'x-internal': z.ZodOptional<z.ZodBoolean>;
|
|
238
|
-
/** Ignore operations */
|
|
239
119
|
'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
|
|
240
|
-
},
|
|
241
|
-
description?: string | undefined;
|
|
242
|
-
summary?: string | undefined;
|
|
243
|
-
externalDocs?: {
|
|
244
|
-
url: string;
|
|
245
|
-
description?: string | undefined;
|
|
246
|
-
} | undefined;
|
|
247
|
-
'x-internal'?: boolean | undefined;
|
|
248
|
-
'x-scalar-ignore'?: boolean | undefined;
|
|
249
|
-
security?: Record<string, string[]>[] | undefined;
|
|
250
|
-
tags?: string[] | undefined;
|
|
251
|
-
deprecated?: boolean | undefined;
|
|
252
|
-
operationId?: string | undefined;
|
|
253
|
-
requestBody?: any;
|
|
254
|
-
parameters?: {
|
|
255
|
-
name: string;
|
|
256
|
-
required: boolean;
|
|
257
|
-
deprecated: boolean;
|
|
258
|
-
in: "cookie" | "path" | "query" | "header";
|
|
259
|
-
description?: string | undefined;
|
|
260
|
-
example?: unknown;
|
|
261
|
-
content?: unknown;
|
|
262
|
-
schema?: unknown;
|
|
263
|
-
examples?: unknown[] | Record<string, {
|
|
264
|
-
value?: unknown;
|
|
265
|
-
summary?: string | undefined;
|
|
266
|
-
externalValue?: string | undefined;
|
|
267
|
-
}> | undefined;
|
|
268
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
269
|
-
explode?: boolean | undefined;
|
|
270
|
-
}[] | undefined;
|
|
271
|
-
responses?: Record<string, any> | undefined;
|
|
272
|
-
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
273
|
-
'x-scalar-examples'?: Record<string, {
|
|
274
|
-
parameters: {
|
|
275
|
-
path?: Record<string, string> | undefined;
|
|
276
|
-
headers?: Record<string, string> | undefined;
|
|
277
|
-
query?: Record<string, string> | undefined;
|
|
278
|
-
cookies?: Record<string, string> | undefined;
|
|
279
|
-
};
|
|
280
|
-
name?: string | undefined;
|
|
281
|
-
body?: {
|
|
282
|
-
content: string | Record<string, any>;
|
|
283
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
284
|
-
file?: {
|
|
285
|
-
url: string;
|
|
286
|
-
base64?: string | undefined;
|
|
287
|
-
} | null | undefined;
|
|
288
|
-
} | undefined;
|
|
289
|
-
}> | undefined;
|
|
290
|
-
}, {
|
|
291
|
-
description?: string | undefined;
|
|
292
|
-
summary?: string | undefined;
|
|
293
|
-
externalDocs?: {
|
|
294
|
-
url: string;
|
|
295
|
-
description?: unknown;
|
|
296
|
-
} | undefined;
|
|
297
|
-
'x-internal'?: boolean | undefined;
|
|
298
|
-
'x-scalar-ignore'?: boolean | undefined;
|
|
299
|
-
security?: Record<string, string[] | undefined>[] | undefined;
|
|
300
|
-
tags?: string[] | undefined;
|
|
301
|
-
deprecated?: boolean | undefined;
|
|
302
|
-
operationId?: string | undefined;
|
|
303
|
-
requestBody?: any;
|
|
304
|
-
parameters?: {
|
|
305
|
-
name: string;
|
|
306
|
-
in: "cookie" | "path" | "query" | "header";
|
|
307
|
-
description?: string | undefined;
|
|
308
|
-
required?: boolean | undefined;
|
|
309
|
-
example?: unknown;
|
|
310
|
-
content?: unknown;
|
|
311
|
-
schema?: unknown;
|
|
312
|
-
examples?: unknown[] | Record<string, {
|
|
313
|
-
value?: unknown;
|
|
314
|
-
summary?: string | undefined;
|
|
315
|
-
externalValue?: string | undefined;
|
|
316
|
-
}> | undefined;
|
|
317
|
-
deprecated?: boolean | undefined;
|
|
318
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
319
|
-
explode?: boolean | undefined;
|
|
320
|
-
}[] | undefined;
|
|
321
|
-
responses?: Record<string, any> | undefined;
|
|
322
|
-
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
323
|
-
'x-scalar-examples'?: Record<string, {
|
|
324
|
-
parameters: {
|
|
325
|
-
path?: Record<string, string> | undefined;
|
|
326
|
-
headers?: Record<string, string> | undefined;
|
|
327
|
-
query?: Record<string, string> | undefined;
|
|
328
|
-
cookies?: Record<string, string> | undefined;
|
|
329
|
-
};
|
|
330
|
-
name?: string | undefined;
|
|
331
|
-
body?: {
|
|
332
|
-
content: string | Record<string, any>;
|
|
333
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
334
|
-
file?: {
|
|
335
|
-
url: string;
|
|
336
|
-
base64?: string | undefined;
|
|
337
|
-
} | null | undefined;
|
|
338
|
-
} | undefined;
|
|
339
|
-
}> | undefined;
|
|
340
|
-
}>;
|
|
120
|
+
}, z.core.$strip>;
|
|
341
121
|
export type PostResponseScript = z.infer<typeof PostResponseSchema>;
|
|
342
122
|
export type PostResponseScripts = z.infer<typeof XPostResponseSchema>['x-post-response'];
|
|
343
123
|
/** Unified request schema for client usage */
|
|
344
|
-
export declare const requestSchema: z.ZodObject<
|
|
345
|
-
/**
|
|
346
|
-
* A list of tags for API documentation control. Tags can be used for logical
|
|
347
|
-
* grouping of operations by resources or any other qualifier.
|
|
348
|
-
*
|
|
349
|
-
* These tags are the openapi spec tag names, not uids
|
|
350
|
-
*/
|
|
351
|
-
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
352
|
-
/** A short summary of what the operation does. */
|
|
353
|
-
summary: z.ZodOptional<z.ZodString>;
|
|
354
|
-
/** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */
|
|
124
|
+
export declare const requestSchema: z.ZodObject<{
|
|
355
125
|
description: z.ZodOptional<z.ZodString>;
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
126
|
+
summary: z.ZodOptional<z.ZodString>;
|
|
127
|
+
externalDocs: z.ZodOptional<z.ZodPipe<z.ZodObject<{
|
|
128
|
+
description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
129
|
+
url: z.ZodString;
|
|
130
|
+
}, z.core.$strip>, z.ZodTransform<{
|
|
131
|
+
url: string;
|
|
132
|
+
description?: string | undefined;
|
|
133
|
+
}, {
|
|
134
|
+
url: string;
|
|
135
|
+
description?: string | undefined;
|
|
136
|
+
}>>>;
|
|
137
|
+
'x-internal': z.ZodOptional<z.ZodBoolean>;
|
|
138
|
+
'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
|
|
139
|
+
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>>>>;
|
|
140
|
+
tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
141
|
+
deprecated: z.ZodOptional<z.ZodBoolean>;
|
|
361
142
|
operationId: z.ZodOptional<z.ZodString>;
|
|
362
|
-
/**
|
|
363
|
-
* A declaration of which security mechanisms can be used across the API. The list of
|
|
364
|
-
* values includes alternative security requirement objects that can be used. Only
|
|
365
|
-
* one of the security requirement objects need to be satisfied to authorize a request.
|
|
366
|
-
* Individual operations can override this definition. To make security optional, an empty
|
|
367
|
-
* security requirement ({}) can be included in the array.
|
|
368
|
-
*/
|
|
369
|
-
security: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>;
|
|
370
|
-
/**
|
|
371
|
-
* The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the
|
|
372
|
-
* HTTP 1.1 specification [RFC7231] has explicitly defined semantics for request bodies. In other cases where the
|
|
373
|
-
* HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined
|
|
374
|
-
* semantics and SHOULD be avoided if possible.
|
|
375
|
-
*/
|
|
376
143
|
requestBody: z.ZodOptional<z.ZodAny>;
|
|
377
|
-
/**
|
|
378
|
-
* Request parameters
|
|
379
|
-
*/
|
|
380
144
|
parameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
381
|
-
in: z.ZodEnum<
|
|
145
|
+
in: z.ZodEnum<{
|
|
146
|
+
cookie: "cookie";
|
|
147
|
+
path: "path";
|
|
148
|
+
query: "query";
|
|
149
|
+
header: "header";
|
|
150
|
+
}>;
|
|
382
151
|
name: z.ZodString;
|
|
383
152
|
description: z.ZodOptional<z.ZodString>;
|
|
384
153
|
required: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
385
154
|
deprecated: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
|
|
386
155
|
schema: z.ZodOptional<z.ZodUnknown>;
|
|
387
156
|
content: z.ZodOptional<z.ZodUnknown>;
|
|
388
|
-
style: z.ZodOptional<z.ZodEnum<
|
|
157
|
+
style: z.ZodOptional<z.ZodEnum<{
|
|
158
|
+
matrix: "matrix";
|
|
159
|
+
simple: "simple";
|
|
160
|
+
form: "form";
|
|
161
|
+
label: "label";
|
|
162
|
+
spaceDelimited: "spaceDelimited";
|
|
163
|
+
pipeDelimited: "pipeDelimited";
|
|
164
|
+
deepObject: "deepObject";
|
|
165
|
+
}>>;
|
|
389
166
|
explode: z.ZodOptional<z.ZodBoolean>;
|
|
390
167
|
example: z.ZodOptional<z.ZodUnknown>;
|
|
391
|
-
examples: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
168
|
+
examples: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
392
169
|
value: z.ZodOptional<z.ZodUnknown>;
|
|
393
170
|
summary: z.ZodOptional<z.ZodString>;
|
|
394
171
|
externalValue: z.ZodOptional<z.ZodString>;
|
|
395
|
-
},
|
|
396
|
-
|
|
397
|
-
summary?: string | undefined;
|
|
398
|
-
externalValue?: string | undefined;
|
|
399
|
-
}, {
|
|
400
|
-
value?: unknown;
|
|
401
|
-
summary?: string | undefined;
|
|
402
|
-
externalValue?: string | undefined;
|
|
403
|
-
}>>, z.ZodArray<z.ZodUnknown, "many">]>>;
|
|
404
|
-
}, "strip", z.ZodTypeAny, {
|
|
405
|
-
name: string;
|
|
406
|
-
required: boolean;
|
|
407
|
-
deprecated: boolean;
|
|
408
|
-
in: "cookie" | "path" | "query" | "header";
|
|
409
|
-
description?: string | undefined;
|
|
410
|
-
example?: unknown;
|
|
411
|
-
content?: unknown;
|
|
412
|
-
schema?: unknown;
|
|
413
|
-
examples?: unknown[] | Record<string, {
|
|
414
|
-
value?: unknown;
|
|
415
|
-
summary?: string | undefined;
|
|
416
|
-
externalValue?: string | undefined;
|
|
417
|
-
}> | undefined;
|
|
418
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
419
|
-
explode?: boolean | undefined;
|
|
420
|
-
}, {
|
|
421
|
-
name: string;
|
|
422
|
-
in: "cookie" | "path" | "query" | "header";
|
|
423
|
-
description?: string | undefined;
|
|
424
|
-
required?: boolean | undefined;
|
|
425
|
-
example?: unknown;
|
|
426
|
-
content?: unknown;
|
|
427
|
-
schema?: unknown;
|
|
428
|
-
examples?: unknown[] | Record<string, {
|
|
429
|
-
value?: unknown;
|
|
430
|
-
summary?: string | undefined;
|
|
431
|
-
externalValue?: string | undefined;
|
|
432
|
-
}> | undefined;
|
|
433
|
-
deprecated?: boolean | undefined;
|
|
434
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
435
|
-
explode?: boolean | undefined;
|
|
436
|
-
}>, "many">>;
|
|
437
|
-
/**
|
|
438
|
-
* External documentation object
|
|
439
|
-
*/
|
|
440
|
-
externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
441
|
-
description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
442
|
-
url: z.ZodString;
|
|
443
|
-
}, "strip", z.ZodTypeAny, {
|
|
444
|
-
url: string;
|
|
445
|
-
description?: string | undefined;
|
|
446
|
-
}, {
|
|
447
|
-
url: string;
|
|
448
|
-
description?: unknown;
|
|
449
|
-
}>, {
|
|
450
|
-
url: string;
|
|
451
|
-
description?: string | undefined;
|
|
452
|
-
}, {
|
|
453
|
-
url: string;
|
|
454
|
-
description?: unknown;
|
|
455
|
-
}>>;
|
|
456
|
-
deprecated: z.ZodOptional<z.ZodBoolean>;
|
|
457
|
-
/** Response formats */
|
|
172
|
+
}, z.core.$strip>>, z.ZodArray<z.ZodUnknown>]>>;
|
|
173
|
+
}, z.core.$strip>>>;
|
|
458
174
|
responses: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
459
|
-
/** Callbacks */
|
|
460
175
|
callbacks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>>;
|
|
461
|
-
/** xScalar examples */
|
|
462
|
-
'x-scalar-examples': z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
463
|
-
name: z.ZodOptional<z.ZodString>;
|
|
464
|
-
body: z.ZodOptional<z.ZodObject<{
|
|
465
|
-
encoding: z.ZodEnum<["application/json", "text/plain", "text/html", "application/javascript", "application/xml", "application/yaml", "application/edn", "application/octet-stream", "application/x-www-form-urlencoded", "multipart/form-data", "binary"]>;
|
|
466
|
-
content: z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodString]>;
|
|
467
|
-
file: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
468
|
-
url: z.ZodString;
|
|
469
|
-
base64: z.ZodOptional<z.ZodString>;
|
|
470
|
-
}, "strip", z.ZodTypeAny, {
|
|
471
|
-
url: string;
|
|
472
|
-
base64?: string | undefined;
|
|
473
|
-
}, {
|
|
474
|
-
url: string;
|
|
475
|
-
base64?: string | undefined;
|
|
476
|
-
}>>>;
|
|
477
|
-
}, "strip", z.ZodTypeAny, {
|
|
478
|
-
content: string | Record<string, any>;
|
|
479
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
480
|
-
file?: {
|
|
481
|
-
url: string;
|
|
482
|
-
base64?: string | undefined;
|
|
483
|
-
} | null | undefined;
|
|
484
|
-
}, {
|
|
485
|
-
content: string | Record<string, any>;
|
|
486
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
487
|
-
file?: {
|
|
488
|
-
url: string;
|
|
489
|
-
base64?: string | undefined;
|
|
490
|
-
} | null | undefined;
|
|
491
|
-
}>>;
|
|
492
|
-
parameters: z.ZodObject<{
|
|
493
|
-
path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
494
|
-
query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
495
|
-
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
496
|
-
cookies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
497
|
-
}, "strip", z.ZodTypeAny, {
|
|
498
|
-
path?: Record<string, string> | undefined;
|
|
499
|
-
headers?: Record<string, string> | undefined;
|
|
500
|
-
query?: Record<string, string> | undefined;
|
|
501
|
-
cookies?: Record<string, string> | undefined;
|
|
502
|
-
}, {
|
|
503
|
-
path?: Record<string, string> | undefined;
|
|
504
|
-
headers?: Record<string, string> | undefined;
|
|
505
|
-
query?: Record<string, string> | undefined;
|
|
506
|
-
cookies?: Record<string, string> | undefined;
|
|
507
|
-
}>;
|
|
508
|
-
}, "strip", z.ZodTypeAny, {
|
|
509
|
-
parameters: {
|
|
510
|
-
path?: Record<string, string> | undefined;
|
|
511
|
-
headers?: Record<string, string> | undefined;
|
|
512
|
-
query?: Record<string, string> | undefined;
|
|
513
|
-
cookies?: Record<string, string> | undefined;
|
|
514
|
-
};
|
|
515
|
-
name?: string | undefined;
|
|
516
|
-
body?: {
|
|
517
|
-
content: string | Record<string, any>;
|
|
518
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
519
|
-
file?: {
|
|
520
|
-
url: string;
|
|
521
|
-
base64?: string | undefined;
|
|
522
|
-
} | null | undefined;
|
|
523
|
-
} | undefined;
|
|
524
|
-
}, {
|
|
525
|
-
parameters: {
|
|
526
|
-
path?: Record<string, string> | undefined;
|
|
527
|
-
headers?: Record<string, string> | undefined;
|
|
528
|
-
query?: Record<string, string> | undefined;
|
|
529
|
-
cookies?: Record<string, string> | undefined;
|
|
530
|
-
};
|
|
531
|
-
name?: string | undefined;
|
|
532
|
-
body?: {
|
|
533
|
-
content: string | Record<string, any>;
|
|
534
|
-
encoding: "binary" | "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data";
|
|
535
|
-
file?: {
|
|
536
|
-
url: string;
|
|
537
|
-
base64?: string | undefined;
|
|
538
|
-
} | null | undefined;
|
|
539
|
-
} | undefined;
|
|
540
|
-
}>>>;
|
|
541
|
-
/** Hide operations */
|
|
542
|
-
'x-internal': z.ZodOptional<z.ZodBoolean>;
|
|
543
|
-
/** Ignore operations */
|
|
544
|
-
'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
|
|
545
|
-
}, "x-scalar-examples">, {
|
|
546
176
|
'x-codeSamples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
547
177
|
lang: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
548
178
|
label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
549
179
|
source: z.ZodString;
|
|
550
|
-
},
|
|
551
|
-
source: string;
|
|
552
|
-
label?: string | undefined;
|
|
553
|
-
lang?: string | undefined;
|
|
554
|
-
}, {
|
|
555
|
-
source: string;
|
|
556
|
-
label?: unknown;
|
|
557
|
-
lang?: unknown;
|
|
558
|
-
}>, "many">>>;
|
|
180
|
+
}, z.core.$strip>>>>;
|
|
559
181
|
'x-code-samples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
560
182
|
lang: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
561
183
|
label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
562
184
|
source: z.ZodString;
|
|
563
|
-
},
|
|
564
|
-
source: string;
|
|
565
|
-
label?: string | undefined;
|
|
566
|
-
lang?: string | undefined;
|
|
567
|
-
}, {
|
|
568
|
-
source: string;
|
|
569
|
-
label?: unknown;
|
|
570
|
-
lang?: unknown;
|
|
571
|
-
}>, "many">>>;
|
|
185
|
+
}, z.core.$strip>>>>;
|
|
572
186
|
'x-custom-examples': z.ZodCatch<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
573
187
|
lang: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
574
188
|
label: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
575
189
|
source: z.ZodString;
|
|
576
|
-
},
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
label?: unknown;
|
|
583
|
-
lang?: unknown;
|
|
584
|
-
}>, "many">>>;
|
|
585
|
-
}>, {
|
|
586
|
-
'x-scalar-stability': z.ZodCatch<z.ZodOptional<z.ZodEnum<[XScalarStability.Deprecated, XScalarStability.Experimental, XScalarStability.Stable]>>>;
|
|
587
|
-
}>, {
|
|
190
|
+
}, z.core.$strip>>>>;
|
|
191
|
+
'x-scalar-stability': z.ZodCatch<z.ZodOptional<z.ZodEnum<{
|
|
192
|
+
deprecated: XScalarStability.Deprecated;
|
|
193
|
+
experimental: XScalarStability.Experimental;
|
|
194
|
+
stable: XScalarStability.Stable;
|
|
195
|
+
}>>>;
|
|
588
196
|
type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"request">>>;
|
|
589
|
-
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "operation">;
|
|
590
|
-
/** Path Key */
|
|
197
|
+
uid: z.core.$ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "operation">;
|
|
591
198
|
path: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
}
|
|
199
|
+
method: z.ZodDefault<z.ZodEnum<{
|
|
200
|
+
connect: "connect";
|
|
201
|
+
delete: "delete";
|
|
202
|
+
get: "get";
|
|
203
|
+
head: "head";
|
|
204
|
+
options: "options";
|
|
205
|
+
patch: "patch";
|
|
206
|
+
post: "post";
|
|
207
|
+
put: "put";
|
|
208
|
+
trace: "trace";
|
|
209
|
+
}>>;
|
|
210
|
+
servers: z.ZodDefault<z.ZodArray<z.core.$ZodBranded<z.ZodString, "server">>>;
|
|
211
|
+
selectedServerUid: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.core.$ZodBranded<z.ZodString, "server">>>>;
|
|
212
|
+
examples: z.ZodDefault<z.ZodArray<z.core.$ZodBranded<z.ZodString, "example">>>;
|
|
213
|
+
selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.core.$ZodBranded<z.ZodString, "securityScheme">, z.ZodArray<z.core.$ZodBranded<z.ZodString, "securityScheme">>]>>>;
|
|
603
214
|
'x-post-response': z.ZodOptional<z.ZodString>;
|
|
604
|
-
}
|
|
605
|
-
uid: string & z.BRAND<"operation">;
|
|
606
|
-
path: string;
|
|
607
|
-
type: "request";
|
|
608
|
-
selectedSecuritySchemeUids: ((string & z.BRAND<"securityScheme">) | (string & z.BRAND<"securityScheme">)[])[];
|
|
609
|
-
selectedServerUid: (string & z.BRAND<"server">) | null;
|
|
610
|
-
servers: (string & z.BRAND<"server">)[];
|
|
611
|
-
examples: (string & z.BRAND<"example">)[];
|
|
612
|
-
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
613
|
-
description?: string | undefined;
|
|
614
|
-
summary?: string | undefined;
|
|
615
|
-
externalDocs?: {
|
|
616
|
-
url: string;
|
|
617
|
-
description?: string | undefined;
|
|
618
|
-
} | undefined;
|
|
619
|
-
'x-internal'?: boolean | undefined;
|
|
620
|
-
'x-scalar-ignore'?: boolean | undefined;
|
|
621
|
-
security?: Record<string, string[]>[] | undefined;
|
|
622
|
-
tags?: string[] | undefined;
|
|
623
|
-
deprecated?: boolean | undefined;
|
|
624
|
-
operationId?: string | undefined;
|
|
625
|
-
requestBody?: any;
|
|
626
|
-
parameters?: {
|
|
627
|
-
name: string;
|
|
628
|
-
required: boolean;
|
|
629
|
-
deprecated: boolean;
|
|
630
|
-
in: "cookie" | "path" | "query" | "header";
|
|
631
|
-
description?: string | undefined;
|
|
632
|
-
example?: unknown;
|
|
633
|
-
content?: unknown;
|
|
634
|
-
schema?: unknown;
|
|
635
|
-
examples?: unknown[] | Record<string, {
|
|
636
|
-
value?: unknown;
|
|
637
|
-
summary?: string | undefined;
|
|
638
|
-
externalValue?: string | undefined;
|
|
639
|
-
}> | undefined;
|
|
640
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
641
|
-
explode?: boolean | undefined;
|
|
642
|
-
}[] | undefined;
|
|
643
|
-
responses?: Record<string, any> | undefined;
|
|
644
|
-
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
645
|
-
'x-codeSamples'?: {
|
|
646
|
-
source: string;
|
|
647
|
-
label?: string | undefined;
|
|
648
|
-
lang?: string | undefined;
|
|
649
|
-
}[] | undefined;
|
|
650
|
-
'x-code-samples'?: {
|
|
651
|
-
source: string;
|
|
652
|
-
label?: string | undefined;
|
|
653
|
-
lang?: string | undefined;
|
|
654
|
-
}[] | undefined;
|
|
655
|
-
'x-custom-examples'?: {
|
|
656
|
-
source: string;
|
|
657
|
-
label?: string | undefined;
|
|
658
|
-
lang?: string | undefined;
|
|
659
|
-
}[] | undefined;
|
|
660
|
-
'x-scalar-stability'?: XScalarStability | undefined;
|
|
661
|
-
'x-post-response'?: string | undefined;
|
|
662
|
-
}, {
|
|
663
|
-
uid?: string | undefined;
|
|
664
|
-
path?: string | undefined;
|
|
665
|
-
type?: "request" | undefined;
|
|
666
|
-
description?: string | undefined;
|
|
667
|
-
summary?: string | undefined;
|
|
668
|
-
externalDocs?: {
|
|
669
|
-
url: string;
|
|
670
|
-
description?: unknown;
|
|
671
|
-
} | undefined;
|
|
672
|
-
'x-internal'?: boolean | undefined;
|
|
673
|
-
'x-scalar-ignore'?: boolean | undefined;
|
|
674
|
-
security?: Record<string, string[] | undefined>[] | undefined;
|
|
675
|
-
selectedSecuritySchemeUids?: (string | string[])[] | undefined;
|
|
676
|
-
selectedServerUid?: string | null | undefined;
|
|
677
|
-
servers?: string[] | undefined;
|
|
678
|
-
tags?: string[] | undefined;
|
|
679
|
-
examples?: string[] | undefined;
|
|
680
|
-
deprecated?: boolean | undefined;
|
|
681
|
-
operationId?: string | undefined;
|
|
682
|
-
requestBody?: any;
|
|
683
|
-
parameters?: {
|
|
684
|
-
name: string;
|
|
685
|
-
in: "cookie" | "path" | "query" | "header";
|
|
686
|
-
description?: string | undefined;
|
|
687
|
-
required?: boolean | undefined;
|
|
688
|
-
example?: unknown;
|
|
689
|
-
content?: unknown;
|
|
690
|
-
schema?: unknown;
|
|
691
|
-
examples?: unknown[] | Record<string, {
|
|
692
|
-
value?: unknown;
|
|
693
|
-
summary?: string | undefined;
|
|
694
|
-
externalValue?: string | undefined;
|
|
695
|
-
}> | undefined;
|
|
696
|
-
deprecated?: boolean | undefined;
|
|
697
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
698
|
-
explode?: boolean | undefined;
|
|
699
|
-
}[] | undefined;
|
|
700
|
-
responses?: Record<string, any> | undefined;
|
|
701
|
-
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
702
|
-
'x-codeSamples'?: unknown;
|
|
703
|
-
'x-code-samples'?: unknown;
|
|
704
|
-
'x-custom-examples'?: unknown;
|
|
705
|
-
'x-scalar-stability'?: unknown;
|
|
706
|
-
method?: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace" | undefined;
|
|
707
|
-
'x-post-response'?: string | undefined;
|
|
708
|
-
}>;
|
|
215
|
+
}, z.core.$strip>;
|
|
709
216
|
export type Request = z.infer<typeof requestSchema>;
|
|
710
217
|
export type RequestPayload = z.input<typeof requestSchema>;
|
|
711
218
|
//# sourceMappingURL=requests.d.ts.map
|