@scalar/api-client 2.2.32 → 2.2.34
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 +38 -0
- package/dist/components/AddressBar/AddressBar.vue.js +2 -2
- package/dist/components/AddressBar/AddressBar.vue2.js +27 -26
- package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts +9 -3
- package/dist/components/CommandPalette/CommandPaletteServer.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteServer.vue.js +62 -54
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +13 -3
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTable.vue.js +7 -7
- package/dist/components/DataTable/DataTableCell.vue.js +6 -6
- package/dist/components/Form/Form.vue.d.ts.map +1 -1
- package/dist/components/Form/Form.vue.js +5 -5
- package/dist/components/ImportCollection/ImportCollectionModal.vue.d.ts.map +1 -1
- package/dist/components/ImportCollection/ImportCollectionModal.vue.js +72 -71
- package/dist/components/ImportCollection/WorkspaceSelector.vue.d.ts.map +1 -1
- package/dist/components/ImportCollection/WorkspaceSelector.vue.js +23 -22
- package/dist/components/Search/useSearch.d.ts.map +1 -1
- package/dist/components/Search/useSearch.js +61 -48
- package/dist/components/SideNav/SideNavLink.vue.js +2 -2
- package/dist/components/Sidebar/Sidebar.vue.js +2 -2
- package/dist/components/Sidebar/Sidebar.vue2.js +5 -5
- package/dist/components/Sidebar/SidebarList.vue.js +1 -1
- package/dist/components/Sidebar/SidebarListElement.vue.d.ts +1 -1
- package/dist/components/Sidebar/SidebarListElement.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/SidebarListElement.vue.js +2 -2
- package/dist/components/Sidebar/SidebarListElement.vue2.js +12 -12
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +1 -1
- package/dist/components/ViewLayout/ViewLayoutSection.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayoutSection.vue.js +1 -1
- package/dist/constants.d.ts +4 -0
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +2 -2
- package/dist/layouts/App/create-api-client-app.d.ts +171 -128
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +342 -256
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +171 -128
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +172 -129
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/create-client.js +8 -7
- package/dist/libs/find-request.d.ts +2 -0
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/send-request/send-request.d.ts.map +1 -1
- package/dist/libs/send-request/send-request.js +93 -93
- package/dist/routes.d.ts +1 -0
- package/dist/routes.d.ts.map +1 -1
- package/dist/routes.js +12 -7
- package/dist/store/active-entities.d.ts +29 -27
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +4 -4
- package/dist/store/events.d.ts +3 -1
- package/dist/store/events.d.ts.map +1 -1
- package/dist/store/request-example.d.ts +134 -134
- package/dist/store/request-example.d.ts.map +1 -1
- package/dist/store/requests.d.ts +26 -4
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/store.d.ts +174 -129
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/store.js +48 -46
- package/dist/store/tags.d.ts +24 -4
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/views/Cookies/CookieForm.vue.d.ts.map +1 -1
- package/dist/views/Cookies/CookieForm.vue.js +12 -12
- package/dist/views/Cookies/Cookies.vue2.js +12 -12
- package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
- package/dist/views/Environment/Environment.vue2.js +98 -97
- package/dist/views/Environment/EnvironmentModal.vue.js +1 -1
- package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +6 -6
- package/dist/views/Request/RequestSidebar.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebar.vue.js +3 -3
- package/dist/views/Request/RequestSidebar.vue2.js +14 -14
- package/dist/views/Request/RequestSidebarItem.vue.d.ts +2 -2
- package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
- package/dist/views/Request/RequestSidebarItem.vue2.js +132 -125
- package/dist/views/Request/RequestSubpageHeader.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSubpageHeader.vue.js +1 -1
- package/dist/views/Request/RequestSubpageHeader.vue2.js +21 -21
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +12 -12
- package/dist/views/Servers/ServerForm.vue.d.ts +8 -1
- package/dist/views/Servers/ServerForm.vue.d.ts.map +1 -1
- package/dist/views/Servers/ServerForm.vue.js +28 -59
- package/dist/views/Servers/Servers.vue.d.ts.map +1 -1
- package/dist/views/Servers/Servers.vue2.js +141 -53
- package/package.json +13 -13
package/dist/store/store.d.ts
CHANGED
|
@@ -19,6 +19,8 @@ type CreateWorkspaceStoreOptions = {
|
|
|
19
19
|
isReadOnly: boolean;
|
|
20
20
|
/** Should be renamed to theme to match the references config */
|
|
21
21
|
themeId: ReferenceConfiguration['theme'];
|
|
22
|
+
/** Specifies the integration being used. This is primarily for internal purposes and should not be manually set. */
|
|
23
|
+
integration: ReferenceConfiguration['_integration'];
|
|
22
24
|
} & Pick<ReferenceConfiguration, 'proxyUrl' | 'showSidebar' | 'hideClientButton'>;
|
|
23
25
|
/**
|
|
24
26
|
/**
|
|
@@ -27,7 +29,7 @@ type CreateWorkspaceStoreOptions = {
|
|
|
27
29
|
* This store manages all data and state for the application.
|
|
28
30
|
* It should be instantiated once and injected into the app’s root component.
|
|
29
31
|
*/
|
|
30
|
-
export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showSidebar, proxyUrl, themeId, hideClientButton, }: CreateWorkspaceStoreOptions) => {
|
|
32
|
+
export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showSidebar, proxyUrl, themeId, hideClientButton, integration, }: CreateWorkspaceStoreOptions) => {
|
|
31
33
|
workspaces: Record<string, {
|
|
32
34
|
uid: string;
|
|
33
35
|
name: string;
|
|
@@ -114,6 +116,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
114
116
|
'x-scalar-children'?: {
|
|
115
117
|
tagName: string;
|
|
116
118
|
}[] | undefined;
|
|
119
|
+
'x-internal'?: boolean | undefined;
|
|
120
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
117
121
|
}>;
|
|
118
122
|
cookies: Record<string, {
|
|
119
123
|
value: string;
|
|
@@ -139,33 +143,6 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
139
143
|
type: "requestExample";
|
|
140
144
|
uid: string;
|
|
141
145
|
name: string;
|
|
142
|
-
body: {
|
|
143
|
-
activeBody: "formData" | "binary" | "raw";
|
|
144
|
-
formData?: {
|
|
145
|
-
value: {
|
|
146
|
-
value: string;
|
|
147
|
-
key: string;
|
|
148
|
-
enabled: boolean;
|
|
149
|
-
minimum?: number | undefined;
|
|
150
|
-
type?: string | undefined;
|
|
151
|
-
maximum?: number | undefined;
|
|
152
|
-
default?: any;
|
|
153
|
-
required?: boolean | undefined;
|
|
154
|
-
description?: string | undefined;
|
|
155
|
-
enum?: string[] | undefined;
|
|
156
|
-
format?: string | undefined;
|
|
157
|
-
file?: any;
|
|
158
|
-
nullable?: boolean | undefined;
|
|
159
|
-
}[];
|
|
160
|
-
encoding: "form-data" | "urlencoded";
|
|
161
|
-
} | undefined;
|
|
162
|
-
binary?: Blob | undefined;
|
|
163
|
-
raw?: {
|
|
164
|
-
value: string;
|
|
165
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
166
|
-
} | undefined;
|
|
167
|
-
};
|
|
168
|
-
requestUid: string;
|
|
169
146
|
parameters: {
|
|
170
147
|
path: {
|
|
171
148
|
value: string;
|
|
@@ -228,6 +205,33 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
228
205
|
nullable?: boolean | undefined;
|
|
229
206
|
}[];
|
|
230
207
|
};
|
|
208
|
+
body: {
|
|
209
|
+
activeBody: "binary" | "formData" | "raw";
|
|
210
|
+
binary?: Blob | undefined;
|
|
211
|
+
formData?: {
|
|
212
|
+
value: {
|
|
213
|
+
value: string;
|
|
214
|
+
key: string;
|
|
215
|
+
enabled: boolean;
|
|
216
|
+
minimum?: number | undefined;
|
|
217
|
+
type?: string | undefined;
|
|
218
|
+
maximum?: number | undefined;
|
|
219
|
+
default?: any;
|
|
220
|
+
required?: boolean | undefined;
|
|
221
|
+
description?: string | undefined;
|
|
222
|
+
enum?: string[] | undefined;
|
|
223
|
+
format?: string | undefined;
|
|
224
|
+
file?: any;
|
|
225
|
+
nullable?: boolean | undefined;
|
|
226
|
+
}[];
|
|
227
|
+
encoding: "form-data" | "urlencoded";
|
|
228
|
+
} | undefined;
|
|
229
|
+
raw?: {
|
|
230
|
+
value: string;
|
|
231
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
232
|
+
} | undefined;
|
|
233
|
+
};
|
|
234
|
+
requestUid: string;
|
|
231
235
|
serverVariables?: Record<string, string[]> | undefined;
|
|
232
236
|
}>;
|
|
233
237
|
requests: Record<string, {
|
|
@@ -245,6 +249,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
245
249
|
url: string;
|
|
246
250
|
description?: string | undefined;
|
|
247
251
|
} | undefined;
|
|
252
|
+
'x-internal'?: boolean | undefined;
|
|
253
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
248
254
|
security?: Record<string, string[]>[] | undefined;
|
|
249
255
|
tags?: string[] | undefined;
|
|
250
256
|
deprecated?: boolean | undefined;
|
|
@@ -358,7 +364,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
358
364
|
hide: () => void;
|
|
359
365
|
};
|
|
360
366
|
events: {
|
|
361
|
-
executeRequest: import("../libs/index.js").EventBus<
|
|
367
|
+
executeRequest: import("../libs/index.js").EventBus<{
|
|
368
|
+
requestUid?: string;
|
|
369
|
+
}>;
|
|
362
370
|
cancelRequest: import("../libs/index.js").EventBus<any>;
|
|
363
371
|
requestStatus: import("../libs/index.js").EventBus<import("../libs/index.js").RequestStatus>;
|
|
364
372
|
commandPalette: import("../libs/index.js").EventBus<import("../components/CommandPalette/TheCommandPalette.vue.js").CommandPaletteEvent>;
|
|
@@ -370,6 +378,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
370
378
|
isReadOnly: boolean;
|
|
371
379
|
hideClientButton: boolean | undefined;
|
|
372
380
|
showSidebar: boolean;
|
|
381
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
373
382
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
374
383
|
type?: "collection" | undefined;
|
|
375
384
|
uid?: string | undefined;
|
|
@@ -926,7 +935,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
926
935
|
documentUrl?: string | undefined;
|
|
927
936
|
integration?: string | null | undefined;
|
|
928
937
|
}) => void;
|
|
929
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
938
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
930
939
|
type: "collection";
|
|
931
940
|
uid: string;
|
|
932
941
|
children: string[];
|
|
@@ -980,7 +989,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
980
989
|
}> | undefined;
|
|
981
990
|
documentUrl?: string | undefined;
|
|
982
991
|
integration?: string | null | undefined;
|
|
983
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
992
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends Path<{
|
|
984
993
|
type: "collection";
|
|
985
994
|
uid: string;
|
|
986
995
|
children: string[];
|
|
@@ -1089,7 +1098,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1089
1098
|
documentUrl?: string | undefined;
|
|
1090
1099
|
integration?: string | null | undefined;
|
|
1091
1100
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1092
|
-
untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1101
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
1093
1102
|
type: "collection";
|
|
1094
1103
|
uid: string;
|
|
1095
1104
|
children: string[];
|
|
@@ -1143,7 +1152,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1143
1152
|
}> | undefined;
|
|
1144
1153
|
documentUrl?: string | undefined;
|
|
1145
1154
|
integration?: string | null | undefined;
|
|
1146
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
1155
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends Path<{
|
|
1147
1156
|
type: "collection";
|
|
1148
1157
|
uid: string;
|
|
1149
1158
|
children: string[];
|
|
@@ -1330,6 +1339,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1330
1339
|
url: string;
|
|
1331
1340
|
description?: string | undefined;
|
|
1332
1341
|
} | undefined;
|
|
1342
|
+
'x-internal'?: boolean | undefined;
|
|
1343
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1333
1344
|
security?: Record<string, string[]>[] | undefined;
|
|
1334
1345
|
tags?: string[] | undefined;
|
|
1335
1346
|
deprecated?: boolean | undefined;
|
|
@@ -1367,6 +1378,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1367
1378
|
url: string;
|
|
1368
1379
|
description?: string | undefined;
|
|
1369
1380
|
} | undefined;
|
|
1381
|
+
'x-internal'?: boolean | undefined;
|
|
1382
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1370
1383
|
security?: Record<string, string[]>[] | undefined;
|
|
1371
1384
|
tags?: string[] | undefined;
|
|
1372
1385
|
deprecated?: boolean | undefined;
|
|
@@ -1405,6 +1418,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1405
1418
|
url: string;
|
|
1406
1419
|
description?: string | undefined;
|
|
1407
1420
|
} | undefined;
|
|
1421
|
+
'x-internal'?: boolean | undefined;
|
|
1422
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1408
1423
|
security?: Record<string, string[]>[] | undefined;
|
|
1409
1424
|
tags?: string[] | undefined;
|
|
1410
1425
|
deprecated?: boolean | undefined;
|
|
@@ -1427,7 +1442,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1427
1442
|
requestBody?: any;
|
|
1428
1443
|
responses?: Record<string, any> | undefined;
|
|
1429
1444
|
}) => void;
|
|
1430
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1445
|
+
edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
1431
1446
|
path: string;
|
|
1432
1447
|
type: "request";
|
|
1433
1448
|
uid: string;
|
|
@@ -1442,6 +1457,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1442
1457
|
url: string;
|
|
1443
1458
|
description?: string | undefined;
|
|
1444
1459
|
} | undefined;
|
|
1460
|
+
'x-internal'?: boolean | undefined;
|
|
1461
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1445
1462
|
security?: Record<string, string[]>[] | undefined;
|
|
1446
1463
|
tags?: string[] | undefined;
|
|
1447
1464
|
deprecated?: boolean | undefined;
|
|
@@ -1463,7 +1480,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1463
1480
|
}[] | undefined;
|
|
1464
1481
|
requestBody?: any;
|
|
1465
1482
|
responses?: Record<string, any> | undefined;
|
|
1466
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1483
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends Path<{
|
|
1467
1484
|
path: string;
|
|
1468
1485
|
type: "request";
|
|
1469
1486
|
uid: string;
|
|
@@ -1478,6 +1495,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1478
1495
|
url: string;
|
|
1479
1496
|
description?: string | undefined;
|
|
1480
1497
|
} | undefined;
|
|
1498
|
+
'x-internal'?: boolean | undefined;
|
|
1499
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1481
1500
|
security?: Record<string, string[]>[] | undefined;
|
|
1482
1501
|
tags?: string[] | undefined;
|
|
1483
1502
|
deprecated?: boolean | undefined;
|
|
@@ -1514,6 +1533,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1514
1533
|
url: string;
|
|
1515
1534
|
description?: string | undefined;
|
|
1516
1535
|
} | undefined;
|
|
1536
|
+
'x-internal'?: boolean | undefined;
|
|
1537
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1517
1538
|
security?: Record<string, string[]>[] | undefined;
|
|
1518
1539
|
tags?: string[] | undefined;
|
|
1519
1540
|
deprecated?: boolean | undefined;
|
|
@@ -1536,7 +1557,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1536
1557
|
requestBody?: any;
|
|
1537
1558
|
responses?: Record<string, any> | undefined;
|
|
1538
1559
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1539
|
-
untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1560
|
+
untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | "method" | "path" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.required` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? {
|
|
1540
1561
|
path: string;
|
|
1541
1562
|
type: "request";
|
|
1542
1563
|
uid: string;
|
|
@@ -1551,6 +1572,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1551
1572
|
url: string;
|
|
1552
1573
|
description?: string | undefined;
|
|
1553
1574
|
} | undefined;
|
|
1575
|
+
'x-internal'?: boolean | undefined;
|
|
1576
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1554
1577
|
security?: Record<string, string[]>[] | undefined;
|
|
1555
1578
|
tags?: string[] | undefined;
|
|
1556
1579
|
deprecated?: boolean | undefined;
|
|
@@ -1572,7 +1595,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1572
1595
|
}[] | undefined;
|
|
1573
1596
|
requestBody?: any;
|
|
1574
1597
|
responses?: Record<string, any> | undefined;
|
|
1575
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "
|
|
1598
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "method" | "path" | "examples" ? R extends Path<{
|
|
1576
1599
|
path: string;
|
|
1577
1600
|
type: "request";
|
|
1578
1601
|
uid: string;
|
|
@@ -1587,6 +1610,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1587
1610
|
url: string;
|
|
1588
1611
|
description?: string | undefined;
|
|
1589
1612
|
} | undefined;
|
|
1613
|
+
'x-internal'?: boolean | undefined;
|
|
1614
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1590
1615
|
security?: Record<string, string[]>[] | undefined;
|
|
1591
1616
|
tags?: string[] | undefined;
|
|
1592
1617
|
deprecated?: boolean | undefined;
|
|
@@ -1623,6 +1648,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1623
1648
|
url: string;
|
|
1624
1649
|
description?: string | undefined;
|
|
1625
1650
|
} | undefined;
|
|
1651
|
+
'x-internal'?: boolean | undefined;
|
|
1652
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1626
1653
|
security?: Record<string, string[]>[] | undefined;
|
|
1627
1654
|
tags?: string[] | undefined;
|
|
1628
1655
|
deprecated?: boolean | undefined;
|
|
@@ -1655,33 +1682,6 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1655
1682
|
type: "requestExample";
|
|
1656
1683
|
uid: string;
|
|
1657
1684
|
name: string;
|
|
1658
|
-
body: {
|
|
1659
|
-
activeBody: "formData" | "binary" | "raw";
|
|
1660
|
-
formData?: {
|
|
1661
|
-
value: {
|
|
1662
|
-
value: string;
|
|
1663
|
-
key: string;
|
|
1664
|
-
enabled: boolean;
|
|
1665
|
-
minimum?: number | undefined;
|
|
1666
|
-
type?: string | undefined;
|
|
1667
|
-
maximum?: number | undefined;
|
|
1668
|
-
default?: any;
|
|
1669
|
-
required?: boolean | undefined;
|
|
1670
|
-
description?: string | undefined;
|
|
1671
|
-
enum?: string[] | undefined;
|
|
1672
|
-
format?: string | undefined;
|
|
1673
|
-
file?: any;
|
|
1674
|
-
nullable?: boolean | undefined;
|
|
1675
|
-
}[];
|
|
1676
|
-
encoding: "form-data" | "urlencoded";
|
|
1677
|
-
} | undefined;
|
|
1678
|
-
binary?: Blob | undefined;
|
|
1679
|
-
raw?: {
|
|
1680
|
-
value: string;
|
|
1681
|
-
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1682
|
-
} | undefined;
|
|
1683
|
-
};
|
|
1684
|
-
requestUid: string;
|
|
1685
1685
|
parameters: {
|
|
1686
1686
|
path: {
|
|
1687
1687
|
value: string;
|
|
@@ -1744,14 +1744,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1744
1744
|
nullable?: boolean | undefined;
|
|
1745
1745
|
}[];
|
|
1746
1746
|
};
|
|
1747
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1748
|
-
}) => void;
|
|
1749
|
-
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1750
|
-
type: "requestExample";
|
|
1751
|
-
uid: string;
|
|
1752
|
-
name: string;
|
|
1753
1747
|
body: {
|
|
1754
|
-
activeBody: "
|
|
1748
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1749
|
+
binary?: Blob | undefined;
|
|
1755
1750
|
formData?: {
|
|
1756
1751
|
value: {
|
|
1757
1752
|
value: string;
|
|
@@ -1770,13 +1765,18 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1770
1765
|
}[];
|
|
1771
1766
|
encoding: "form-data" | "urlencoded";
|
|
1772
1767
|
} | undefined;
|
|
1773
|
-
binary?: Blob | undefined;
|
|
1774
1768
|
raw?: {
|
|
1775
1769
|
value: string;
|
|
1776
1770
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1777
1771
|
} | undefined;
|
|
1778
1772
|
};
|
|
1779
1773
|
requestUid: string;
|
|
1774
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1775
|
+
}) => void;
|
|
1776
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1777
|
+
type: "requestExample";
|
|
1778
|
+
uid: string;
|
|
1779
|
+
name: string;
|
|
1780
1780
|
parameters: {
|
|
1781
1781
|
path: {
|
|
1782
1782
|
value: string;
|
|
@@ -1839,15 +1839,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1839
1839
|
nullable?: boolean | undefined;
|
|
1840
1840
|
}[];
|
|
1841
1841
|
};
|
|
1842
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1843
|
-
};
|
|
1844
|
-
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1845
|
-
set: (item: {
|
|
1846
|
-
type: "requestExample";
|
|
1847
|
-
uid: string;
|
|
1848
|
-
name: string;
|
|
1849
1842
|
body: {
|
|
1850
|
-
activeBody: "
|
|
1843
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1844
|
+
binary?: Blob | undefined;
|
|
1851
1845
|
formData?: {
|
|
1852
1846
|
value: {
|
|
1853
1847
|
value: string;
|
|
@@ -1866,13 +1860,19 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1866
1860
|
}[];
|
|
1867
1861
|
encoding: "form-data" | "urlencoded";
|
|
1868
1862
|
} | undefined;
|
|
1869
|
-
binary?: Blob | undefined;
|
|
1870
1863
|
raw?: {
|
|
1871
1864
|
value: string;
|
|
1872
1865
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1873
1866
|
} | undefined;
|
|
1874
1867
|
};
|
|
1875
1868
|
requestUid: string;
|
|
1869
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1870
|
+
};
|
|
1871
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1872
|
+
set: (item: {
|
|
1873
|
+
type: "requestExample";
|
|
1874
|
+
uid: string;
|
|
1875
|
+
name: string;
|
|
1876
1876
|
parameters: {
|
|
1877
1877
|
path: {
|
|
1878
1878
|
value: string;
|
|
@@ -1935,14 +1935,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1935
1935
|
nullable?: boolean | undefined;
|
|
1936
1936
|
}[];
|
|
1937
1937
|
};
|
|
1938
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
1939
|
-
}) => void;
|
|
1940
|
-
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
1941
|
-
type: "requestExample";
|
|
1942
|
-
uid: string;
|
|
1943
|
-
name: string;
|
|
1944
1938
|
body: {
|
|
1945
|
-
activeBody: "
|
|
1939
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1940
|
+
binary?: Blob | undefined;
|
|
1946
1941
|
formData?: {
|
|
1947
1942
|
value: {
|
|
1948
1943
|
value: string;
|
|
@@ -1961,13 +1956,18 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1961
1956
|
}[];
|
|
1962
1957
|
encoding: "form-data" | "urlencoded";
|
|
1963
1958
|
} | undefined;
|
|
1964
|
-
binary?: Blob | undefined;
|
|
1965
1959
|
raw?: {
|
|
1966
1960
|
value: string;
|
|
1967
1961
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1968
1962
|
} | undefined;
|
|
1969
1963
|
};
|
|
1970
1964
|
requestUid: string;
|
|
1965
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1966
|
+
}) => void;
|
|
1967
|
+
edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
1968
|
+
type: "requestExample";
|
|
1969
|
+
uid: string;
|
|
1970
|
+
name: string;
|
|
1971
1971
|
parameters: {
|
|
1972
1972
|
path: {
|
|
1973
1973
|
value: string;
|
|
@@ -2030,13 +2030,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2030
2030
|
nullable?: boolean | undefined;
|
|
2031
2031
|
}[];
|
|
2032
2032
|
};
|
|
2033
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2034
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
|
|
2035
|
-
type: "requestExample";
|
|
2036
|
-
uid: string;
|
|
2037
|
-
name: string;
|
|
2038
2033
|
body: {
|
|
2039
|
-
activeBody: "
|
|
2034
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2035
|
+
binary?: Blob | undefined;
|
|
2040
2036
|
formData?: {
|
|
2041
2037
|
value: {
|
|
2042
2038
|
value: string;
|
|
@@ -2055,13 +2051,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2055
2051
|
}[];
|
|
2056
2052
|
encoding: "form-data" | "urlencoded";
|
|
2057
2053
|
} | undefined;
|
|
2058
|
-
binary?: Blob | undefined;
|
|
2059
2054
|
raw?: {
|
|
2060
2055
|
value: string;
|
|
2061
2056
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2062
2057
|
} | undefined;
|
|
2063
2058
|
};
|
|
2064
2059
|
requestUid: string;
|
|
2060
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2061
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
|
|
2062
|
+
type: "requestExample";
|
|
2063
|
+
uid: string;
|
|
2064
|
+
name: string;
|
|
2065
2065
|
parameters: {
|
|
2066
2066
|
path: {
|
|
2067
2067
|
value: string;
|
|
@@ -2124,13 +2124,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2124
2124
|
nullable?: boolean | undefined;
|
|
2125
2125
|
}[];
|
|
2126
2126
|
};
|
|
2127
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2128
|
-
}[K]> ? PathValue<{
|
|
2129
|
-
type: "requestExample";
|
|
2130
|
-
uid: string;
|
|
2131
|
-
name: string;
|
|
2132
2127
|
body: {
|
|
2133
|
-
activeBody: "
|
|
2128
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2129
|
+
binary?: Blob | undefined;
|
|
2134
2130
|
formData?: {
|
|
2135
2131
|
value: {
|
|
2136
2132
|
value: string;
|
|
@@ -2149,13 +2145,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2149
2145
|
}[];
|
|
2150
2146
|
encoding: "form-data" | "urlencoded";
|
|
2151
2147
|
} | undefined;
|
|
2152
|
-
binary?: Blob | undefined;
|
|
2153
2148
|
raw?: {
|
|
2154
2149
|
value: string;
|
|
2155
2150
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2156
2151
|
} | undefined;
|
|
2157
2152
|
};
|
|
2158
2153
|
requestUid: string;
|
|
2154
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2155
|
+
}[K]> ? PathValue<{
|
|
2156
|
+
type: "requestExample";
|
|
2157
|
+
uid: string;
|
|
2158
|
+
name: string;
|
|
2159
2159
|
parameters: {
|
|
2160
2160
|
path: {
|
|
2161
2161
|
value: string;
|
|
@@ -2218,14 +2218,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2218
2218
|
nullable?: boolean | undefined;
|
|
2219
2219
|
}[];
|
|
2220
2220
|
};
|
|
2221
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2222
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2223
|
-
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
2224
|
-
type: "requestExample";
|
|
2225
|
-
uid: string;
|
|
2226
|
-
name: string;
|
|
2227
2221
|
body: {
|
|
2228
|
-
activeBody: "
|
|
2222
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2223
|
+
binary?: Blob | undefined;
|
|
2229
2224
|
formData?: {
|
|
2230
2225
|
value: {
|
|
2231
2226
|
value: string;
|
|
@@ -2244,13 +2239,18 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2244
2239
|
}[];
|
|
2245
2240
|
encoding: "form-data" | "urlencoded";
|
|
2246
2241
|
} | undefined;
|
|
2247
|
-
binary?: Blob | undefined;
|
|
2248
2242
|
raw?: {
|
|
2249
2243
|
value: string;
|
|
2250
2244
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2251
2245
|
} | undefined;
|
|
2252
2246
|
};
|
|
2253
2247
|
requestUid: string;
|
|
2248
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2249
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2250
|
+
untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.binary" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.format` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.format` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
|
|
2251
|
+
type: "requestExample";
|
|
2252
|
+
uid: string;
|
|
2253
|
+
name: string;
|
|
2254
2254
|
parameters: {
|
|
2255
2255
|
path: {
|
|
2256
2256
|
value: string;
|
|
@@ -2313,13 +2313,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2313
2313
|
nullable?: boolean | undefined;
|
|
2314
2314
|
}[];
|
|
2315
2315
|
};
|
|
2316
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2317
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
|
|
2318
|
-
type: "requestExample";
|
|
2319
|
-
uid: string;
|
|
2320
|
-
name: string;
|
|
2321
2316
|
body: {
|
|
2322
|
-
activeBody: "
|
|
2317
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2318
|
+
binary?: Blob | undefined;
|
|
2323
2319
|
formData?: {
|
|
2324
2320
|
value: {
|
|
2325
2321
|
value: string;
|
|
@@ -2338,13 +2334,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2338
2334
|
}[];
|
|
2339
2335
|
encoding: "form-data" | "urlencoded";
|
|
2340
2336
|
} | undefined;
|
|
2341
|
-
binary?: Blob | undefined;
|
|
2342
2337
|
raw?: {
|
|
2343
2338
|
value: string;
|
|
2344
2339
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2345
2340
|
} | undefined;
|
|
2346
2341
|
};
|
|
2347
2342
|
requestUid: string;
|
|
2343
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2344
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
|
|
2345
|
+
type: "requestExample";
|
|
2346
|
+
uid: string;
|
|
2347
|
+
name: string;
|
|
2348
2348
|
parameters: {
|
|
2349
2349
|
path: {
|
|
2350
2350
|
value: string;
|
|
@@ -2407,13 +2407,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2407
2407
|
nullable?: boolean | undefined;
|
|
2408
2408
|
}[];
|
|
2409
2409
|
};
|
|
2410
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2411
|
-
}[K]> ? PathValue<{
|
|
2412
|
-
type: "requestExample";
|
|
2413
|
-
uid: string;
|
|
2414
|
-
name: string;
|
|
2415
2410
|
body: {
|
|
2416
|
-
activeBody: "
|
|
2411
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2412
|
+
binary?: Blob | undefined;
|
|
2417
2413
|
formData?: {
|
|
2418
2414
|
value: {
|
|
2419
2415
|
value: string;
|
|
@@ -2432,13 +2428,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2432
2428
|
}[];
|
|
2433
2429
|
encoding: "form-data" | "urlencoded";
|
|
2434
2430
|
} | undefined;
|
|
2435
|
-
binary?: Blob | undefined;
|
|
2436
2431
|
raw?: {
|
|
2437
2432
|
value: string;
|
|
2438
2433
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2439
2434
|
} | undefined;
|
|
2440
2435
|
};
|
|
2441
2436
|
requestUid: string;
|
|
2437
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2438
|
+
}[K]> ? PathValue<{
|
|
2439
|
+
type: "requestExample";
|
|
2440
|
+
uid: string;
|
|
2441
|
+
name: string;
|
|
2442
2442
|
parameters: {
|
|
2443
2443
|
path: {
|
|
2444
2444
|
value: string;
|
|
@@ -2501,6 +2501,33 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2501
2501
|
nullable?: boolean | undefined;
|
|
2502
2502
|
}[];
|
|
2503
2503
|
};
|
|
2504
|
+
body: {
|
|
2505
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2506
|
+
binary?: Blob | undefined;
|
|
2507
|
+
formData?: {
|
|
2508
|
+
value: {
|
|
2509
|
+
value: string;
|
|
2510
|
+
key: string;
|
|
2511
|
+
enabled: boolean;
|
|
2512
|
+
minimum?: number | undefined;
|
|
2513
|
+
type?: string | undefined;
|
|
2514
|
+
maximum?: number | undefined;
|
|
2515
|
+
default?: any;
|
|
2516
|
+
required?: boolean | undefined;
|
|
2517
|
+
description?: string | undefined;
|
|
2518
|
+
enum?: string[] | undefined;
|
|
2519
|
+
format?: string | undefined;
|
|
2520
|
+
file?: any;
|
|
2521
|
+
nullable?: boolean | undefined;
|
|
2522
|
+
}[];
|
|
2523
|
+
encoding: "form-data" | "urlencoded";
|
|
2524
|
+
} | undefined;
|
|
2525
|
+
raw?: {
|
|
2526
|
+
value: string;
|
|
2527
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2528
|
+
} | undefined;
|
|
2529
|
+
};
|
|
2530
|
+
requestUid: string;
|
|
2504
2531
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2505
2532
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2506
2533
|
undo: (uid: string) => void;
|
|
@@ -3291,6 +3318,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3291
3318
|
'x-scalar-children'?: {
|
|
3292
3319
|
tagName: string;
|
|
3293
3320
|
}[] | undefined;
|
|
3321
|
+
'x-internal'?: boolean | undefined;
|
|
3322
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3294
3323
|
}) => void;
|
|
3295
3324
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
3296
3325
|
type: "tag";
|
|
@@ -3305,6 +3334,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3305
3334
|
'x-scalar-children'?: {
|
|
3306
3335
|
tagName: string;
|
|
3307
3336
|
}[] | undefined;
|
|
3337
|
+
'x-internal'?: boolean | undefined;
|
|
3338
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3308
3339
|
};
|
|
3309
3340
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
3310
3341
|
set: (item: {
|
|
@@ -3320,8 +3351,10 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3320
3351
|
'x-scalar-children'?: {
|
|
3321
3352
|
tagName: string;
|
|
3322
3353
|
}[] | undefined;
|
|
3354
|
+
'x-internal'?: boolean | undefined;
|
|
3355
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3323
3356
|
}) => void;
|
|
3324
|
-
edit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3357
|
+
edit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3325
3358
|
type: "tag";
|
|
3326
3359
|
uid: string;
|
|
3327
3360
|
name: string;
|
|
@@ -3334,7 +3367,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3334
3367
|
'x-scalar-children'?: {
|
|
3335
3368
|
tagName: string;
|
|
3336
3369
|
}[] | undefined;
|
|
3337
|
-
|
|
3370
|
+
'x-internal'?: boolean | undefined;
|
|
3371
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3372
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
|
|
3338
3373
|
type: "tag";
|
|
3339
3374
|
uid: string;
|
|
3340
3375
|
name: string;
|
|
@@ -3347,6 +3382,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3347
3382
|
'x-scalar-children'?: {
|
|
3348
3383
|
tagName: string;
|
|
3349
3384
|
}[] | undefined;
|
|
3385
|
+
'x-internal'?: boolean | undefined;
|
|
3386
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3350
3387
|
}[K]> ? PathValue<{
|
|
3351
3388
|
type: "tag";
|
|
3352
3389
|
uid: string;
|
|
@@ -3360,8 +3397,10 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3360
3397
|
'x-scalar-children'?: {
|
|
3361
3398
|
tagName: string;
|
|
3362
3399
|
}[] | undefined;
|
|
3400
|
+
'x-internal'?: boolean | undefined;
|
|
3401
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3363
3402
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3364
|
-
untrackedEdit: <P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3403
|
+
untrackedEdit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
|
|
3365
3404
|
type: "tag";
|
|
3366
3405
|
uid: string;
|
|
3367
3406
|
name: string;
|
|
@@ -3374,7 +3413,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3374
3413
|
'x-scalar-children'?: {
|
|
3375
3414
|
tagName: string;
|
|
3376
3415
|
}[] | undefined;
|
|
3377
|
-
|
|
3416
|
+
'x-internal'?: boolean | undefined;
|
|
3417
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3418
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path<{
|
|
3378
3419
|
type: "tag";
|
|
3379
3420
|
uid: string;
|
|
3380
3421
|
name: string;
|
|
@@ -3387,6 +3428,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3387
3428
|
'x-scalar-children'?: {
|
|
3388
3429
|
tagName: string;
|
|
3389
3430
|
}[] | undefined;
|
|
3431
|
+
'x-internal'?: boolean | undefined;
|
|
3432
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3390
3433
|
}[K]> ? PathValue<{
|
|
3391
3434
|
type: "tag";
|
|
3392
3435
|
uid: string;
|
|
@@ -3400,6 +3443,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3400
3443
|
'x-scalar-children'?: {
|
|
3401
3444
|
tagName: string;
|
|
3402
3445
|
}[] | undefined;
|
|
3446
|
+
'x-internal'?: boolean | undefined;
|
|
3447
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3403
3448
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3404
3449
|
undo: (uid: string) => void;
|
|
3405
3450
|
redo: (uid: string) => void;
|