@scalar/api-client 2.6.0 → 2.7.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 +55 -0
- package/dist/analytics.d.ts +2 -18
- package/dist/analytics.d.ts.map +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +66 -42
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/HttpMethod/HttpMethod.vue.d.ts +2 -2
- package/dist/hooks/useAnalytics.d.ts +2 -18
- package/dist/hooks/useAnalytics.d.ts.map +1 -1
- package/dist/hooks/useClientConfig.d.ts +115 -112
- package/dist/hooks/useClientConfig.d.ts.map +1 -1
- package/dist/layouts/App/create-api-client-app.d.ts +1378 -1306
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +2752 -2608
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +1378 -1306
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +1378 -1306
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/find-request.d.ts +17 -17
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/hot-keys.d.ts +1 -1
- package/dist/libs/local-storage.d.ts.map +1 -1
- package/dist/libs/send-request/build-request-security.d.ts +1 -1
- package/dist/libs/send-request/create-fetch-body.d.ts +1 -1
- package/dist/libs/send-request/create-request-operation.test.d.ts +82 -82
- package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
- package/dist/plugins/plugin-manager.d.ts +1 -1
- package/dist/store/active-entities.d.ts +118 -118
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +127 -127
- package/dist/store/collections.d.ts.map +1 -1
- package/dist/store/cookies.d.ts +14 -14
- package/dist/store/environment.d.ts +23 -23
- package/dist/store/request-example.d.ts +546 -546
- package/dist/store/request-example.d.ts.map +1 -1
- package/dist/store/requests.d.ts +194 -194
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/security-schemes.d.ts +281 -281
- package/dist/store/security-schemes.d.ts.map +1 -1
- package/dist/store/servers.d.ts +45 -45
- package/dist/store/servers.d.ts.map +1 -1
- package/dist/store/store.d.ts +1378 -1306
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/store.js +18 -18
- package/dist/store/tags.d.ts +35 -35
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/store/workspace.d.ts +47 -47
- package/dist/store/workspace.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.test.d.ts +2 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.test.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.d.ts +25 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.js +30 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue2.js +4 -0
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.js +3 -3
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue2.js +102 -95
- package/dist/v2/blocks/operation-code-sample/helpers/find-client.js +16 -14
- package/dist/v2/blocks/operation-code-sample/helpers/generate-client-options.js +31 -2
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.d.ts +6 -1
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.js +198 -131
- package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.bench.d.ts +2 -0
- package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.bench.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/index.d.ts +4 -1
- package/dist/v2/blocks/operation-code-sample/index.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/index.js +10 -4
- package/dist/v2/blocks/scalar-auth-selector-block/helpers/security-scheme.d.ts +2 -6
- package/dist/v2/blocks/scalar-auth-selector-block/helpers/security-scheme.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts +54 -54
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts +54 -54
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/RequestHeaders.vue.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseHeaders.vue.js +1 -1
- package/dist/views/Request/libs/auth.d.ts +2 -2
- package/dist/views/Request/libs/watch-mode.d.ts +4 -4
- package/dist/views/Request/libs/watch-mode.d.ts.map +1 -1
- package/dist/views/Request/libs/watch-mode.js +241 -186
- package/package.json +25 -20
package/dist/store/requests.d.ts
CHANGED
|
@@ -4,14 +4,14 @@ import type { StoreContext } from './store-context';
|
|
|
4
4
|
/** Create top level request handlers for a workspace */
|
|
5
5
|
export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
6
6
|
requests: Record<string, {
|
|
7
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
8
|
-
path: string;
|
|
9
7
|
type: "request";
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
uid: string & import("zod").$brand<"operation">;
|
|
9
|
+
path: string;
|
|
10
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
11
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
12
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
13
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
14
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
15
15
|
description?: string | undefined;
|
|
16
16
|
summary?: string | undefined;
|
|
17
17
|
externalDocs?: {
|
|
@@ -26,52 +26,52 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
26
26
|
operationId?: string | undefined;
|
|
27
27
|
requestBody?: any;
|
|
28
28
|
parameters?: {
|
|
29
|
+
in: "path" | "cookie" | "query" | "header";
|
|
29
30
|
name: string;
|
|
30
31
|
required: boolean;
|
|
31
32
|
deprecated: boolean;
|
|
32
|
-
in: "cookie" | "path" | "query" | "header";
|
|
33
33
|
description?: string | undefined;
|
|
34
|
-
example?: unknown;
|
|
35
|
-
content?: unknown;
|
|
36
34
|
schema?: unknown;
|
|
37
|
-
|
|
35
|
+
content?: unknown;
|
|
36
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
37
|
+
explode?: boolean | undefined;
|
|
38
|
+
example?: unknown;
|
|
39
|
+
examples?: Record<string, {
|
|
38
40
|
value?: unknown;
|
|
39
41
|
summary?: string | undefined;
|
|
40
42
|
externalValue?: string | undefined;
|
|
41
|
-
}> | undefined;
|
|
42
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
43
|
-
explode?: boolean | undefined;
|
|
43
|
+
}> | unknown[] | undefined;
|
|
44
44
|
}[] | undefined;
|
|
45
45
|
responses?: Record<string, any> | undefined;
|
|
46
46
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
47
47
|
'x-codeSamples'?: {
|
|
48
48
|
source: string;
|
|
49
|
-
label?: string | undefined;
|
|
50
49
|
lang?: string | undefined;
|
|
50
|
+
label?: string | undefined;
|
|
51
51
|
}[] | undefined;
|
|
52
52
|
'x-code-samples'?: {
|
|
53
53
|
source: string;
|
|
54
|
-
label?: string | undefined;
|
|
55
54
|
lang?: string | undefined;
|
|
55
|
+
label?: string | undefined;
|
|
56
56
|
}[] | undefined;
|
|
57
57
|
'x-custom-examples'?: {
|
|
58
58
|
source: string;
|
|
59
|
-
label?: string | undefined;
|
|
60
59
|
lang?: string | undefined;
|
|
60
|
+
label?: string | undefined;
|
|
61
61
|
}[] | undefined;
|
|
62
62
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
63
63
|
'x-post-response'?: string | undefined;
|
|
64
64
|
}>;
|
|
65
65
|
requestMutators: {
|
|
66
66
|
add: (item: {
|
|
67
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
68
|
-
path: string;
|
|
69
67
|
type: "request";
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
68
|
+
uid: string & import("zod").$brand<"operation">;
|
|
69
|
+
path: string;
|
|
70
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
71
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
72
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
73
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
74
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
75
75
|
description?: string | undefined;
|
|
76
76
|
summary?: string | undefined;
|
|
77
77
|
externalDocs?: {
|
|
@@ -86,52 +86,52 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
86
86
|
operationId?: string | undefined;
|
|
87
87
|
requestBody?: any;
|
|
88
88
|
parameters?: {
|
|
89
|
+
in: "path" | "cookie" | "query" | "header";
|
|
89
90
|
name: string;
|
|
90
91
|
required: boolean;
|
|
91
92
|
deprecated: boolean;
|
|
92
|
-
in: "cookie" | "path" | "query" | "header";
|
|
93
93
|
description?: string | undefined;
|
|
94
|
-
example?: unknown;
|
|
95
|
-
content?: unknown;
|
|
96
94
|
schema?: unknown;
|
|
97
|
-
|
|
95
|
+
content?: unknown;
|
|
96
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
97
|
+
explode?: boolean | undefined;
|
|
98
|
+
example?: unknown;
|
|
99
|
+
examples?: Record<string, {
|
|
98
100
|
value?: unknown;
|
|
99
101
|
summary?: string | undefined;
|
|
100
102
|
externalValue?: string | undefined;
|
|
101
|
-
}> | undefined;
|
|
102
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
103
|
-
explode?: boolean | undefined;
|
|
103
|
+
}> | unknown[] | undefined;
|
|
104
104
|
}[] | undefined;
|
|
105
105
|
responses?: Record<string, any> | undefined;
|
|
106
106
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
107
107
|
'x-codeSamples'?: {
|
|
108
108
|
source: string;
|
|
109
|
-
label?: string | undefined;
|
|
110
109
|
lang?: string | undefined;
|
|
110
|
+
label?: string | undefined;
|
|
111
111
|
}[] | undefined;
|
|
112
112
|
'x-code-samples'?: {
|
|
113
113
|
source: string;
|
|
114
|
-
label?: string | undefined;
|
|
115
114
|
lang?: string | undefined;
|
|
115
|
+
label?: string | undefined;
|
|
116
116
|
}[] | undefined;
|
|
117
117
|
'x-custom-examples'?: {
|
|
118
118
|
source: string;
|
|
119
|
-
label?: string | undefined;
|
|
120
119
|
lang?: string | undefined;
|
|
120
|
+
label?: string | undefined;
|
|
121
121
|
}[] | undefined;
|
|
122
122
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
123
123
|
'x-post-response'?: string | undefined;
|
|
124
124
|
}) => void;
|
|
125
|
-
delete: (uid: (string & import("zod")
|
|
125
|
+
delete: (uid: (string & import("zod").$brand<"operation">) | null | undefined) => void;
|
|
126
126
|
set: (item: {
|
|
127
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
128
|
-
path: string;
|
|
129
127
|
type: "request";
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
128
|
+
uid: string & import("zod").$brand<"operation">;
|
|
129
|
+
path: string;
|
|
130
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
131
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
132
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
133
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
134
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
135
135
|
description?: string | undefined;
|
|
136
136
|
summary?: string | undefined;
|
|
137
137
|
externalDocs?: {
|
|
@@ -146,51 +146,51 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
146
146
|
operationId?: string | undefined;
|
|
147
147
|
requestBody?: any;
|
|
148
148
|
parameters?: {
|
|
149
|
+
in: "path" | "cookie" | "query" | "header";
|
|
149
150
|
name: string;
|
|
150
151
|
required: boolean;
|
|
151
152
|
deprecated: boolean;
|
|
152
|
-
in: "cookie" | "path" | "query" | "header";
|
|
153
153
|
description?: string | undefined;
|
|
154
|
-
example?: unknown;
|
|
155
|
-
content?: unknown;
|
|
156
154
|
schema?: unknown;
|
|
157
|
-
|
|
155
|
+
content?: unknown;
|
|
156
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
157
|
+
explode?: boolean | undefined;
|
|
158
|
+
example?: unknown;
|
|
159
|
+
examples?: Record<string, {
|
|
158
160
|
value?: unknown;
|
|
159
161
|
summary?: string | undefined;
|
|
160
162
|
externalValue?: string | undefined;
|
|
161
|
-
}> | undefined;
|
|
162
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
163
|
-
explode?: boolean | undefined;
|
|
163
|
+
}> | unknown[] | undefined;
|
|
164
164
|
}[] | undefined;
|
|
165
165
|
responses?: Record<string, any> | undefined;
|
|
166
166
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
167
167
|
'x-codeSamples'?: {
|
|
168
168
|
source: string;
|
|
169
|
-
label?: string | undefined;
|
|
170
169
|
lang?: string | undefined;
|
|
170
|
+
label?: string | undefined;
|
|
171
171
|
}[] | undefined;
|
|
172
172
|
'x-code-samples'?: {
|
|
173
173
|
source: string;
|
|
174
|
-
label?: string | undefined;
|
|
175
174
|
lang?: string | undefined;
|
|
175
|
+
label?: string | undefined;
|
|
176
176
|
}[] | undefined;
|
|
177
177
|
'x-custom-examples'?: {
|
|
178
178
|
source: string;
|
|
179
|
-
label?: string | undefined;
|
|
180
179
|
lang?: string | undefined;
|
|
180
|
+
label?: string | undefined;
|
|
181
181
|
}[] | undefined;
|
|
182
182
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
183
183
|
'x-post-response'?: string | undefined;
|
|
184
184
|
}) => void;
|
|
185
|
-
edit: <P extends "servers" | "
|
|
186
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
187
|
-
path: string;
|
|
185
|
+
edit: <P extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" | `servers.${number}` | "externalDocs.url" | "externalDocs.description" | `security.${number}` | `security.${number}.${string}` | `tags.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.in` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.name` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.style` | `parameters.${number}.explode` | `parameters.${number}.example` | `parameters.${number}.examples.${string}` | `parameters.${number}.examples.${number}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: (string & import("zod").$brand<"operation">) | null | undefined, path: P, value: P extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
188
186
|
type: "request";
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
187
|
+
uid: string & import("zod").$brand<"operation">;
|
|
188
|
+
path: string;
|
|
189
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
190
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
191
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
192
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
193
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
194
194
|
description?: string | undefined;
|
|
195
195
|
summary?: string | undefined;
|
|
196
196
|
externalDocs?: {
|
|
@@ -205,50 +205,50 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
205
205
|
operationId?: string | undefined;
|
|
206
206
|
requestBody?: any;
|
|
207
207
|
parameters?: {
|
|
208
|
+
in: "path" | "cookie" | "query" | "header";
|
|
208
209
|
name: string;
|
|
209
210
|
required: boolean;
|
|
210
211
|
deprecated: boolean;
|
|
211
|
-
in: "cookie" | "path" | "query" | "header";
|
|
212
212
|
description?: string | undefined;
|
|
213
|
-
example?: unknown;
|
|
214
|
-
content?: unknown;
|
|
215
213
|
schema?: unknown;
|
|
216
|
-
|
|
214
|
+
content?: unknown;
|
|
215
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
216
|
+
explode?: boolean | undefined;
|
|
217
|
+
example?: unknown;
|
|
218
|
+
examples?: Record<string, {
|
|
217
219
|
value?: unknown;
|
|
218
220
|
summary?: string | undefined;
|
|
219
221
|
externalValue?: string | undefined;
|
|
220
|
-
}> | undefined;
|
|
221
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
222
|
-
explode?: boolean | undefined;
|
|
222
|
+
}> | unknown[] | undefined;
|
|
223
223
|
}[] | undefined;
|
|
224
224
|
responses?: Record<string, any> | undefined;
|
|
225
225
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
226
226
|
'x-codeSamples'?: {
|
|
227
227
|
source: string;
|
|
228
|
-
label?: string | undefined;
|
|
229
228
|
lang?: string | undefined;
|
|
229
|
+
label?: string | undefined;
|
|
230
230
|
}[] | undefined;
|
|
231
231
|
'x-code-samples'?: {
|
|
232
232
|
source: string;
|
|
233
|
-
label?: string | undefined;
|
|
234
233
|
lang?: string | undefined;
|
|
234
|
+
label?: string | undefined;
|
|
235
235
|
}[] | undefined;
|
|
236
236
|
'x-custom-examples'?: {
|
|
237
237
|
source: string;
|
|
238
|
-
label?: string | undefined;
|
|
239
238
|
lang?: string | undefined;
|
|
239
|
+
label?: string | undefined;
|
|
240
240
|
}[] | undefined;
|
|
241
241
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
242
242
|
'x-post-response'?: string | undefined;
|
|
243
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "
|
|
244
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
245
|
-
path: string;
|
|
243
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
246
244
|
type: "request";
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
245
|
+
uid: string & import("zod").$brand<"operation">;
|
|
246
|
+
path: string;
|
|
247
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
248
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
249
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
250
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
251
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
252
252
|
description?: string | undefined;
|
|
253
253
|
summary?: string | undefined;
|
|
254
254
|
externalDocs?: {
|
|
@@ -263,50 +263,50 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
263
263
|
operationId?: string | undefined;
|
|
264
264
|
requestBody?: any;
|
|
265
265
|
parameters?: {
|
|
266
|
+
in: "path" | "cookie" | "query" | "header";
|
|
266
267
|
name: string;
|
|
267
268
|
required: boolean;
|
|
268
269
|
deprecated: boolean;
|
|
269
|
-
in: "cookie" | "path" | "query" | "header";
|
|
270
270
|
description?: string | undefined;
|
|
271
|
-
example?: unknown;
|
|
272
|
-
content?: unknown;
|
|
273
271
|
schema?: unknown;
|
|
274
|
-
|
|
272
|
+
content?: unknown;
|
|
273
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
274
|
+
explode?: boolean | undefined;
|
|
275
|
+
example?: unknown;
|
|
276
|
+
examples?: Record<string, {
|
|
275
277
|
value?: unknown;
|
|
276
278
|
summary?: string | undefined;
|
|
277
279
|
externalValue?: string | undefined;
|
|
278
|
-
}> | undefined;
|
|
279
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
280
|
-
explode?: boolean | undefined;
|
|
280
|
+
}> | unknown[] | undefined;
|
|
281
281
|
}[] | undefined;
|
|
282
282
|
responses?: Record<string, any> | undefined;
|
|
283
283
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
284
284
|
'x-codeSamples'?: {
|
|
285
285
|
source: string;
|
|
286
|
-
label?: string | undefined;
|
|
287
286
|
lang?: string | undefined;
|
|
287
|
+
label?: string | undefined;
|
|
288
288
|
}[] | undefined;
|
|
289
289
|
'x-code-samples'?: {
|
|
290
290
|
source: string;
|
|
291
|
-
label?: string | undefined;
|
|
292
291
|
lang?: string | undefined;
|
|
292
|
+
label?: string | undefined;
|
|
293
293
|
}[] | undefined;
|
|
294
294
|
'x-custom-examples'?: {
|
|
295
295
|
source: string;
|
|
296
|
-
label?: string | undefined;
|
|
297
296
|
lang?: string | undefined;
|
|
297
|
+
label?: string | undefined;
|
|
298
298
|
}[] | undefined;
|
|
299
299
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
300
300
|
'x-post-response'?: string | undefined;
|
|
301
301
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
302
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
303
|
-
path: string;
|
|
304
302
|
type: "request";
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
303
|
+
uid: string & import("zod").$brand<"operation">;
|
|
304
|
+
path: string;
|
|
305
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
306
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
307
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
308
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
309
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
310
310
|
description?: string | undefined;
|
|
311
311
|
summary?: string | undefined;
|
|
312
312
|
externalDocs?: {
|
|
@@ -321,51 +321,51 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
321
321
|
operationId?: string | undefined;
|
|
322
322
|
requestBody?: any;
|
|
323
323
|
parameters?: {
|
|
324
|
+
in: "path" | "cookie" | "query" | "header";
|
|
324
325
|
name: string;
|
|
325
326
|
required: boolean;
|
|
326
327
|
deprecated: boolean;
|
|
327
|
-
in: "cookie" | "path" | "query" | "header";
|
|
328
328
|
description?: string | undefined;
|
|
329
|
-
example?: unknown;
|
|
330
|
-
content?: unknown;
|
|
331
329
|
schema?: unknown;
|
|
332
|
-
|
|
330
|
+
content?: unknown;
|
|
331
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
332
|
+
explode?: boolean | undefined;
|
|
333
|
+
example?: unknown;
|
|
334
|
+
examples?: Record<string, {
|
|
333
335
|
value?: unknown;
|
|
334
336
|
summary?: string | undefined;
|
|
335
337
|
externalValue?: string | undefined;
|
|
336
|
-
}> | undefined;
|
|
337
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
338
|
-
explode?: boolean | undefined;
|
|
338
|
+
}> | unknown[] | undefined;
|
|
339
339
|
}[] | undefined;
|
|
340
340
|
responses?: Record<string, any> | undefined;
|
|
341
341
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
342
342
|
'x-codeSamples'?: {
|
|
343
343
|
source: string;
|
|
344
|
-
label?: string | undefined;
|
|
345
344
|
lang?: string | undefined;
|
|
345
|
+
label?: string | undefined;
|
|
346
346
|
}[] | undefined;
|
|
347
347
|
'x-code-samples'?: {
|
|
348
348
|
source: string;
|
|
349
|
-
label?: string | undefined;
|
|
350
349
|
lang?: string | undefined;
|
|
350
|
+
label?: string | undefined;
|
|
351
351
|
}[] | undefined;
|
|
352
352
|
'x-custom-examples'?: {
|
|
353
353
|
source: string;
|
|
354
|
-
label?: string | undefined;
|
|
355
354
|
lang?: string | undefined;
|
|
355
|
+
label?: string | undefined;
|
|
356
356
|
}[] | undefined;
|
|
357
357
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
358
358
|
'x-post-response'?: string | undefined;
|
|
359
359
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
360
|
-
untrackedEdit: <P extends "servers" | "
|
|
361
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
362
|
-
path: string;
|
|
360
|
+
untrackedEdit: <P extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" | `servers.${number}` | "externalDocs.url" | "externalDocs.description" | `security.${number}` | `security.${number}.${string}` | `tags.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.content` | `parameters.${number}.in` | `parameters.${number}.deprecated` | `parameters.${number}.examples` | `parameters.${number}.name` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.style` | `parameters.${number}.explode` | `parameters.${number}.example` | `parameters.${number}.examples.${string}` | `parameters.${number}.examples.${number}` | `responses.${string}` | `callbacks.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.lang` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.label` | `x-code-samples.${number}` | `x-code-samples.${number}.lang` | `x-code-samples.${number}.source` | `x-code-samples.${number}.label` | `x-custom-examples.${number}` | `x-custom-examples.${number}.lang` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.label`>(uid: string & import("zod").$brand<"operation">, path: P, value: P extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? {
|
|
363
361
|
type: "request";
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
362
|
+
uid: string & import("zod").$brand<"operation">;
|
|
363
|
+
path: string;
|
|
364
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
365
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
366
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
367
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
368
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
369
369
|
description?: string | undefined;
|
|
370
370
|
summary?: string | undefined;
|
|
371
371
|
externalDocs?: {
|
|
@@ -380,50 +380,50 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
380
380
|
operationId?: string | undefined;
|
|
381
381
|
requestBody?: any;
|
|
382
382
|
parameters?: {
|
|
383
|
+
in: "path" | "cookie" | "query" | "header";
|
|
383
384
|
name: string;
|
|
384
385
|
required: boolean;
|
|
385
386
|
deprecated: boolean;
|
|
386
|
-
in: "cookie" | "path" | "query" | "header";
|
|
387
387
|
description?: string | undefined;
|
|
388
|
-
example?: unknown;
|
|
389
|
-
content?: unknown;
|
|
390
388
|
schema?: unknown;
|
|
391
|
-
|
|
389
|
+
content?: unknown;
|
|
390
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
391
|
+
explode?: boolean | undefined;
|
|
392
|
+
example?: unknown;
|
|
393
|
+
examples?: Record<string, {
|
|
392
394
|
value?: unknown;
|
|
393
395
|
summary?: string | undefined;
|
|
394
396
|
externalValue?: string | undefined;
|
|
395
|
-
}> | undefined;
|
|
396
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
397
|
-
explode?: boolean | undefined;
|
|
397
|
+
}> | unknown[] | undefined;
|
|
398
398
|
}[] | undefined;
|
|
399
399
|
responses?: Record<string, any> | undefined;
|
|
400
400
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
401
401
|
'x-codeSamples'?: {
|
|
402
402
|
source: string;
|
|
403
|
-
label?: string | undefined;
|
|
404
403
|
lang?: string | undefined;
|
|
404
|
+
label?: string | undefined;
|
|
405
405
|
}[] | undefined;
|
|
406
406
|
'x-code-samples'?: {
|
|
407
407
|
source: string;
|
|
408
|
-
label?: string | undefined;
|
|
409
408
|
lang?: string | undefined;
|
|
409
|
+
label?: string | undefined;
|
|
410
410
|
}[] | undefined;
|
|
411
411
|
'x-custom-examples'?: {
|
|
412
412
|
source: string;
|
|
413
|
-
label?: string | undefined;
|
|
414
413
|
lang?: string | undefined;
|
|
414
|
+
label?: string | undefined;
|
|
415
415
|
}[] | undefined;
|
|
416
416
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
417
417
|
'x-post-response'?: string | undefined;
|
|
418
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "
|
|
419
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
420
|
-
path: string;
|
|
418
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "summary" | "path" | "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "security" | "tags" | "deprecated" | "operationId" | "requestBody" | "parameters" | "responses" | "callbacks" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "type" | "uid" | "method" | "selectedServerUid" | "examples" | "selectedSecuritySchemeUids" | "x-post-response" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
421
419
|
type: "request";
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
420
|
+
uid: string & import("zod").$brand<"operation">;
|
|
421
|
+
path: string;
|
|
422
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
423
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
424
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
425
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
426
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
427
427
|
description?: string | undefined;
|
|
428
428
|
summary?: string | undefined;
|
|
429
429
|
externalDocs?: {
|
|
@@ -438,50 +438,50 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
438
438
|
operationId?: string | undefined;
|
|
439
439
|
requestBody?: any;
|
|
440
440
|
parameters?: {
|
|
441
|
+
in: "path" | "cookie" | "query" | "header";
|
|
441
442
|
name: string;
|
|
442
443
|
required: boolean;
|
|
443
444
|
deprecated: boolean;
|
|
444
|
-
in: "cookie" | "path" | "query" | "header";
|
|
445
445
|
description?: string | undefined;
|
|
446
|
-
example?: unknown;
|
|
447
|
-
content?: unknown;
|
|
448
446
|
schema?: unknown;
|
|
449
|
-
|
|
447
|
+
content?: unknown;
|
|
448
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
449
|
+
explode?: boolean | undefined;
|
|
450
|
+
example?: unknown;
|
|
451
|
+
examples?: Record<string, {
|
|
450
452
|
value?: unknown;
|
|
451
453
|
summary?: string | undefined;
|
|
452
454
|
externalValue?: string | undefined;
|
|
453
|
-
}> | undefined;
|
|
454
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
455
|
-
explode?: boolean | undefined;
|
|
455
|
+
}> | unknown[] | undefined;
|
|
456
456
|
}[] | undefined;
|
|
457
457
|
responses?: Record<string, any> | undefined;
|
|
458
458
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
459
459
|
'x-codeSamples'?: {
|
|
460
460
|
source: string;
|
|
461
|
-
label?: string | undefined;
|
|
462
461
|
lang?: string | undefined;
|
|
462
|
+
label?: string | undefined;
|
|
463
463
|
}[] | undefined;
|
|
464
464
|
'x-code-samples'?: {
|
|
465
465
|
source: string;
|
|
466
|
-
label?: string | undefined;
|
|
467
466
|
lang?: string | undefined;
|
|
467
|
+
label?: string | undefined;
|
|
468
468
|
}[] | undefined;
|
|
469
469
|
'x-custom-examples'?: {
|
|
470
470
|
source: string;
|
|
471
|
-
label?: string | undefined;
|
|
472
471
|
lang?: string | undefined;
|
|
472
|
+
label?: string | undefined;
|
|
473
473
|
}[] | undefined;
|
|
474
474
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
475
475
|
'x-post-response'?: string | undefined;
|
|
476
476
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
477
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
478
|
-
path: string;
|
|
479
477
|
type: "request";
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
478
|
+
uid: string & import("zod").$brand<"operation">;
|
|
479
|
+
path: string;
|
|
480
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
481
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
482
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
483
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
484
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
485
485
|
description?: string | undefined;
|
|
486
486
|
summary?: string | undefined;
|
|
487
487
|
externalDocs?: {
|
|
@@ -496,44 +496,44 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
|
|
|
496
496
|
operationId?: string | undefined;
|
|
497
497
|
requestBody?: any;
|
|
498
498
|
parameters?: {
|
|
499
|
+
in: "path" | "cookie" | "query" | "header";
|
|
499
500
|
name: string;
|
|
500
501
|
required: boolean;
|
|
501
502
|
deprecated: boolean;
|
|
502
|
-
in: "cookie" | "path" | "query" | "header";
|
|
503
503
|
description?: string | undefined;
|
|
504
|
-
example?: unknown;
|
|
505
|
-
content?: unknown;
|
|
506
504
|
schema?: unknown;
|
|
507
|
-
|
|
505
|
+
content?: unknown;
|
|
506
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
507
|
+
explode?: boolean | undefined;
|
|
508
|
+
example?: unknown;
|
|
509
|
+
examples?: Record<string, {
|
|
508
510
|
value?: unknown;
|
|
509
511
|
summary?: string | undefined;
|
|
510
512
|
externalValue?: string | undefined;
|
|
511
|
-
}> | undefined;
|
|
512
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
513
|
-
explode?: boolean | undefined;
|
|
513
|
+
}> | unknown[] | undefined;
|
|
514
514
|
}[] | undefined;
|
|
515
515
|
responses?: Record<string, any> | undefined;
|
|
516
516
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
517
517
|
'x-codeSamples'?: {
|
|
518
518
|
source: string;
|
|
519
|
-
label?: string | undefined;
|
|
520
519
|
lang?: string | undefined;
|
|
520
|
+
label?: string | undefined;
|
|
521
521
|
}[] | undefined;
|
|
522
522
|
'x-code-samples'?: {
|
|
523
523
|
source: string;
|
|
524
|
-
label?: string | undefined;
|
|
525
524
|
lang?: string | undefined;
|
|
525
|
+
label?: string | undefined;
|
|
526
526
|
}[] | undefined;
|
|
527
527
|
'x-custom-examples'?: {
|
|
528
528
|
source: string;
|
|
529
|
-
label?: string | undefined;
|
|
530
529
|
lang?: string | undefined;
|
|
530
|
+
label?: string | undefined;
|
|
531
531
|
}[] | undefined;
|
|
532
532
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
533
533
|
'x-post-response'?: string | undefined;
|
|
534
534
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
535
|
-
undo: (uid: string & import("zod")
|
|
536
|
-
redo: (uid: string & import("zod")
|
|
535
|
+
undo: (uid: string & import("zod").$brand<"operation">) => void;
|
|
536
|
+
redo: (uid: string & import("zod").$brand<"operation">) => void;
|
|
537
537
|
reset: () => void;
|
|
538
538
|
};
|
|
539
539
|
};
|
|
@@ -543,14 +543,14 @@ type AddTag = ReturnType<typeof extendedTagDataFactory>['addTag'];
|
|
|
543
543
|
*/
|
|
544
544
|
export declare function extendedRequestDataFactory({ requestExamples, requestExampleMutators, requestMutators, collectionMutators, collections, tags, tagMutators, }: StoreContext, addTag: AddTag): {
|
|
545
545
|
addRequest: (payload: RequestPayload, collectionUid: Collection["uid"]) => void | {
|
|
546
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
547
|
-
path: string;
|
|
548
546
|
type: "request";
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
547
|
+
uid: string & import("zod").$brand<"operation">;
|
|
548
|
+
path: string;
|
|
549
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
550
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
551
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
552
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
553
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
554
554
|
description?: string | undefined;
|
|
555
555
|
summary?: string | undefined;
|
|
556
556
|
externalDocs?: {
|
|
@@ -565,38 +565,38 @@ export declare function extendedRequestDataFactory({ requestExamples, requestExa
|
|
|
565
565
|
operationId?: string | undefined;
|
|
566
566
|
requestBody?: any;
|
|
567
567
|
parameters?: {
|
|
568
|
+
in: "path" | "cookie" | "query" | "header";
|
|
568
569
|
name: string;
|
|
569
570
|
required: boolean;
|
|
570
571
|
deprecated: boolean;
|
|
571
|
-
in: "cookie" | "path" | "query" | "header";
|
|
572
572
|
description?: string | undefined;
|
|
573
|
-
example?: unknown;
|
|
574
|
-
content?: unknown;
|
|
575
573
|
schema?: unknown;
|
|
576
|
-
|
|
574
|
+
content?: unknown;
|
|
575
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
576
|
+
explode?: boolean | undefined;
|
|
577
|
+
example?: unknown;
|
|
578
|
+
examples?: Record<string, {
|
|
577
579
|
value?: unknown;
|
|
578
580
|
summary?: string | undefined;
|
|
579
581
|
externalValue?: string | undefined;
|
|
580
|
-
}> | undefined;
|
|
581
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
582
|
-
explode?: boolean | undefined;
|
|
582
|
+
}> | unknown[] | undefined;
|
|
583
583
|
}[] | undefined;
|
|
584
584
|
responses?: Record<string, any> | undefined;
|
|
585
585
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
586
586
|
'x-codeSamples'?: {
|
|
587
587
|
source: string;
|
|
588
|
-
label?: string | undefined;
|
|
589
588
|
lang?: string | undefined;
|
|
589
|
+
label?: string | undefined;
|
|
590
590
|
}[] | undefined;
|
|
591
591
|
'x-code-samples'?: {
|
|
592
592
|
source: string;
|
|
593
|
-
label?: string | undefined;
|
|
594
593
|
lang?: string | undefined;
|
|
594
|
+
label?: string | undefined;
|
|
595
595
|
}[] | undefined;
|
|
596
596
|
'x-custom-examples'?: {
|
|
597
597
|
source: string;
|
|
598
|
-
label?: string | undefined;
|
|
599
598
|
lang?: string | undefined;
|
|
599
|
+
label?: string | undefined;
|
|
600
600
|
}[] | undefined;
|
|
601
601
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
602
602
|
'x-post-response'?: string | undefined;
|
|
@@ -612,14 +612,14 @@ export declare function findRequestParentsFactory({ collections, tags, }: {
|
|
|
612
612
|
/** First draft request" */
|
|
613
613
|
export declare function createInitialRequest(): {
|
|
614
614
|
request: {
|
|
615
|
-
uid: string & import("zod").BRAND<"operation">;
|
|
616
|
-
path: string;
|
|
617
615
|
type: "request";
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
616
|
+
uid: string & import("zod").$brand<"operation">;
|
|
617
|
+
path: string;
|
|
618
|
+
method: "delete" | "get" | "connect" | "head" | "options" | "patch" | "post" | "put" | "trace";
|
|
619
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
620
|
+
selectedServerUid: (string & import("zod").$brand<"server">) | null;
|
|
621
|
+
examples: (string & import("zod").$brand<"example">)[];
|
|
622
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
623
623
|
description?: string | undefined;
|
|
624
624
|
summary?: string | undefined;
|
|
625
625
|
externalDocs?: {
|
|
@@ -634,38 +634,38 @@ export declare function createInitialRequest(): {
|
|
|
634
634
|
operationId?: string | undefined;
|
|
635
635
|
requestBody?: any;
|
|
636
636
|
parameters?: {
|
|
637
|
+
in: "path" | "cookie" | "query" | "header";
|
|
637
638
|
name: string;
|
|
638
639
|
required: boolean;
|
|
639
640
|
deprecated: boolean;
|
|
640
|
-
in: "cookie" | "path" | "query" | "header";
|
|
641
641
|
description?: string | undefined;
|
|
642
|
-
example?: unknown;
|
|
643
|
-
content?: unknown;
|
|
644
642
|
schema?: unknown;
|
|
645
|
-
|
|
643
|
+
content?: unknown;
|
|
644
|
+
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
645
|
+
explode?: boolean | undefined;
|
|
646
|
+
example?: unknown;
|
|
647
|
+
examples?: Record<string, {
|
|
646
648
|
value?: unknown;
|
|
647
649
|
summary?: string | undefined;
|
|
648
650
|
externalValue?: string | undefined;
|
|
649
|
-
}> | undefined;
|
|
650
|
-
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
651
|
-
explode?: boolean | undefined;
|
|
651
|
+
}> | unknown[] | undefined;
|
|
652
652
|
}[] | undefined;
|
|
653
653
|
responses?: Record<string, any> | undefined;
|
|
654
654
|
callbacks?: Record<string, Record<string, Record<string, any>>> | undefined;
|
|
655
655
|
'x-codeSamples'?: {
|
|
656
656
|
source: string;
|
|
657
|
-
label?: string | undefined;
|
|
658
657
|
lang?: string | undefined;
|
|
658
|
+
label?: string | undefined;
|
|
659
659
|
}[] | undefined;
|
|
660
660
|
'x-code-samples'?: {
|
|
661
661
|
source: string;
|
|
662
|
-
label?: string | undefined;
|
|
663
662
|
lang?: string | undefined;
|
|
663
|
+
label?: string | undefined;
|
|
664
664
|
}[] | undefined;
|
|
665
665
|
'x-custom-examples'?: {
|
|
666
666
|
source: string;
|
|
667
|
-
label?: string | undefined;
|
|
668
667
|
lang?: string | undefined;
|
|
668
|
+
label?: string | undefined;
|
|
669
669
|
}[] | undefined;
|
|
670
670
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
671
671
|
'x-post-response'?: string | undefined;
|