@scalar/api-client 2.2.31 → 2.2.33
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 +36 -0
- 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 +168 -127
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +336 -254
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +168 -127
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +169 -128
- 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 +114 -116
- 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/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 +171 -128
- 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 +12 -12
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;
|
|
@@ -370,6 +376,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
370
376
|
isReadOnly: boolean;
|
|
371
377
|
hideClientButton: boolean | undefined;
|
|
372
378
|
showSidebar: boolean;
|
|
379
|
+
integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
|
|
373
380
|
importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
|
|
374
381
|
type?: "collection" | undefined;
|
|
375
382
|
uid?: string | undefined;
|
|
@@ -926,7 +933,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
926
933
|
documentUrl?: string | undefined;
|
|
927
934
|
integration?: string | null | undefined;
|
|
928
935
|
}) => void;
|
|
929
|
-
edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "selectedServerUid" | "
|
|
936
|
+
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
937
|
type: "collection";
|
|
931
938
|
uid: string;
|
|
932
939
|
children: string[];
|
|
@@ -980,7 +987,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
980
987
|
}> | undefined;
|
|
981
988
|
documentUrl?: string | undefined;
|
|
982
989
|
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" | "
|
|
990
|
+
}[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
991
|
type: "collection";
|
|
985
992
|
uid: string;
|
|
986
993
|
children: string[];
|
|
@@ -1089,7 +1096,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1089
1096
|
documentUrl?: string | undefined;
|
|
1090
1097
|
integration?: string | null | undefined;
|
|
1091
1098
|
}[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" | "
|
|
1099
|
+
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
1100
|
type: "collection";
|
|
1094
1101
|
uid: string;
|
|
1095
1102
|
children: string[];
|
|
@@ -1143,7 +1150,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1143
1150
|
}> | undefined;
|
|
1144
1151
|
documentUrl?: string | undefined;
|
|
1145
1152
|
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" | "
|
|
1153
|
+
}[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
1154
|
type: "collection";
|
|
1148
1155
|
uid: string;
|
|
1149
1156
|
children: string[];
|
|
@@ -1330,6 +1337,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1330
1337
|
url: string;
|
|
1331
1338
|
description?: string | undefined;
|
|
1332
1339
|
} | undefined;
|
|
1340
|
+
'x-internal'?: boolean | undefined;
|
|
1341
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1333
1342
|
security?: Record<string, string[]>[] | undefined;
|
|
1334
1343
|
tags?: string[] | undefined;
|
|
1335
1344
|
deprecated?: boolean | undefined;
|
|
@@ -1367,6 +1376,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1367
1376
|
url: string;
|
|
1368
1377
|
description?: string | undefined;
|
|
1369
1378
|
} | undefined;
|
|
1379
|
+
'x-internal'?: boolean | undefined;
|
|
1380
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1370
1381
|
security?: Record<string, string[]>[] | undefined;
|
|
1371
1382
|
tags?: string[] | undefined;
|
|
1372
1383
|
deprecated?: boolean | undefined;
|
|
@@ -1405,6 +1416,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1405
1416
|
url: string;
|
|
1406
1417
|
description?: string | undefined;
|
|
1407
1418
|
} | undefined;
|
|
1419
|
+
'x-internal'?: boolean | undefined;
|
|
1420
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1408
1421
|
security?: Record<string, string[]>[] | undefined;
|
|
1409
1422
|
tags?: string[] | undefined;
|
|
1410
1423
|
deprecated?: boolean | undefined;
|
|
@@ -1427,7 +1440,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1427
1440
|
requestBody?: any;
|
|
1428
1441
|
responses?: Record<string, any> | undefined;
|
|
1429
1442
|
}) => void;
|
|
1430
|
-
edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" |
|
|
1443
|
+
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
1444
|
path: string;
|
|
1432
1445
|
type: "request";
|
|
1433
1446
|
uid: string;
|
|
@@ -1442,6 +1455,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1442
1455
|
url: string;
|
|
1443
1456
|
description?: string | undefined;
|
|
1444
1457
|
} | undefined;
|
|
1458
|
+
'x-internal'?: boolean | undefined;
|
|
1459
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1445
1460
|
security?: Record<string, string[]>[] | undefined;
|
|
1446
1461
|
tags?: string[] | undefined;
|
|
1447
1462
|
deprecated?: boolean | undefined;
|
|
@@ -1463,7 +1478,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1463
1478
|
}[] | undefined;
|
|
1464
1479
|
requestBody?: any;
|
|
1465
1480
|
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" | "
|
|
1481
|
+
}[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
1482
|
path: string;
|
|
1468
1483
|
type: "request";
|
|
1469
1484
|
uid: string;
|
|
@@ -1478,6 +1493,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1478
1493
|
url: string;
|
|
1479
1494
|
description?: string | undefined;
|
|
1480
1495
|
} | undefined;
|
|
1496
|
+
'x-internal'?: boolean | undefined;
|
|
1497
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1481
1498
|
security?: Record<string, string[]>[] | undefined;
|
|
1482
1499
|
tags?: string[] | undefined;
|
|
1483
1500
|
deprecated?: boolean | undefined;
|
|
@@ -1514,6 +1531,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1514
1531
|
url: string;
|
|
1515
1532
|
description?: string | undefined;
|
|
1516
1533
|
} | undefined;
|
|
1534
|
+
'x-internal'?: boolean | undefined;
|
|
1535
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1517
1536
|
security?: Record<string, string[]>[] | undefined;
|
|
1518
1537
|
tags?: string[] | undefined;
|
|
1519
1538
|
deprecated?: boolean | undefined;
|
|
@@ -1536,7 +1555,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1536
1555
|
requestBody?: any;
|
|
1537
1556
|
responses?: Record<string, any> | undefined;
|
|
1538
1557
|
}[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" |
|
|
1558
|
+
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
1559
|
path: string;
|
|
1541
1560
|
type: "request";
|
|
1542
1561
|
uid: string;
|
|
@@ -1551,6 +1570,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1551
1570
|
url: string;
|
|
1552
1571
|
description?: string | undefined;
|
|
1553
1572
|
} | undefined;
|
|
1573
|
+
'x-internal'?: boolean | undefined;
|
|
1574
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1554
1575
|
security?: Record<string, string[]>[] | undefined;
|
|
1555
1576
|
tags?: string[] | undefined;
|
|
1556
1577
|
deprecated?: boolean | undefined;
|
|
@@ -1572,7 +1593,7 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1572
1593
|
}[] | undefined;
|
|
1573
1594
|
requestBody?: any;
|
|
1574
1595
|
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" | "
|
|
1596
|
+
}[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
1597
|
path: string;
|
|
1577
1598
|
type: "request";
|
|
1578
1599
|
uid: string;
|
|
@@ -1587,6 +1608,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1587
1608
|
url: string;
|
|
1588
1609
|
description?: string | undefined;
|
|
1589
1610
|
} | undefined;
|
|
1611
|
+
'x-internal'?: boolean | undefined;
|
|
1612
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1590
1613
|
security?: Record<string, string[]>[] | undefined;
|
|
1591
1614
|
tags?: string[] | undefined;
|
|
1592
1615
|
deprecated?: boolean | undefined;
|
|
@@ -1623,6 +1646,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1623
1646
|
url: string;
|
|
1624
1647
|
description?: string | undefined;
|
|
1625
1648
|
} | undefined;
|
|
1649
|
+
'x-internal'?: boolean | undefined;
|
|
1650
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
1626
1651
|
security?: Record<string, string[]>[] | undefined;
|
|
1627
1652
|
tags?: string[] | undefined;
|
|
1628
1653
|
deprecated?: boolean | undefined;
|
|
@@ -1655,33 +1680,6 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1655
1680
|
type: "requestExample";
|
|
1656
1681
|
uid: string;
|
|
1657
1682
|
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
1683
|
parameters: {
|
|
1686
1684
|
path: {
|
|
1687
1685
|
value: string;
|
|
@@ -1744,14 +1742,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1744
1742
|
nullable?: boolean | undefined;
|
|
1745
1743
|
}[];
|
|
1746
1744
|
};
|
|
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
1745
|
body: {
|
|
1754
|
-
activeBody: "
|
|
1746
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1747
|
+
binary?: Blob | undefined;
|
|
1755
1748
|
formData?: {
|
|
1756
1749
|
value: {
|
|
1757
1750
|
value: string;
|
|
@@ -1770,13 +1763,18 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1770
1763
|
}[];
|
|
1771
1764
|
encoding: "form-data" | "urlencoded";
|
|
1772
1765
|
} | undefined;
|
|
1773
|
-
binary?: Blob | undefined;
|
|
1774
1766
|
raw?: {
|
|
1775
1767
|
value: string;
|
|
1776
1768
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1777
1769
|
} | undefined;
|
|
1778
1770
|
};
|
|
1779
1771
|
requestUid: string;
|
|
1772
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1773
|
+
}) => void;
|
|
1774
|
+
add: (request: import("@scalar/oas-utils/entities/spec").Request, _name?: string) => {
|
|
1775
|
+
type: "requestExample";
|
|
1776
|
+
uid: string;
|
|
1777
|
+
name: string;
|
|
1780
1778
|
parameters: {
|
|
1781
1779
|
path: {
|
|
1782
1780
|
value: string;
|
|
@@ -1839,15 +1837,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1839
1837
|
nullable?: boolean | undefined;
|
|
1840
1838
|
}[];
|
|
1841
1839
|
};
|
|
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
1840
|
body: {
|
|
1850
|
-
activeBody: "
|
|
1841
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1842
|
+
binary?: Blob | undefined;
|
|
1851
1843
|
formData?: {
|
|
1852
1844
|
value: {
|
|
1853
1845
|
value: string;
|
|
@@ -1866,13 +1858,19 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1866
1858
|
}[];
|
|
1867
1859
|
encoding: "form-data" | "urlencoded";
|
|
1868
1860
|
} | undefined;
|
|
1869
|
-
binary?: Blob | undefined;
|
|
1870
1861
|
raw?: {
|
|
1871
1862
|
value: string;
|
|
1872
1863
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1873
1864
|
} | undefined;
|
|
1874
1865
|
};
|
|
1875
1866
|
requestUid: string;
|
|
1867
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1868
|
+
};
|
|
1869
|
+
delete: (requestExample: import("@scalar/oas-utils/entities/spec").RequestExample) => void;
|
|
1870
|
+
set: (item: {
|
|
1871
|
+
type: "requestExample";
|
|
1872
|
+
uid: string;
|
|
1873
|
+
name: string;
|
|
1876
1874
|
parameters: {
|
|
1877
1875
|
path: {
|
|
1878
1876
|
value: string;
|
|
@@ -1935,14 +1933,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1935
1933
|
nullable?: boolean | undefined;
|
|
1936
1934
|
}[];
|
|
1937
1935
|
};
|
|
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
1936
|
body: {
|
|
1945
|
-
activeBody: "
|
|
1937
|
+
activeBody: "binary" | "formData" | "raw";
|
|
1938
|
+
binary?: Blob | undefined;
|
|
1946
1939
|
formData?: {
|
|
1947
1940
|
value: {
|
|
1948
1941
|
value: string;
|
|
@@ -1961,13 +1954,18 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
1961
1954
|
}[];
|
|
1962
1955
|
encoding: "form-data" | "urlencoded";
|
|
1963
1956
|
} | undefined;
|
|
1964
|
-
binary?: Blob | undefined;
|
|
1965
1957
|
raw?: {
|
|
1966
1958
|
value: string;
|
|
1967
1959
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
1968
1960
|
} | undefined;
|
|
1969
1961
|
};
|
|
1970
1962
|
requestUid: string;
|
|
1963
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
1964
|
+
}) => void;
|
|
1965
|
+
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" ? {
|
|
1966
|
+
type: "requestExample";
|
|
1967
|
+
uid: string;
|
|
1968
|
+
name: string;
|
|
1971
1969
|
parameters: {
|
|
1972
1970
|
path: {
|
|
1973
1971
|
value: string;
|
|
@@ -2030,13 +2028,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2030
2028
|
nullable?: boolean | undefined;
|
|
2031
2029
|
}[];
|
|
2032
2030
|
};
|
|
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
2031
|
body: {
|
|
2039
|
-
activeBody: "
|
|
2032
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2033
|
+
binary?: Blob | undefined;
|
|
2040
2034
|
formData?: {
|
|
2041
2035
|
value: {
|
|
2042
2036
|
value: string;
|
|
@@ -2055,13 +2049,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2055
2049
|
}[];
|
|
2056
2050
|
encoding: "form-data" | "urlencoded";
|
|
2057
2051
|
} | undefined;
|
|
2058
|
-
binary?: Blob | undefined;
|
|
2059
2052
|
raw?: {
|
|
2060
2053
|
value: string;
|
|
2061
2054
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2062
2055
|
} | undefined;
|
|
2063
2056
|
};
|
|
2064
2057
|
requestUid: string;
|
|
2058
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2059
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
|
|
2060
|
+
type: "requestExample";
|
|
2061
|
+
uid: string;
|
|
2062
|
+
name: string;
|
|
2065
2063
|
parameters: {
|
|
2066
2064
|
path: {
|
|
2067
2065
|
value: string;
|
|
@@ -2124,13 +2122,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2124
2122
|
nullable?: boolean | undefined;
|
|
2125
2123
|
}[];
|
|
2126
2124
|
};
|
|
2127
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2128
|
-
}[K]> ? PathValue<{
|
|
2129
|
-
type: "requestExample";
|
|
2130
|
-
uid: string;
|
|
2131
|
-
name: string;
|
|
2132
2125
|
body: {
|
|
2133
|
-
activeBody: "
|
|
2126
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2127
|
+
binary?: Blob | undefined;
|
|
2134
2128
|
formData?: {
|
|
2135
2129
|
value: {
|
|
2136
2130
|
value: string;
|
|
@@ -2149,13 +2143,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2149
2143
|
}[];
|
|
2150
2144
|
encoding: "form-data" | "urlencoded";
|
|
2151
2145
|
} | undefined;
|
|
2152
|
-
binary?: Blob | undefined;
|
|
2153
2146
|
raw?: {
|
|
2154
2147
|
value: string;
|
|
2155
2148
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2156
2149
|
} | undefined;
|
|
2157
2150
|
};
|
|
2158
2151
|
requestUid: string;
|
|
2152
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2153
|
+
}[K]> ? PathValue<{
|
|
2154
|
+
type: "requestExample";
|
|
2155
|
+
uid: string;
|
|
2156
|
+
name: string;
|
|
2159
2157
|
parameters: {
|
|
2160
2158
|
path: {
|
|
2161
2159
|
value: string;
|
|
@@ -2218,14 +2216,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2218
2216
|
nullable?: boolean | undefined;
|
|
2219
2217
|
}[];
|
|
2220
2218
|
};
|
|
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
2219
|
body: {
|
|
2228
|
-
activeBody: "
|
|
2220
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2221
|
+
binary?: Blob | undefined;
|
|
2229
2222
|
formData?: {
|
|
2230
2223
|
value: {
|
|
2231
2224
|
value: string;
|
|
@@ -2244,13 +2237,18 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2244
2237
|
}[];
|
|
2245
2238
|
encoding: "form-data" | "urlencoded";
|
|
2246
2239
|
} | undefined;
|
|
2247
|
-
binary?: Blob | undefined;
|
|
2248
2240
|
raw?: {
|
|
2249
2241
|
value: string;
|
|
2250
2242
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2251
2243
|
} | undefined;
|
|
2252
2244
|
};
|
|
2253
2245
|
requestUid: string;
|
|
2246
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2247
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2248
|
+
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" ? {
|
|
2249
|
+
type: "requestExample";
|
|
2250
|
+
uid: string;
|
|
2251
|
+
name: string;
|
|
2254
2252
|
parameters: {
|
|
2255
2253
|
path: {
|
|
2256
2254
|
value: string;
|
|
@@ -2313,13 +2311,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2313
2311
|
nullable?: boolean | undefined;
|
|
2314
2312
|
}[];
|
|
2315
2313
|
};
|
|
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
2314
|
body: {
|
|
2322
|
-
activeBody: "
|
|
2315
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2316
|
+
binary?: Blob | undefined;
|
|
2323
2317
|
formData?: {
|
|
2324
2318
|
value: {
|
|
2325
2319
|
value: string;
|
|
@@ -2338,13 +2332,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2338
2332
|
}[];
|
|
2339
2333
|
encoding: "form-data" | "urlencoded";
|
|
2340
2334
|
} | undefined;
|
|
2341
|
-
binary?: Blob | undefined;
|
|
2342
2335
|
raw?: {
|
|
2343
2336
|
value: string;
|
|
2344
2337
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2345
2338
|
} | undefined;
|
|
2346
2339
|
};
|
|
2347
2340
|
requestUid: string;
|
|
2341
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2342
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path<{
|
|
2343
|
+
type: "requestExample";
|
|
2344
|
+
uid: string;
|
|
2345
|
+
name: string;
|
|
2348
2346
|
parameters: {
|
|
2349
2347
|
path: {
|
|
2350
2348
|
value: string;
|
|
@@ -2407,13 +2405,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2407
2405
|
nullable?: boolean | undefined;
|
|
2408
2406
|
}[];
|
|
2409
2407
|
};
|
|
2410
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
2411
|
-
}[K]> ? PathValue<{
|
|
2412
|
-
type: "requestExample";
|
|
2413
|
-
uid: string;
|
|
2414
|
-
name: string;
|
|
2415
2408
|
body: {
|
|
2416
|
-
activeBody: "
|
|
2409
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2410
|
+
binary?: Blob | undefined;
|
|
2417
2411
|
formData?: {
|
|
2418
2412
|
value: {
|
|
2419
2413
|
value: string;
|
|
@@ -2432,13 +2426,17 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2432
2426
|
}[];
|
|
2433
2427
|
encoding: "form-data" | "urlencoded";
|
|
2434
2428
|
} | undefined;
|
|
2435
|
-
binary?: Blob | undefined;
|
|
2436
2429
|
raw?: {
|
|
2437
2430
|
value: string;
|
|
2438
2431
|
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2439
2432
|
} | undefined;
|
|
2440
2433
|
};
|
|
2441
2434
|
requestUid: string;
|
|
2435
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
2436
|
+
}[K]> ? PathValue<{
|
|
2437
|
+
type: "requestExample";
|
|
2438
|
+
uid: string;
|
|
2439
|
+
name: string;
|
|
2442
2440
|
parameters: {
|
|
2443
2441
|
path: {
|
|
2444
2442
|
value: string;
|
|
@@ -2501,6 +2499,33 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
2501
2499
|
nullable?: boolean | undefined;
|
|
2502
2500
|
}[];
|
|
2503
2501
|
};
|
|
2502
|
+
body: {
|
|
2503
|
+
activeBody: "binary" | "formData" | "raw";
|
|
2504
|
+
binary?: Blob | undefined;
|
|
2505
|
+
formData?: {
|
|
2506
|
+
value: {
|
|
2507
|
+
value: string;
|
|
2508
|
+
key: string;
|
|
2509
|
+
enabled: boolean;
|
|
2510
|
+
minimum?: number | undefined;
|
|
2511
|
+
type?: string | undefined;
|
|
2512
|
+
maximum?: number | undefined;
|
|
2513
|
+
default?: any;
|
|
2514
|
+
required?: boolean | undefined;
|
|
2515
|
+
description?: string | undefined;
|
|
2516
|
+
enum?: string[] | undefined;
|
|
2517
|
+
format?: string | undefined;
|
|
2518
|
+
file?: any;
|
|
2519
|
+
nullable?: boolean | undefined;
|
|
2520
|
+
}[];
|
|
2521
|
+
encoding: "form-data" | "urlencoded";
|
|
2522
|
+
} | undefined;
|
|
2523
|
+
raw?: {
|
|
2524
|
+
value: string;
|
|
2525
|
+
encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
|
|
2526
|
+
} | undefined;
|
|
2527
|
+
};
|
|
2528
|
+
requestUid: string;
|
|
2504
2529
|
serverVariables?: Record<string, string[]> | undefined;
|
|
2505
2530
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2506
2531
|
undo: (uid: string) => void;
|
|
@@ -3291,6 +3316,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3291
3316
|
'x-scalar-children'?: {
|
|
3292
3317
|
tagName: string;
|
|
3293
3318
|
}[] | undefined;
|
|
3319
|
+
'x-internal'?: boolean | undefined;
|
|
3320
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3294
3321
|
}) => void;
|
|
3295
3322
|
add: (payload: import("@scalar/oas-utils/entities/spec").TagPayload, collectionUid: string) => void | {
|
|
3296
3323
|
type: "tag";
|
|
@@ -3305,6 +3332,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3305
3332
|
'x-scalar-children'?: {
|
|
3306
3333
|
tagName: string;
|
|
3307
3334
|
}[] | undefined;
|
|
3335
|
+
'x-internal'?: boolean | undefined;
|
|
3336
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3308
3337
|
};
|
|
3309
3338
|
delete: (tag: import("@scalar/oas-utils/entities/spec").Tag, collectionUid: string) => void;
|
|
3310
3339
|
set: (item: {
|
|
@@ -3320,8 +3349,10 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3320
3349
|
'x-scalar-children'?: {
|
|
3321
3350
|
tagName: string;
|
|
3322
3351
|
}[] | undefined;
|
|
3352
|
+
'x-internal'?: boolean | undefined;
|
|
3353
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3323
3354
|
}) => 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" ? {
|
|
3355
|
+
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
3356
|
type: "tag";
|
|
3326
3357
|
uid: string;
|
|
3327
3358
|
name: string;
|
|
@@ -3334,7 +3365,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3334
3365
|
'x-scalar-children'?: {
|
|
3335
3366
|
tagName: string;
|
|
3336
3367
|
}[] | undefined;
|
|
3337
|
-
|
|
3368
|
+
'x-internal'?: boolean | undefined;
|
|
3369
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3370
|
+
}[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
3371
|
type: "tag";
|
|
3339
3372
|
uid: string;
|
|
3340
3373
|
name: string;
|
|
@@ -3347,6 +3380,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3347
3380
|
'x-scalar-children'?: {
|
|
3348
3381
|
tagName: string;
|
|
3349
3382
|
}[] | undefined;
|
|
3383
|
+
'x-internal'?: boolean | undefined;
|
|
3384
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3350
3385
|
}[K]> ? PathValue<{
|
|
3351
3386
|
type: "tag";
|
|
3352
3387
|
uid: string;
|
|
@@ -3360,8 +3395,10 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3360
3395
|
'x-scalar-children'?: {
|
|
3361
3396
|
tagName: string;
|
|
3362
3397
|
}[] | undefined;
|
|
3398
|
+
'x-internal'?: boolean | undefined;
|
|
3399
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3363
3400
|
}[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" ? {
|
|
3401
|
+
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
3402
|
type: "tag";
|
|
3366
3403
|
uid: string;
|
|
3367
3404
|
name: string;
|
|
@@ -3374,7 +3411,9 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3374
3411
|
'x-scalar-children'?: {
|
|
3375
3412
|
tagName: string;
|
|
3376
3413
|
}[] | undefined;
|
|
3377
|
-
|
|
3414
|
+
'x-internal'?: boolean | undefined;
|
|
3415
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3416
|
+
}[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
3417
|
type: "tag";
|
|
3379
3418
|
uid: string;
|
|
3380
3419
|
name: string;
|
|
@@ -3387,6 +3426,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3387
3426
|
'x-scalar-children'?: {
|
|
3388
3427
|
tagName: string;
|
|
3389
3428
|
}[] | undefined;
|
|
3429
|
+
'x-internal'?: boolean | undefined;
|
|
3430
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3390
3431
|
}[K]> ? PathValue<{
|
|
3391
3432
|
type: "tag";
|
|
3392
3433
|
uid: string;
|
|
@@ -3400,6 +3441,8 @@ export declare const createWorkspaceStore: ({ useLocalStorage, isReadOnly, showS
|
|
|
3400
3441
|
'x-scalar-children'?: {
|
|
3401
3442
|
tagName: string;
|
|
3402
3443
|
}[] | undefined;
|
|
3444
|
+
'x-internal'?: boolean | undefined;
|
|
3445
|
+
'x-scalar-ignore'?: boolean | undefined;
|
|
3403
3446
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3404
3447
|
undo: (uid: string) => void;
|
|
3405
3448
|
redo: (uid: string) => void;
|