@scalar/api-client 2.6.1 → 2.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +77 -0
- package/README.md +1 -1
- package/dist/analytics.d.ts +2 -18
- package/dist/analytics.d.ts.map +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +66 -42
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTableInputSelect.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTableInputSelect.vue.js +21 -22
- package/dist/components/EnvironmentSelector/EnvironmentSelector.vue.d.ts.map +1 -1
- package/dist/components/EnvironmentSelector/EnvironmentSelector.vue.js +4 -5
- package/dist/components/HttpMethod/HttpMethod.vue.d.ts +2 -2
- package/dist/components/ImportCollection/WorkspaceSelector.vue.d.ts.map +1 -1
- package/dist/components/ImportCollection/WorkspaceSelector.vue.js +13 -14
- package/dist/components/Sidebar/SidebarButton.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/SidebarButton.vue.js +0 -1
- package/dist/hooks/useAnalytics.d.ts +2 -18
- package/dist/hooks/useAnalytics.d.ts.map +1 -1
- package/dist/hooks/useClientConfig.d.ts +114 -120
- package/dist/hooks/useClientConfig.d.ts.map +1 -1
- package/dist/hooks/useResponseBody.js +6 -6
- package/dist/layouts/App/create-api-client-app.d.ts +1379 -1307
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +2754 -2610
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +1379 -1307
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +1379 -1307
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/find-request.d.ts +17 -17
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/hot-keys.d.ts +1 -1
- package/dist/libs/local-storage.d.ts.map +1 -1
- package/dist/libs/send-request/build-request-security.d.ts +1 -1
- package/dist/libs/send-request/create-fetch-body.d.ts +1 -1
- package/dist/libs/send-request/create-request-operation.d.ts +2 -2
- package/dist/libs/send-request/create-request-operation.d.ts.map +1 -1
- package/dist/libs/send-request/create-request-operation.js +19 -19
- package/dist/libs/send-request/create-request-operation.test.d.ts +82 -82
- package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
- package/dist/plugins/plugin-manager.d.ts +3 -3
- package/dist/plugins/plugin-manager.d.ts.map +1 -1
- package/dist/store/active-entities.d.ts +118 -118
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +127 -127
- package/dist/store/collections.d.ts.map +1 -1
- package/dist/store/cookies.d.ts +14 -14
- package/dist/store/environment.d.ts +23 -23
- package/dist/store/request-example.d.ts +546 -546
- package/dist/store/request-example.d.ts.map +1 -1
- package/dist/store/requests.d.ts +194 -194
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/security-schemes.d.ts +281 -281
- package/dist/store/security-schemes.d.ts.map +1 -1
- package/dist/store/servers.d.ts +45 -45
- package/dist/store/servers.d.ts.map +1 -1
- package/dist/store/store.d.ts +1379 -1307
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/store.js +18 -18
- package/dist/store/tags.d.ts +35 -35
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/store/workspace.d.ts +47 -47
- package/dist/store/workspace.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/v2/blocks/operation-code-sample/components/ExamplePicker.vue.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/components/ExamplePicker.vue.js +2 -3
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.test.d.ts +2 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.test.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.d.ts +25 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.js +30 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue2.js +4 -0
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.js +3 -3
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue2.js +104 -98
- package/dist/v2/blocks/operation-code-sample/helpers/find-client.js +16 -14
- package/dist/v2/blocks/operation-code-sample/helpers/generate-client-options.js +31 -2
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.d.ts +6 -1
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.js +198 -131
- package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.bench.d.ts +2 -0
- package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.bench.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/index.d.ts +4 -1
- package/dist/v2/blocks/operation-code-sample/index.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/index.js +10 -4
- package/dist/v2/blocks/scalar-auth-selector-block/components/AuthSelector.vue.d.ts.map +1 -1
- package/dist/v2/blocks/scalar-auth-selector-block/components/AuthSelector.vue.js +1 -1
- package/dist/v2/blocks/scalar-auth-selector-block/components/AuthSelector.vue2.js +31 -32
- package/dist/v2/blocks/scalar-auth-selector-block/helpers/security-scheme.d.ts +2 -6
- package/dist/v2/blocks/scalar-auth-selector-block/helpers/security-scheme.d.ts.map +1 -1
- package/dist/v2/blocks/scalar-operation-block/components/OperationBlock.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBlock.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBlock.vue.d.ts +39 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBlock.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBlock.vue.js +7 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBlock.vue2.js +226 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBody.vue.d.ts +66 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBody.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBody.vue.js +7 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationBody.vue2.js +200 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationParams.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationParams.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationParams.vue.d.ts +51 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationParams.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationParams.vue.js +89 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationParams.vue2.js +4 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTable.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTable.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTable.vue.d.ts +46 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTable.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTable.vue.js +7 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTable.vue2.js +85 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableRow.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableRow.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableRow.vue.d.ts +43 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableRow.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableRow.vue.js +193 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableRow.vue2.js +4 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableTooltip.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableTooltip.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableTooltip.vue.d.ts +8 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableTooltip.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableTooltip.vue.js +7 -0
- package/dist/v2/blocks/scalar-operation-block/components/OperationTableTooltip.vue2.js +62 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/file.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/file.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/files.d.ts +5 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/files.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/files.js +7 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-content.d.ts +8 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-content.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-content.js +9 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-content.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-content.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-example.d.ts +6 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-example.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-example.js +12 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-example.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-example.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-schema.d.ts +6 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-schema.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-schema.js +6 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-schema.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-parameter-schema.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-request-body-example.d.ts +3 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-request-body-example.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/get-request-body-example.js +5 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/group-by.d.ts +5 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/group-by.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/group-by.js +7 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/group-by.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/group-by.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/validate-parameter.d.ts +11 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/validate-parameter.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/validate-parameter.js +32 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/validate-parameter.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/helpers/validate-parameter.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/index.d.ts +2 -0
- package/dist/v2/blocks/scalar-operation-block/index.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-operation-block/index.js +4 -0
- package/dist/v2/blocks/scalar-response-block/components/Headers.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/components/Headers.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/Headers.vue.d.ts +20 -0
- package/dist/v2/blocks/scalar-response-block/components/Headers.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/Headers.vue.js +98 -0
- package/dist/v2/blocks/scalar-response-block/components/Headers.vue2.js +4 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBlock.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBlock.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBlock.vue.d.ts +47 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBlock.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBlock.vue.js +7 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBlock.vue2.js +182 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBody.vue.d.ts +12 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBody.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBody.vue.js +7 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBody.vue2.js +88 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyDownload.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyDownload.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyDownload.vue.d.ts +8 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyDownload.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyDownload.vue.js +36 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyDownload.vue2.js +4 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyInfo.vue.d.ts +13 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyInfo.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyInfo.vue.js +14 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyPreview.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyPreview.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyPreview.vue.d.ts +10 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyPreview.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyPreview.vue.js +7 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyPreview.vue2.js +64 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyRaw.vue.d.ts +8 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyRaw.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyRaw.vue.js +7 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyRaw.vue2.js +41 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyStreaming.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyStreaming.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyStreaming.vue.d.ts +6 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyStreaming.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyStreaming.vue.js +74 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyStreaming.vue2.js +4 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyToggle.vue.d.ts +10 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyToggle.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyToggle.vue.js +25 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyToggle.vue2.js +4 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyVirtual.vue.d.ts +11 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyVirtual.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyVirtual.vue.js +52 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseBodyVirtual.vue3.js +5 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseCookies.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseCookies.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseCookies.vue.d.ts +9 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseCookies.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseCookies.vue.js +54 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseCookies.vue2.js +4 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseEmpty.vue.d.ts +23 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseEmpty.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseEmpty.vue.js +7 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseEmpty.vue2.js +88 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseLoadingOverlay.vue.d.ts +8 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseLoadingOverlay.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseLoadingOverlay.vue.js +7 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseLoadingOverlay.vue2.js +41 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseMetaInformation.vue.d.ts +10 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseMetaInformation.vue.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseMetaInformation.vue.js +61 -0
- package/dist/v2/blocks/scalar-response-block/components/ResponseMetaInformation.vue2.js +4 -0
- package/dist/v2/blocks/scalar-response-block/helpers/extract-filename.d.ts +5 -0
- package/dist/v2/blocks/scalar-response-block/helpers/extract-filename.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/extract-filename.js +18 -0
- package/dist/v2/blocks/scalar-response-block/helpers/extract-filename.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/helpers/extract-filename.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/get-content-length.d.ts +4 -0
- package/dist/v2/blocks/scalar-response-block/helpers/get-content-length.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/get-content-length.js +12 -0
- package/dist/v2/blocks/scalar-response-block/helpers/get-content-length.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/helpers/get-content-length.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/media-types.d.ts +20 -0
- package/dist/v2/blocks/scalar-response-block/helpers/media-types.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/media-types.js +127 -0
- package/dist/v2/blocks/scalar-response-block/helpers/media-types.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/helpers/media-types.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/process-response-body.d.ts +17 -0
- package/dist/v2/blocks/scalar-response-block/helpers/process-response-body.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/helpers/process-response-body.js +16 -0
- package/dist/v2/blocks/scalar-response-block/helpers/process-response-body.test.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/helpers/process-response-body.test.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/index.d.ts +2 -0
- package/dist/v2/blocks/scalar-response-block/index.d.ts.map +1 -0
- package/dist/v2/blocks/scalar-response-block/index.js +4 -0
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts +54 -54
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue2.js +31 -32
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts +54 -54
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestBody.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestBody.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestBody.vue2.js +0 -1
- package/dist/views/Request/RequestSection/RequestCodeExample.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestCodeExample.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestCodeExample.vue2.js +13 -14
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/components/WorkspaceDropdown.vue.d.ts.map +1 -1
- package/dist/views/Request/components/WorkspaceDropdown.vue.js +5 -6
- package/dist/views/Request/libs/auth.d.ts +2 -2
- package/dist/views/Request/libs/watch-mode.d.ts +4 -4
- package/dist/views/Request/libs/watch-mode.d.ts.map +1 -1
- package/dist/views/Request/libs/watch-mode.js +241 -186
- package/package.json +21 -16
|
@@ -3,1018 +3,1018 @@ import { type Request, type RequestExample } from '@scalar/oas-utils/entities/sp
|
|
|
3
3
|
/** Create top level examples storage for the workspace */
|
|
4
4
|
export declare function createStoreRequestExamples(useLocalStorage: boolean): {
|
|
5
5
|
requestExamples: Record<string, {
|
|
6
|
-
uid: string & import("zod")
|
|
7
|
-
name: string;
|
|
6
|
+
uid: string & import("zod").$brand<"example">;
|
|
8
7
|
type: "requestExample";
|
|
8
|
+
name: string;
|
|
9
|
+
body: {
|
|
10
|
+
activeBody: "raw" | "formData" | "binary";
|
|
11
|
+
raw?: {
|
|
12
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
13
|
+
value: string;
|
|
14
|
+
mimeType?: string | undefined;
|
|
15
|
+
} | undefined;
|
|
16
|
+
formData?: {
|
|
17
|
+
encoding: "form-data" | "urlencoded";
|
|
18
|
+
value: {
|
|
19
|
+
key: string;
|
|
20
|
+
value: string;
|
|
21
|
+
enabled: boolean;
|
|
22
|
+
file?: any;
|
|
23
|
+
description?: string | undefined;
|
|
24
|
+
required?: boolean | undefined;
|
|
25
|
+
enum?: string[] | undefined;
|
|
26
|
+
examples?: any[] | undefined;
|
|
27
|
+
type?: string | string[] | undefined;
|
|
28
|
+
format?: string | undefined;
|
|
29
|
+
minimum?: number | undefined;
|
|
30
|
+
maximum?: number | undefined;
|
|
31
|
+
default?: any;
|
|
32
|
+
nullable?: boolean | undefined;
|
|
33
|
+
}[];
|
|
34
|
+
} | undefined;
|
|
35
|
+
binary?: Blob | undefined;
|
|
36
|
+
};
|
|
9
37
|
parameters: {
|
|
10
38
|
path: {
|
|
11
|
-
value: string;
|
|
12
39
|
key: string;
|
|
40
|
+
value: string;
|
|
13
41
|
enabled: boolean;
|
|
14
|
-
|
|
15
|
-
type?: string | string[] | undefined;
|
|
16
|
-
maximum?: number | undefined;
|
|
42
|
+
file?: any;
|
|
17
43
|
description?: string | undefined;
|
|
18
|
-
default?: any;
|
|
19
44
|
required?: boolean | undefined;
|
|
20
45
|
enum?: string[] | undefined;
|
|
21
46
|
examples?: any[] | undefined;
|
|
22
|
-
|
|
47
|
+
type?: string | string[] | undefined;
|
|
23
48
|
format?: string | undefined;
|
|
24
|
-
|
|
49
|
+
minimum?: number | undefined;
|
|
50
|
+
maximum?: number | undefined;
|
|
51
|
+
default?: any;
|
|
52
|
+
nullable?: boolean | undefined;
|
|
25
53
|
}[];
|
|
26
|
-
|
|
27
|
-
value: string;
|
|
54
|
+
query: {
|
|
28
55
|
key: string;
|
|
56
|
+
value: string;
|
|
29
57
|
enabled: boolean;
|
|
30
|
-
|
|
31
|
-
type?: string | string[] | undefined;
|
|
32
|
-
maximum?: number | undefined;
|
|
58
|
+
file?: any;
|
|
33
59
|
description?: string | undefined;
|
|
34
|
-
default?: any;
|
|
35
60
|
required?: boolean | undefined;
|
|
36
61
|
enum?: string[] | undefined;
|
|
37
62
|
examples?: any[] | undefined;
|
|
38
|
-
|
|
63
|
+
type?: string | string[] | undefined;
|
|
39
64
|
format?: string | undefined;
|
|
40
|
-
|
|
65
|
+
minimum?: number | undefined;
|
|
66
|
+
maximum?: number | undefined;
|
|
67
|
+
default?: any;
|
|
68
|
+
nullable?: boolean | undefined;
|
|
41
69
|
}[];
|
|
42
|
-
|
|
43
|
-
value: string;
|
|
70
|
+
headers: {
|
|
44
71
|
key: string;
|
|
72
|
+
value: string;
|
|
45
73
|
enabled: boolean;
|
|
46
|
-
|
|
47
|
-
type?: string | string[] | undefined;
|
|
48
|
-
maximum?: number | undefined;
|
|
74
|
+
file?: any;
|
|
49
75
|
description?: string | undefined;
|
|
50
|
-
default?: any;
|
|
51
76
|
required?: boolean | undefined;
|
|
52
77
|
enum?: string[] | undefined;
|
|
53
78
|
examples?: any[] | undefined;
|
|
54
|
-
|
|
79
|
+
type?: string | string[] | undefined;
|
|
55
80
|
format?: string | undefined;
|
|
56
|
-
|
|
81
|
+
minimum?: number | undefined;
|
|
82
|
+
maximum?: number | undefined;
|
|
83
|
+
default?: any;
|
|
84
|
+
nullable?: boolean | undefined;
|
|
57
85
|
}[];
|
|
58
86
|
cookies: {
|
|
59
|
-
value: string;
|
|
60
87
|
key: string;
|
|
88
|
+
value: string;
|
|
61
89
|
enabled: boolean;
|
|
62
|
-
|
|
63
|
-
type?: string | string[] | undefined;
|
|
64
|
-
maximum?: number | undefined;
|
|
90
|
+
file?: any;
|
|
65
91
|
description?: string | undefined;
|
|
66
|
-
default?: any;
|
|
67
92
|
required?: boolean | undefined;
|
|
68
93
|
enum?: string[] | undefined;
|
|
69
94
|
examples?: any[] | undefined;
|
|
70
|
-
|
|
95
|
+
type?: string | string[] | undefined;
|
|
71
96
|
format?: string | undefined;
|
|
72
|
-
|
|
97
|
+
minimum?: number | undefined;
|
|
98
|
+
maximum?: number | undefined;
|
|
99
|
+
default?: any;
|
|
100
|
+
nullable?: boolean | undefined;
|
|
73
101
|
}[];
|
|
74
102
|
};
|
|
75
|
-
|
|
76
|
-
activeBody: "binary" | "formData" | "raw";
|
|
77
|
-
binary?: Blob | undefined;
|
|
78
|
-
formData?: {
|
|
79
|
-
value: {
|
|
80
|
-
value: string;
|
|
81
|
-
key: string;
|
|
82
|
-
enabled: boolean;
|
|
83
|
-
minimum?: number | undefined;
|
|
84
|
-
type?: string | string[] | undefined;
|
|
85
|
-
maximum?: number | undefined;
|
|
86
|
-
description?: string | undefined;
|
|
87
|
-
default?: any;
|
|
88
|
-
required?: boolean | undefined;
|
|
89
|
-
enum?: string[] | undefined;
|
|
90
|
-
examples?: any[] | undefined;
|
|
91
|
-
nullable?: boolean | undefined;
|
|
92
|
-
format?: string | undefined;
|
|
93
|
-
file?: any;
|
|
94
|
-
}[];
|
|
95
|
-
encoding: "form-data" | "urlencoded";
|
|
96
|
-
} | undefined;
|
|
97
|
-
raw?: {
|
|
98
|
-
value: string;
|
|
99
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
100
|
-
mimeType?: string | undefined;
|
|
101
|
-
} | undefined;
|
|
102
|
-
};
|
|
103
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
103
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
104
104
|
serverVariables?: Record<string, string[]> | undefined;
|
|
105
105
|
}>;
|
|
106
106
|
requestExampleMutators: {
|
|
107
107
|
add: (item: {
|
|
108
|
-
uid: string & import("zod")
|
|
109
|
-
name: string;
|
|
108
|
+
uid: string & import("zod").$brand<"example">;
|
|
110
109
|
type: "requestExample";
|
|
110
|
+
name: string;
|
|
111
|
+
body: {
|
|
112
|
+
activeBody: "raw" | "formData" | "binary";
|
|
113
|
+
raw?: {
|
|
114
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
115
|
+
value: string;
|
|
116
|
+
mimeType?: string | undefined;
|
|
117
|
+
} | undefined;
|
|
118
|
+
formData?: {
|
|
119
|
+
encoding: "form-data" | "urlencoded";
|
|
120
|
+
value: {
|
|
121
|
+
key: string;
|
|
122
|
+
value: string;
|
|
123
|
+
enabled: boolean;
|
|
124
|
+
file?: any;
|
|
125
|
+
description?: string | undefined;
|
|
126
|
+
required?: boolean | undefined;
|
|
127
|
+
enum?: string[] | undefined;
|
|
128
|
+
examples?: any[] | undefined;
|
|
129
|
+
type?: string | string[] | undefined;
|
|
130
|
+
format?: string | undefined;
|
|
131
|
+
minimum?: number | undefined;
|
|
132
|
+
maximum?: number | undefined;
|
|
133
|
+
default?: any;
|
|
134
|
+
nullable?: boolean | undefined;
|
|
135
|
+
}[];
|
|
136
|
+
} | undefined;
|
|
137
|
+
binary?: Blob | undefined;
|
|
138
|
+
};
|
|
111
139
|
parameters: {
|
|
112
140
|
path: {
|
|
113
|
-
value: string;
|
|
114
141
|
key: string;
|
|
142
|
+
value: string;
|
|
115
143
|
enabled: boolean;
|
|
116
|
-
|
|
117
|
-
type?: string | string[] | undefined;
|
|
118
|
-
maximum?: number | undefined;
|
|
144
|
+
file?: any;
|
|
119
145
|
description?: string | undefined;
|
|
120
|
-
default?: any;
|
|
121
146
|
required?: boolean | undefined;
|
|
122
147
|
enum?: string[] | undefined;
|
|
123
148
|
examples?: any[] | undefined;
|
|
124
|
-
|
|
149
|
+
type?: string | string[] | undefined;
|
|
125
150
|
format?: string | undefined;
|
|
126
|
-
|
|
151
|
+
minimum?: number | undefined;
|
|
152
|
+
maximum?: number | undefined;
|
|
153
|
+
default?: any;
|
|
154
|
+
nullable?: boolean | undefined;
|
|
127
155
|
}[];
|
|
128
|
-
|
|
129
|
-
value: string;
|
|
156
|
+
query: {
|
|
130
157
|
key: string;
|
|
158
|
+
value: string;
|
|
131
159
|
enabled: boolean;
|
|
132
|
-
|
|
133
|
-
type?: string | string[] | undefined;
|
|
134
|
-
maximum?: number | undefined;
|
|
160
|
+
file?: any;
|
|
135
161
|
description?: string | undefined;
|
|
136
|
-
default?: any;
|
|
137
162
|
required?: boolean | undefined;
|
|
138
163
|
enum?: string[] | undefined;
|
|
139
164
|
examples?: any[] | undefined;
|
|
140
|
-
|
|
165
|
+
type?: string | string[] | undefined;
|
|
141
166
|
format?: string | undefined;
|
|
142
|
-
|
|
167
|
+
minimum?: number | undefined;
|
|
168
|
+
maximum?: number | undefined;
|
|
169
|
+
default?: any;
|
|
170
|
+
nullable?: boolean | undefined;
|
|
143
171
|
}[];
|
|
144
|
-
|
|
145
|
-
value: string;
|
|
172
|
+
headers: {
|
|
146
173
|
key: string;
|
|
174
|
+
value: string;
|
|
147
175
|
enabled: boolean;
|
|
148
|
-
|
|
149
|
-
type?: string | string[] | undefined;
|
|
150
|
-
maximum?: number | undefined;
|
|
176
|
+
file?: any;
|
|
151
177
|
description?: string | undefined;
|
|
152
|
-
default?: any;
|
|
153
178
|
required?: boolean | undefined;
|
|
154
179
|
enum?: string[] | undefined;
|
|
155
180
|
examples?: any[] | undefined;
|
|
156
|
-
|
|
181
|
+
type?: string | string[] | undefined;
|
|
157
182
|
format?: string | undefined;
|
|
158
|
-
|
|
183
|
+
minimum?: number | undefined;
|
|
184
|
+
maximum?: number | undefined;
|
|
185
|
+
default?: any;
|
|
186
|
+
nullable?: boolean | undefined;
|
|
159
187
|
}[];
|
|
160
188
|
cookies: {
|
|
161
|
-
value: string;
|
|
162
189
|
key: string;
|
|
190
|
+
value: string;
|
|
163
191
|
enabled: boolean;
|
|
164
|
-
|
|
165
|
-
type?: string | string[] | undefined;
|
|
166
|
-
maximum?: number | undefined;
|
|
192
|
+
file?: any;
|
|
167
193
|
description?: string | undefined;
|
|
168
|
-
default?: any;
|
|
169
194
|
required?: boolean | undefined;
|
|
170
195
|
enum?: string[] | undefined;
|
|
171
196
|
examples?: any[] | undefined;
|
|
172
|
-
|
|
197
|
+
type?: string | string[] | undefined;
|
|
173
198
|
format?: string | undefined;
|
|
174
|
-
|
|
199
|
+
minimum?: number | undefined;
|
|
200
|
+
maximum?: number | undefined;
|
|
201
|
+
default?: any;
|
|
202
|
+
nullable?: boolean | undefined;
|
|
175
203
|
}[];
|
|
176
204
|
};
|
|
205
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
206
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
207
|
+
}) => void;
|
|
208
|
+
delete: (uid: (string & import("zod").$brand<"example">) | null | undefined) => void;
|
|
209
|
+
set: (item: {
|
|
210
|
+
uid: string & import("zod").$brand<"example">;
|
|
211
|
+
type: "requestExample";
|
|
212
|
+
name: string;
|
|
177
213
|
body: {
|
|
178
|
-
activeBody: "
|
|
179
|
-
|
|
214
|
+
activeBody: "raw" | "formData" | "binary";
|
|
215
|
+
raw?: {
|
|
216
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
217
|
+
value: string;
|
|
218
|
+
mimeType?: string | undefined;
|
|
219
|
+
} | undefined;
|
|
180
220
|
formData?: {
|
|
221
|
+
encoding: "form-data" | "urlencoded";
|
|
181
222
|
value: {
|
|
182
|
-
value: string;
|
|
183
223
|
key: string;
|
|
224
|
+
value: string;
|
|
184
225
|
enabled: boolean;
|
|
185
|
-
|
|
186
|
-
type?: string | string[] | undefined;
|
|
187
|
-
maximum?: number | undefined;
|
|
226
|
+
file?: any;
|
|
188
227
|
description?: string | undefined;
|
|
189
|
-
default?: any;
|
|
190
228
|
required?: boolean | undefined;
|
|
191
229
|
enum?: string[] | undefined;
|
|
192
230
|
examples?: any[] | undefined;
|
|
193
|
-
|
|
231
|
+
type?: string | string[] | undefined;
|
|
194
232
|
format?: string | undefined;
|
|
195
|
-
|
|
233
|
+
minimum?: number | undefined;
|
|
234
|
+
maximum?: number | undefined;
|
|
235
|
+
default?: any;
|
|
236
|
+
nullable?: boolean | undefined;
|
|
196
237
|
}[];
|
|
197
|
-
encoding: "form-data" | "urlencoded";
|
|
198
|
-
} | undefined;
|
|
199
|
-
raw?: {
|
|
200
|
-
value: string;
|
|
201
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
202
|
-
mimeType?: string | undefined;
|
|
203
238
|
} | undefined;
|
|
239
|
+
binary?: Blob | undefined;
|
|
204
240
|
};
|
|
205
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
206
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
207
|
-
}) => void;
|
|
208
|
-
delete: (uid: (string & import("zod").BRAND<"example">) | null | undefined) => void;
|
|
209
|
-
set: (item: {
|
|
210
|
-
uid: string & import("zod").BRAND<"example">;
|
|
211
|
-
name: string;
|
|
212
|
-
type: "requestExample";
|
|
213
241
|
parameters: {
|
|
214
242
|
path: {
|
|
215
|
-
value: string;
|
|
216
243
|
key: string;
|
|
244
|
+
value: string;
|
|
217
245
|
enabled: boolean;
|
|
218
|
-
|
|
219
|
-
type?: string | string[] | undefined;
|
|
220
|
-
maximum?: number | undefined;
|
|
246
|
+
file?: any;
|
|
221
247
|
description?: string | undefined;
|
|
222
|
-
default?: any;
|
|
223
248
|
required?: boolean | undefined;
|
|
224
249
|
enum?: string[] | undefined;
|
|
225
250
|
examples?: any[] | undefined;
|
|
226
|
-
|
|
251
|
+
type?: string | string[] | undefined;
|
|
227
252
|
format?: string | undefined;
|
|
228
|
-
|
|
253
|
+
minimum?: number | undefined;
|
|
254
|
+
maximum?: number | undefined;
|
|
255
|
+
default?: any;
|
|
256
|
+
nullable?: boolean | undefined;
|
|
229
257
|
}[];
|
|
230
|
-
|
|
231
|
-
value: string;
|
|
258
|
+
query: {
|
|
232
259
|
key: string;
|
|
260
|
+
value: string;
|
|
233
261
|
enabled: boolean;
|
|
234
|
-
|
|
235
|
-
type?: string | string[] | undefined;
|
|
236
|
-
maximum?: number | undefined;
|
|
262
|
+
file?: any;
|
|
237
263
|
description?: string | undefined;
|
|
238
|
-
default?: any;
|
|
239
264
|
required?: boolean | undefined;
|
|
240
265
|
enum?: string[] | undefined;
|
|
241
266
|
examples?: any[] | undefined;
|
|
242
|
-
|
|
267
|
+
type?: string | string[] | undefined;
|
|
243
268
|
format?: string | undefined;
|
|
244
|
-
|
|
269
|
+
minimum?: number | undefined;
|
|
270
|
+
maximum?: number | undefined;
|
|
271
|
+
default?: any;
|
|
272
|
+
nullable?: boolean | undefined;
|
|
245
273
|
}[];
|
|
246
|
-
|
|
247
|
-
value: string;
|
|
274
|
+
headers: {
|
|
248
275
|
key: string;
|
|
276
|
+
value: string;
|
|
249
277
|
enabled: boolean;
|
|
250
|
-
|
|
251
|
-
type?: string | string[] | undefined;
|
|
252
|
-
maximum?: number | undefined;
|
|
278
|
+
file?: any;
|
|
253
279
|
description?: string | undefined;
|
|
254
|
-
default?: any;
|
|
255
280
|
required?: boolean | undefined;
|
|
256
281
|
enum?: string[] | undefined;
|
|
257
282
|
examples?: any[] | undefined;
|
|
258
|
-
|
|
283
|
+
type?: string | string[] | undefined;
|
|
259
284
|
format?: string | undefined;
|
|
260
|
-
|
|
285
|
+
minimum?: number | undefined;
|
|
286
|
+
maximum?: number | undefined;
|
|
287
|
+
default?: any;
|
|
288
|
+
nullable?: boolean | undefined;
|
|
261
289
|
}[];
|
|
262
290
|
cookies: {
|
|
263
|
-
value: string;
|
|
264
291
|
key: string;
|
|
292
|
+
value: string;
|
|
265
293
|
enabled: boolean;
|
|
266
|
-
|
|
267
|
-
type?: string | string[] | undefined;
|
|
268
|
-
maximum?: number | undefined;
|
|
294
|
+
file?: any;
|
|
269
295
|
description?: string | undefined;
|
|
270
|
-
default?: any;
|
|
271
296
|
required?: boolean | undefined;
|
|
272
297
|
enum?: string[] | undefined;
|
|
273
298
|
examples?: any[] | undefined;
|
|
274
|
-
|
|
299
|
+
type?: string | string[] | undefined;
|
|
275
300
|
format?: string | undefined;
|
|
276
|
-
|
|
301
|
+
minimum?: number | undefined;
|
|
302
|
+
maximum?: number | undefined;
|
|
303
|
+
default?: any;
|
|
304
|
+
nullable?: boolean | undefined;
|
|
277
305
|
}[];
|
|
278
306
|
};
|
|
307
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
308
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
309
|
+
}) => void;
|
|
310
|
+
edit: <P extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.headers" | "parameters.cookies" | `parameters.cookies.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.enabled` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.format` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.enabled` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.format` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | "body.raw" | "body.formData" | "body.binary" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.bytes" | "body.binary.stream" | `serverVariables.${string}`>(uid: (string & import("zod").$brand<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? {
|
|
311
|
+
uid: string & import("zod").$brand<"example">;
|
|
312
|
+
type: "requestExample";
|
|
313
|
+
name: string;
|
|
279
314
|
body: {
|
|
280
|
-
activeBody: "
|
|
281
|
-
|
|
315
|
+
activeBody: "raw" | "formData" | "binary";
|
|
316
|
+
raw?: {
|
|
317
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
318
|
+
value: string;
|
|
319
|
+
mimeType?: string | undefined;
|
|
320
|
+
} | undefined;
|
|
282
321
|
formData?: {
|
|
322
|
+
encoding: "form-data" | "urlencoded";
|
|
283
323
|
value: {
|
|
284
|
-
value: string;
|
|
285
324
|
key: string;
|
|
325
|
+
value: string;
|
|
286
326
|
enabled: boolean;
|
|
287
|
-
|
|
288
|
-
type?: string | string[] | undefined;
|
|
289
|
-
maximum?: number | undefined;
|
|
327
|
+
file?: any;
|
|
290
328
|
description?: string | undefined;
|
|
291
|
-
default?: any;
|
|
292
329
|
required?: boolean | undefined;
|
|
293
330
|
enum?: string[] | undefined;
|
|
294
331
|
examples?: any[] | undefined;
|
|
295
|
-
|
|
332
|
+
type?: string | string[] | undefined;
|
|
296
333
|
format?: string | undefined;
|
|
297
|
-
|
|
334
|
+
minimum?: number | undefined;
|
|
335
|
+
maximum?: number | undefined;
|
|
336
|
+
default?: any;
|
|
337
|
+
nullable?: boolean | undefined;
|
|
298
338
|
}[];
|
|
299
|
-
encoding: "form-data" | "urlencoded";
|
|
300
|
-
} | undefined;
|
|
301
|
-
raw?: {
|
|
302
|
-
value: string;
|
|
303
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
304
|
-
mimeType?: string | undefined;
|
|
305
339
|
} | undefined;
|
|
340
|
+
binary?: Blob | undefined;
|
|
306
341
|
};
|
|
307
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
308
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
309
|
-
}) => void;
|
|
310
|
-
edit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.bytes" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
311
|
-
uid: string & import("zod").BRAND<"example">;
|
|
312
|
-
name: string;
|
|
313
|
-
type: "requestExample";
|
|
314
342
|
parameters: {
|
|
315
343
|
path: {
|
|
316
|
-
value: string;
|
|
317
344
|
key: string;
|
|
345
|
+
value: string;
|
|
318
346
|
enabled: boolean;
|
|
319
|
-
|
|
320
|
-
type?: string | string[] | undefined;
|
|
321
|
-
maximum?: number | undefined;
|
|
347
|
+
file?: any;
|
|
322
348
|
description?: string | undefined;
|
|
323
|
-
default?: any;
|
|
324
349
|
required?: boolean | undefined;
|
|
325
350
|
enum?: string[] | undefined;
|
|
326
351
|
examples?: any[] | undefined;
|
|
327
|
-
|
|
352
|
+
type?: string | string[] | undefined;
|
|
328
353
|
format?: string | undefined;
|
|
329
|
-
|
|
354
|
+
minimum?: number | undefined;
|
|
355
|
+
maximum?: number | undefined;
|
|
356
|
+
default?: any;
|
|
357
|
+
nullable?: boolean | undefined;
|
|
330
358
|
}[];
|
|
331
|
-
|
|
332
|
-
value: string;
|
|
359
|
+
query: {
|
|
333
360
|
key: string;
|
|
361
|
+
value: string;
|
|
334
362
|
enabled: boolean;
|
|
335
|
-
|
|
336
|
-
type?: string | string[] | undefined;
|
|
337
|
-
maximum?: number | undefined;
|
|
363
|
+
file?: any;
|
|
338
364
|
description?: string | undefined;
|
|
339
|
-
default?: any;
|
|
340
365
|
required?: boolean | undefined;
|
|
341
366
|
enum?: string[] | undefined;
|
|
342
367
|
examples?: any[] | undefined;
|
|
343
|
-
|
|
368
|
+
type?: string | string[] | undefined;
|
|
344
369
|
format?: string | undefined;
|
|
345
|
-
|
|
370
|
+
minimum?: number | undefined;
|
|
371
|
+
maximum?: number | undefined;
|
|
372
|
+
default?: any;
|
|
373
|
+
nullable?: boolean | undefined;
|
|
346
374
|
}[];
|
|
347
|
-
|
|
348
|
-
value: string;
|
|
375
|
+
headers: {
|
|
349
376
|
key: string;
|
|
377
|
+
value: string;
|
|
350
378
|
enabled: boolean;
|
|
351
|
-
|
|
352
|
-
type?: string | string[] | undefined;
|
|
353
|
-
maximum?: number | undefined;
|
|
379
|
+
file?: any;
|
|
354
380
|
description?: string | undefined;
|
|
355
|
-
default?: any;
|
|
356
381
|
required?: boolean | undefined;
|
|
357
382
|
enum?: string[] | undefined;
|
|
358
383
|
examples?: any[] | undefined;
|
|
359
|
-
|
|
384
|
+
type?: string | string[] | undefined;
|
|
360
385
|
format?: string | undefined;
|
|
361
|
-
|
|
386
|
+
minimum?: number | undefined;
|
|
387
|
+
maximum?: number | undefined;
|
|
388
|
+
default?: any;
|
|
389
|
+
nullable?: boolean | undefined;
|
|
362
390
|
}[];
|
|
363
391
|
cookies: {
|
|
364
|
-
value: string;
|
|
365
392
|
key: string;
|
|
393
|
+
value: string;
|
|
366
394
|
enabled: boolean;
|
|
367
|
-
|
|
368
|
-
type?: string | string[] | undefined;
|
|
369
|
-
maximum?: number | undefined;
|
|
395
|
+
file?: any;
|
|
370
396
|
description?: string | undefined;
|
|
371
|
-
default?: any;
|
|
372
397
|
required?: boolean | undefined;
|
|
373
398
|
enum?: string[] | undefined;
|
|
374
399
|
examples?: any[] | undefined;
|
|
375
|
-
|
|
400
|
+
type?: string | string[] | undefined;
|
|
376
401
|
format?: string | undefined;
|
|
377
|
-
|
|
402
|
+
minimum?: number | undefined;
|
|
403
|
+
maximum?: number | undefined;
|
|
404
|
+
default?: any;
|
|
405
|
+
nullable?: boolean | undefined;
|
|
378
406
|
}[];
|
|
379
407
|
};
|
|
408
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
409
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
410
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
411
|
+
uid: string & import("zod").$brand<"example">;
|
|
412
|
+
type: "requestExample";
|
|
413
|
+
name: string;
|
|
380
414
|
body: {
|
|
381
|
-
activeBody: "
|
|
382
|
-
|
|
415
|
+
activeBody: "raw" | "formData" | "binary";
|
|
416
|
+
raw?: {
|
|
417
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
418
|
+
value: string;
|
|
419
|
+
mimeType?: string | undefined;
|
|
420
|
+
} | undefined;
|
|
383
421
|
formData?: {
|
|
422
|
+
encoding: "form-data" | "urlencoded";
|
|
384
423
|
value: {
|
|
385
|
-
value: string;
|
|
386
424
|
key: string;
|
|
425
|
+
value: string;
|
|
387
426
|
enabled: boolean;
|
|
388
|
-
|
|
389
|
-
type?: string | string[] | undefined;
|
|
390
|
-
maximum?: number | undefined;
|
|
427
|
+
file?: any;
|
|
391
428
|
description?: string | undefined;
|
|
392
|
-
default?: any;
|
|
393
429
|
required?: boolean | undefined;
|
|
394
430
|
enum?: string[] | undefined;
|
|
395
431
|
examples?: any[] | undefined;
|
|
396
|
-
|
|
432
|
+
type?: string | string[] | undefined;
|
|
397
433
|
format?: string | undefined;
|
|
398
|
-
|
|
434
|
+
minimum?: number | undefined;
|
|
435
|
+
maximum?: number | undefined;
|
|
436
|
+
default?: any;
|
|
437
|
+
nullable?: boolean | undefined;
|
|
399
438
|
}[];
|
|
400
|
-
encoding: "form-data" | "urlencoded";
|
|
401
|
-
} | undefined;
|
|
402
|
-
raw?: {
|
|
403
|
-
value: string;
|
|
404
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
405
|
-
mimeType?: string | undefined;
|
|
406
439
|
} | undefined;
|
|
440
|
+
binary?: Blob | undefined;
|
|
407
441
|
};
|
|
408
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
409
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
410
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
411
|
-
uid: string & import("zod").BRAND<"example">;
|
|
412
|
-
name: string;
|
|
413
|
-
type: "requestExample";
|
|
414
442
|
parameters: {
|
|
415
443
|
path: {
|
|
416
|
-
value: string;
|
|
417
444
|
key: string;
|
|
445
|
+
value: string;
|
|
418
446
|
enabled: boolean;
|
|
419
|
-
|
|
420
|
-
type?: string | string[] | undefined;
|
|
421
|
-
maximum?: number | undefined;
|
|
447
|
+
file?: any;
|
|
422
448
|
description?: string | undefined;
|
|
423
|
-
default?: any;
|
|
424
449
|
required?: boolean | undefined;
|
|
425
450
|
enum?: string[] | undefined;
|
|
426
451
|
examples?: any[] | undefined;
|
|
427
|
-
|
|
452
|
+
type?: string | string[] | undefined;
|
|
428
453
|
format?: string | undefined;
|
|
429
|
-
|
|
454
|
+
minimum?: number | undefined;
|
|
455
|
+
maximum?: number | undefined;
|
|
456
|
+
default?: any;
|
|
457
|
+
nullable?: boolean | undefined;
|
|
430
458
|
}[];
|
|
431
|
-
|
|
432
|
-
value: string;
|
|
459
|
+
query: {
|
|
433
460
|
key: string;
|
|
461
|
+
value: string;
|
|
434
462
|
enabled: boolean;
|
|
435
|
-
|
|
436
|
-
type?: string | string[] | undefined;
|
|
437
|
-
maximum?: number | undefined;
|
|
463
|
+
file?: any;
|
|
438
464
|
description?: string | undefined;
|
|
439
|
-
default?: any;
|
|
440
465
|
required?: boolean | undefined;
|
|
441
466
|
enum?: string[] | undefined;
|
|
442
467
|
examples?: any[] | undefined;
|
|
443
|
-
|
|
468
|
+
type?: string | string[] | undefined;
|
|
444
469
|
format?: string | undefined;
|
|
445
|
-
|
|
470
|
+
minimum?: number | undefined;
|
|
471
|
+
maximum?: number | undefined;
|
|
472
|
+
default?: any;
|
|
473
|
+
nullable?: boolean | undefined;
|
|
446
474
|
}[];
|
|
447
|
-
|
|
448
|
-
value: string;
|
|
475
|
+
headers: {
|
|
449
476
|
key: string;
|
|
477
|
+
value: string;
|
|
450
478
|
enabled: boolean;
|
|
451
|
-
|
|
452
|
-
type?: string | string[] | undefined;
|
|
453
|
-
maximum?: number | undefined;
|
|
479
|
+
file?: any;
|
|
454
480
|
description?: string | undefined;
|
|
455
|
-
default?: any;
|
|
456
481
|
required?: boolean | undefined;
|
|
457
482
|
enum?: string[] | undefined;
|
|
458
483
|
examples?: any[] | undefined;
|
|
459
|
-
|
|
484
|
+
type?: string | string[] | undefined;
|
|
460
485
|
format?: string | undefined;
|
|
461
|
-
|
|
486
|
+
minimum?: number | undefined;
|
|
487
|
+
maximum?: number | undefined;
|
|
488
|
+
default?: any;
|
|
489
|
+
nullable?: boolean | undefined;
|
|
462
490
|
}[];
|
|
463
491
|
cookies: {
|
|
464
|
-
value: string;
|
|
465
492
|
key: string;
|
|
493
|
+
value: string;
|
|
466
494
|
enabled: boolean;
|
|
467
|
-
|
|
468
|
-
type?: string | string[] | undefined;
|
|
469
|
-
maximum?: number | undefined;
|
|
495
|
+
file?: any;
|
|
470
496
|
description?: string | undefined;
|
|
471
|
-
default?: any;
|
|
472
497
|
required?: boolean | undefined;
|
|
473
498
|
enum?: string[] | undefined;
|
|
474
499
|
examples?: any[] | undefined;
|
|
475
|
-
|
|
500
|
+
type?: string | string[] | undefined;
|
|
476
501
|
format?: string | undefined;
|
|
477
|
-
|
|
502
|
+
minimum?: number | undefined;
|
|
503
|
+
maximum?: number | undefined;
|
|
504
|
+
default?: any;
|
|
505
|
+
nullable?: boolean | undefined;
|
|
478
506
|
}[];
|
|
479
507
|
};
|
|
508
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
509
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
510
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
511
|
+
uid: string & import("zod").$brand<"example">;
|
|
512
|
+
type: "requestExample";
|
|
513
|
+
name: string;
|
|
480
514
|
body: {
|
|
481
|
-
activeBody: "
|
|
482
|
-
|
|
515
|
+
activeBody: "raw" | "formData" | "binary";
|
|
516
|
+
raw?: {
|
|
517
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
518
|
+
value: string;
|
|
519
|
+
mimeType?: string | undefined;
|
|
520
|
+
} | undefined;
|
|
483
521
|
formData?: {
|
|
522
|
+
encoding: "form-data" | "urlencoded";
|
|
484
523
|
value: {
|
|
485
|
-
value: string;
|
|
486
524
|
key: string;
|
|
525
|
+
value: string;
|
|
487
526
|
enabled: boolean;
|
|
488
|
-
|
|
489
|
-
type?: string | string[] | undefined;
|
|
490
|
-
maximum?: number | undefined;
|
|
527
|
+
file?: any;
|
|
491
528
|
description?: string | undefined;
|
|
492
|
-
default?: any;
|
|
493
529
|
required?: boolean | undefined;
|
|
494
530
|
enum?: string[] | undefined;
|
|
495
531
|
examples?: any[] | undefined;
|
|
496
|
-
|
|
532
|
+
type?: string | string[] | undefined;
|
|
497
533
|
format?: string | undefined;
|
|
498
|
-
|
|
534
|
+
minimum?: number | undefined;
|
|
535
|
+
maximum?: number | undefined;
|
|
536
|
+
default?: any;
|
|
537
|
+
nullable?: boolean | undefined;
|
|
499
538
|
}[];
|
|
500
|
-
encoding: "form-data" | "urlencoded";
|
|
501
|
-
} | undefined;
|
|
502
|
-
raw?: {
|
|
503
|
-
value: string;
|
|
504
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
505
|
-
mimeType?: string | undefined;
|
|
506
539
|
} | undefined;
|
|
540
|
+
binary?: Blob | undefined;
|
|
507
541
|
};
|
|
508
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
509
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
510
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
511
|
-
uid: string & import("zod").BRAND<"example">;
|
|
512
|
-
name: string;
|
|
513
|
-
type: "requestExample";
|
|
514
542
|
parameters: {
|
|
515
543
|
path: {
|
|
516
|
-
value: string;
|
|
517
544
|
key: string;
|
|
545
|
+
value: string;
|
|
518
546
|
enabled: boolean;
|
|
519
|
-
|
|
520
|
-
type?: string | string[] | undefined;
|
|
521
|
-
maximum?: number | undefined;
|
|
547
|
+
file?: any;
|
|
522
548
|
description?: string | undefined;
|
|
523
|
-
default?: any;
|
|
524
549
|
required?: boolean | undefined;
|
|
525
550
|
enum?: string[] | undefined;
|
|
526
551
|
examples?: any[] | undefined;
|
|
527
|
-
|
|
552
|
+
type?: string | string[] | undefined;
|
|
528
553
|
format?: string | undefined;
|
|
529
|
-
|
|
554
|
+
minimum?: number | undefined;
|
|
555
|
+
maximum?: number | undefined;
|
|
556
|
+
default?: any;
|
|
557
|
+
nullable?: boolean | undefined;
|
|
530
558
|
}[];
|
|
531
|
-
|
|
532
|
-
value: string;
|
|
559
|
+
query: {
|
|
533
560
|
key: string;
|
|
561
|
+
value: string;
|
|
534
562
|
enabled: boolean;
|
|
535
|
-
|
|
536
|
-
type?: string | string[] | undefined;
|
|
537
|
-
maximum?: number | undefined;
|
|
563
|
+
file?: any;
|
|
538
564
|
description?: string | undefined;
|
|
539
|
-
default?: any;
|
|
540
565
|
required?: boolean | undefined;
|
|
541
566
|
enum?: string[] | undefined;
|
|
542
567
|
examples?: any[] | undefined;
|
|
543
|
-
|
|
568
|
+
type?: string | string[] | undefined;
|
|
544
569
|
format?: string | undefined;
|
|
545
|
-
|
|
570
|
+
minimum?: number | undefined;
|
|
571
|
+
maximum?: number | undefined;
|
|
572
|
+
default?: any;
|
|
573
|
+
nullable?: boolean | undefined;
|
|
546
574
|
}[];
|
|
547
|
-
|
|
548
|
-
value: string;
|
|
575
|
+
headers: {
|
|
549
576
|
key: string;
|
|
577
|
+
value: string;
|
|
550
578
|
enabled: boolean;
|
|
551
|
-
|
|
552
|
-
type?: string | string[] | undefined;
|
|
553
|
-
maximum?: number | undefined;
|
|
579
|
+
file?: any;
|
|
554
580
|
description?: string | undefined;
|
|
555
|
-
default?: any;
|
|
556
581
|
required?: boolean | undefined;
|
|
557
582
|
enum?: string[] | undefined;
|
|
558
583
|
examples?: any[] | undefined;
|
|
559
|
-
|
|
584
|
+
type?: string | string[] | undefined;
|
|
560
585
|
format?: string | undefined;
|
|
561
|
-
|
|
586
|
+
minimum?: number | undefined;
|
|
587
|
+
maximum?: number | undefined;
|
|
588
|
+
default?: any;
|
|
589
|
+
nullable?: boolean | undefined;
|
|
562
590
|
}[];
|
|
563
591
|
cookies: {
|
|
564
|
-
value: string;
|
|
565
592
|
key: string;
|
|
593
|
+
value: string;
|
|
566
594
|
enabled: boolean;
|
|
567
|
-
|
|
568
|
-
type?: string | string[] | undefined;
|
|
569
|
-
maximum?: number | undefined;
|
|
595
|
+
file?: any;
|
|
570
596
|
description?: string | undefined;
|
|
571
|
-
default?: any;
|
|
572
597
|
required?: boolean | undefined;
|
|
573
598
|
enum?: string[] | undefined;
|
|
574
599
|
examples?: any[] | undefined;
|
|
575
|
-
|
|
600
|
+
type?: string | string[] | undefined;
|
|
576
601
|
format?: string | undefined;
|
|
577
|
-
|
|
602
|
+
minimum?: number | undefined;
|
|
603
|
+
maximum?: number | undefined;
|
|
604
|
+
default?: any;
|
|
605
|
+
nullable?: boolean | undefined;
|
|
578
606
|
}[];
|
|
579
607
|
};
|
|
608
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
609
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
610
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
611
|
+
untrackedEdit: <P extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.headers" | "parameters.cookies" | `parameters.cookies.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.enabled` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.format` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.enabled` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.format` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | "body.raw" | "body.formData" | "body.binary" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.bytes" | "body.binary.stream" | `serverVariables.${string}`>(uid: string & import("zod").$brand<"example">, path: P, value: P extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? {
|
|
612
|
+
uid: string & import("zod").$brand<"example">;
|
|
613
|
+
type: "requestExample";
|
|
614
|
+
name: string;
|
|
580
615
|
body: {
|
|
581
|
-
activeBody: "
|
|
582
|
-
|
|
616
|
+
activeBody: "raw" | "formData" | "binary";
|
|
617
|
+
raw?: {
|
|
618
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
619
|
+
value: string;
|
|
620
|
+
mimeType?: string | undefined;
|
|
621
|
+
} | undefined;
|
|
583
622
|
formData?: {
|
|
623
|
+
encoding: "form-data" | "urlencoded";
|
|
584
624
|
value: {
|
|
585
|
-
value: string;
|
|
586
625
|
key: string;
|
|
626
|
+
value: string;
|
|
587
627
|
enabled: boolean;
|
|
588
|
-
|
|
589
|
-
type?: string | string[] | undefined;
|
|
590
|
-
maximum?: number | undefined;
|
|
628
|
+
file?: any;
|
|
591
629
|
description?: string | undefined;
|
|
592
|
-
default?: any;
|
|
593
630
|
required?: boolean | undefined;
|
|
594
631
|
enum?: string[] | undefined;
|
|
595
632
|
examples?: any[] | undefined;
|
|
596
|
-
|
|
633
|
+
type?: string | string[] | undefined;
|
|
597
634
|
format?: string | undefined;
|
|
598
|
-
|
|
635
|
+
minimum?: number | undefined;
|
|
636
|
+
maximum?: number | undefined;
|
|
637
|
+
default?: any;
|
|
638
|
+
nullable?: boolean | undefined;
|
|
599
639
|
}[];
|
|
600
|
-
encoding: "form-data" | "urlencoded";
|
|
601
|
-
} | undefined;
|
|
602
|
-
raw?: {
|
|
603
|
-
value: string;
|
|
604
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
605
|
-
mimeType?: string | undefined;
|
|
606
640
|
} | undefined;
|
|
641
|
+
binary?: Blob | undefined;
|
|
607
642
|
};
|
|
608
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
609
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
610
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
611
|
-
untrackedEdit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.bytes" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
612
|
-
uid: string & import("zod").BRAND<"example">;
|
|
613
|
-
name: string;
|
|
614
|
-
type: "requestExample";
|
|
615
643
|
parameters: {
|
|
616
644
|
path: {
|
|
617
|
-
value: string;
|
|
618
645
|
key: string;
|
|
646
|
+
value: string;
|
|
619
647
|
enabled: boolean;
|
|
620
|
-
|
|
621
|
-
type?: string | string[] | undefined;
|
|
622
|
-
maximum?: number | undefined;
|
|
648
|
+
file?: any;
|
|
623
649
|
description?: string | undefined;
|
|
624
|
-
default?: any;
|
|
625
650
|
required?: boolean | undefined;
|
|
626
651
|
enum?: string[] | undefined;
|
|
627
652
|
examples?: any[] | undefined;
|
|
628
|
-
|
|
653
|
+
type?: string | string[] | undefined;
|
|
629
654
|
format?: string | undefined;
|
|
630
|
-
|
|
655
|
+
minimum?: number | undefined;
|
|
656
|
+
maximum?: number | undefined;
|
|
657
|
+
default?: any;
|
|
658
|
+
nullable?: boolean | undefined;
|
|
631
659
|
}[];
|
|
632
|
-
|
|
633
|
-
value: string;
|
|
660
|
+
query: {
|
|
634
661
|
key: string;
|
|
662
|
+
value: string;
|
|
635
663
|
enabled: boolean;
|
|
636
|
-
|
|
637
|
-
type?: string | string[] | undefined;
|
|
638
|
-
maximum?: number | undefined;
|
|
664
|
+
file?: any;
|
|
639
665
|
description?: string | undefined;
|
|
640
|
-
default?: any;
|
|
641
666
|
required?: boolean | undefined;
|
|
642
667
|
enum?: string[] | undefined;
|
|
643
668
|
examples?: any[] | undefined;
|
|
644
|
-
|
|
669
|
+
type?: string | string[] | undefined;
|
|
645
670
|
format?: string | undefined;
|
|
646
|
-
|
|
671
|
+
minimum?: number | undefined;
|
|
672
|
+
maximum?: number | undefined;
|
|
673
|
+
default?: any;
|
|
674
|
+
nullable?: boolean | undefined;
|
|
647
675
|
}[];
|
|
648
|
-
|
|
649
|
-
value: string;
|
|
676
|
+
headers: {
|
|
650
677
|
key: string;
|
|
678
|
+
value: string;
|
|
651
679
|
enabled: boolean;
|
|
652
|
-
|
|
653
|
-
type?: string | string[] | undefined;
|
|
654
|
-
maximum?: number | undefined;
|
|
680
|
+
file?: any;
|
|
655
681
|
description?: string | undefined;
|
|
656
|
-
default?: any;
|
|
657
682
|
required?: boolean | undefined;
|
|
658
683
|
enum?: string[] | undefined;
|
|
659
684
|
examples?: any[] | undefined;
|
|
660
|
-
|
|
685
|
+
type?: string | string[] | undefined;
|
|
661
686
|
format?: string | undefined;
|
|
662
|
-
|
|
687
|
+
minimum?: number | undefined;
|
|
688
|
+
maximum?: number | undefined;
|
|
689
|
+
default?: any;
|
|
690
|
+
nullable?: boolean | undefined;
|
|
663
691
|
}[];
|
|
664
692
|
cookies: {
|
|
665
|
-
value: string;
|
|
666
693
|
key: string;
|
|
694
|
+
value: string;
|
|
667
695
|
enabled: boolean;
|
|
668
|
-
|
|
669
|
-
type?: string | string[] | undefined;
|
|
670
|
-
maximum?: number | undefined;
|
|
696
|
+
file?: any;
|
|
671
697
|
description?: string | undefined;
|
|
672
|
-
default?: any;
|
|
673
698
|
required?: boolean | undefined;
|
|
674
699
|
enum?: string[] | undefined;
|
|
675
700
|
examples?: any[] | undefined;
|
|
676
|
-
|
|
701
|
+
type?: string | string[] | undefined;
|
|
677
702
|
format?: string | undefined;
|
|
678
|
-
|
|
703
|
+
minimum?: number | undefined;
|
|
704
|
+
maximum?: number | undefined;
|
|
705
|
+
default?: any;
|
|
706
|
+
nullable?: boolean | undefined;
|
|
679
707
|
}[];
|
|
680
708
|
};
|
|
709
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
710
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
711
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "name" | "requestUid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
712
|
+
uid: string & import("zod").$brand<"example">;
|
|
713
|
+
type: "requestExample";
|
|
714
|
+
name: string;
|
|
681
715
|
body: {
|
|
682
|
-
activeBody: "
|
|
683
|
-
|
|
716
|
+
activeBody: "raw" | "formData" | "binary";
|
|
717
|
+
raw?: {
|
|
718
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
719
|
+
value: string;
|
|
720
|
+
mimeType?: string | undefined;
|
|
721
|
+
} | undefined;
|
|
684
722
|
formData?: {
|
|
723
|
+
encoding: "form-data" | "urlencoded";
|
|
685
724
|
value: {
|
|
686
|
-
value: string;
|
|
687
725
|
key: string;
|
|
726
|
+
value: string;
|
|
688
727
|
enabled: boolean;
|
|
689
|
-
|
|
690
|
-
type?: string | string[] | undefined;
|
|
691
|
-
maximum?: number | undefined;
|
|
728
|
+
file?: any;
|
|
692
729
|
description?: string | undefined;
|
|
693
|
-
default?: any;
|
|
694
730
|
required?: boolean | undefined;
|
|
695
731
|
enum?: string[] | undefined;
|
|
696
732
|
examples?: any[] | undefined;
|
|
697
|
-
|
|
733
|
+
type?: string | string[] | undefined;
|
|
698
734
|
format?: string | undefined;
|
|
699
|
-
|
|
735
|
+
minimum?: number | undefined;
|
|
736
|
+
maximum?: number | undefined;
|
|
737
|
+
default?: any;
|
|
738
|
+
nullable?: boolean | undefined;
|
|
700
739
|
}[];
|
|
701
|
-
encoding: "form-data" | "urlencoded";
|
|
702
|
-
} | undefined;
|
|
703
|
-
raw?: {
|
|
704
|
-
value: string;
|
|
705
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
706
|
-
mimeType?: string | undefined;
|
|
707
740
|
} | undefined;
|
|
741
|
+
binary?: Blob | undefined;
|
|
708
742
|
};
|
|
709
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
710
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
711
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
712
|
-
uid: string & import("zod").BRAND<"example">;
|
|
713
|
-
name: string;
|
|
714
|
-
type: "requestExample";
|
|
715
743
|
parameters: {
|
|
716
744
|
path: {
|
|
717
|
-
value: string;
|
|
718
745
|
key: string;
|
|
746
|
+
value: string;
|
|
719
747
|
enabled: boolean;
|
|
720
|
-
|
|
721
|
-
type?: string | string[] | undefined;
|
|
722
|
-
maximum?: number | undefined;
|
|
748
|
+
file?: any;
|
|
723
749
|
description?: string | undefined;
|
|
724
|
-
default?: any;
|
|
725
750
|
required?: boolean | undefined;
|
|
726
751
|
enum?: string[] | undefined;
|
|
727
752
|
examples?: any[] | undefined;
|
|
728
|
-
|
|
753
|
+
type?: string | string[] | undefined;
|
|
729
754
|
format?: string | undefined;
|
|
730
|
-
|
|
755
|
+
minimum?: number | undefined;
|
|
756
|
+
maximum?: number | undefined;
|
|
757
|
+
default?: any;
|
|
758
|
+
nullable?: boolean | undefined;
|
|
731
759
|
}[];
|
|
732
|
-
|
|
733
|
-
value: string;
|
|
760
|
+
query: {
|
|
734
761
|
key: string;
|
|
762
|
+
value: string;
|
|
735
763
|
enabled: boolean;
|
|
736
|
-
|
|
737
|
-
type?: string | string[] | undefined;
|
|
738
|
-
maximum?: number | undefined;
|
|
764
|
+
file?: any;
|
|
739
765
|
description?: string | undefined;
|
|
740
|
-
default?: any;
|
|
741
766
|
required?: boolean | undefined;
|
|
742
767
|
enum?: string[] | undefined;
|
|
743
768
|
examples?: any[] | undefined;
|
|
744
|
-
|
|
769
|
+
type?: string | string[] | undefined;
|
|
745
770
|
format?: string | undefined;
|
|
746
|
-
|
|
771
|
+
minimum?: number | undefined;
|
|
772
|
+
maximum?: number | undefined;
|
|
773
|
+
default?: any;
|
|
774
|
+
nullable?: boolean | undefined;
|
|
747
775
|
}[];
|
|
748
|
-
|
|
749
|
-
value: string;
|
|
776
|
+
headers: {
|
|
750
777
|
key: string;
|
|
778
|
+
value: string;
|
|
751
779
|
enabled: boolean;
|
|
752
|
-
|
|
753
|
-
type?: string | string[] | undefined;
|
|
754
|
-
maximum?: number | undefined;
|
|
780
|
+
file?: any;
|
|
755
781
|
description?: string | undefined;
|
|
756
|
-
default?: any;
|
|
757
782
|
required?: boolean | undefined;
|
|
758
783
|
enum?: string[] | undefined;
|
|
759
784
|
examples?: any[] | undefined;
|
|
760
|
-
|
|
785
|
+
type?: string | string[] | undefined;
|
|
761
786
|
format?: string | undefined;
|
|
762
|
-
|
|
787
|
+
minimum?: number | undefined;
|
|
788
|
+
maximum?: number | undefined;
|
|
789
|
+
default?: any;
|
|
790
|
+
nullable?: boolean | undefined;
|
|
763
791
|
}[];
|
|
764
792
|
cookies: {
|
|
765
|
-
value: string;
|
|
766
793
|
key: string;
|
|
794
|
+
value: string;
|
|
767
795
|
enabled: boolean;
|
|
768
|
-
|
|
769
|
-
type?: string | string[] | undefined;
|
|
770
|
-
maximum?: number | undefined;
|
|
796
|
+
file?: any;
|
|
771
797
|
description?: string | undefined;
|
|
772
|
-
default?: any;
|
|
773
798
|
required?: boolean | undefined;
|
|
774
799
|
enum?: string[] | undefined;
|
|
775
800
|
examples?: any[] | undefined;
|
|
776
|
-
|
|
801
|
+
type?: string | string[] | undefined;
|
|
777
802
|
format?: string | undefined;
|
|
778
|
-
|
|
803
|
+
minimum?: number | undefined;
|
|
804
|
+
maximum?: number | undefined;
|
|
805
|
+
default?: any;
|
|
806
|
+
nullable?: boolean | undefined;
|
|
779
807
|
}[];
|
|
780
808
|
};
|
|
809
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
810
|
+
serverVariables?: Record<string, string[]> | undefined;
|
|
811
|
+
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
812
|
+
uid: string & import("zod").$brand<"example">;
|
|
813
|
+
type: "requestExample";
|
|
814
|
+
name: string;
|
|
781
815
|
body: {
|
|
782
|
-
activeBody: "
|
|
783
|
-
|
|
816
|
+
activeBody: "raw" | "formData" | "binary";
|
|
817
|
+
raw?: {
|
|
818
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
819
|
+
value: string;
|
|
820
|
+
mimeType?: string | undefined;
|
|
821
|
+
} | undefined;
|
|
784
822
|
formData?: {
|
|
823
|
+
encoding: "form-data" | "urlencoded";
|
|
785
824
|
value: {
|
|
786
|
-
value: string;
|
|
787
825
|
key: string;
|
|
826
|
+
value: string;
|
|
788
827
|
enabled: boolean;
|
|
789
|
-
|
|
790
|
-
type?: string | string[] | undefined;
|
|
791
|
-
maximum?: number | undefined;
|
|
828
|
+
file?: any;
|
|
792
829
|
description?: string | undefined;
|
|
793
|
-
default?: any;
|
|
794
830
|
required?: boolean | undefined;
|
|
795
831
|
enum?: string[] | undefined;
|
|
796
832
|
examples?: any[] | undefined;
|
|
797
|
-
|
|
833
|
+
type?: string | string[] | undefined;
|
|
798
834
|
format?: string | undefined;
|
|
799
|
-
|
|
835
|
+
minimum?: number | undefined;
|
|
836
|
+
maximum?: number | undefined;
|
|
837
|
+
default?: any;
|
|
838
|
+
nullable?: boolean | undefined;
|
|
800
839
|
}[];
|
|
801
|
-
encoding: "form-data" | "urlencoded";
|
|
802
|
-
} | undefined;
|
|
803
|
-
raw?: {
|
|
804
|
-
value: string;
|
|
805
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
806
|
-
mimeType?: string | undefined;
|
|
807
840
|
} | undefined;
|
|
841
|
+
binary?: Blob | undefined;
|
|
808
842
|
};
|
|
809
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
810
|
-
serverVariables?: Record<string, string[]> | undefined;
|
|
811
|
-
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
812
|
-
uid: string & import("zod").BRAND<"example">;
|
|
813
|
-
name: string;
|
|
814
|
-
type: "requestExample";
|
|
815
843
|
parameters: {
|
|
816
844
|
path: {
|
|
817
|
-
value: string;
|
|
818
845
|
key: string;
|
|
846
|
+
value: string;
|
|
819
847
|
enabled: boolean;
|
|
820
|
-
|
|
821
|
-
type?: string | string[] | undefined;
|
|
822
|
-
maximum?: number | undefined;
|
|
848
|
+
file?: any;
|
|
823
849
|
description?: string | undefined;
|
|
824
|
-
default?: any;
|
|
825
850
|
required?: boolean | undefined;
|
|
826
851
|
enum?: string[] | undefined;
|
|
827
852
|
examples?: any[] | undefined;
|
|
828
|
-
|
|
853
|
+
type?: string | string[] | undefined;
|
|
829
854
|
format?: string | undefined;
|
|
830
|
-
|
|
855
|
+
minimum?: number | undefined;
|
|
856
|
+
maximum?: number | undefined;
|
|
857
|
+
default?: any;
|
|
858
|
+
nullable?: boolean | undefined;
|
|
831
859
|
}[];
|
|
832
|
-
|
|
833
|
-
value: string;
|
|
860
|
+
query: {
|
|
834
861
|
key: string;
|
|
862
|
+
value: string;
|
|
835
863
|
enabled: boolean;
|
|
836
|
-
|
|
837
|
-
type?: string | string[] | undefined;
|
|
838
|
-
maximum?: number | undefined;
|
|
864
|
+
file?: any;
|
|
839
865
|
description?: string | undefined;
|
|
840
|
-
default?: any;
|
|
841
866
|
required?: boolean | undefined;
|
|
842
867
|
enum?: string[] | undefined;
|
|
843
868
|
examples?: any[] | undefined;
|
|
844
|
-
|
|
869
|
+
type?: string | string[] | undefined;
|
|
845
870
|
format?: string | undefined;
|
|
846
|
-
|
|
871
|
+
minimum?: number | undefined;
|
|
872
|
+
maximum?: number | undefined;
|
|
873
|
+
default?: any;
|
|
874
|
+
nullable?: boolean | undefined;
|
|
847
875
|
}[];
|
|
848
|
-
|
|
849
|
-
value: string;
|
|
876
|
+
headers: {
|
|
850
877
|
key: string;
|
|
878
|
+
value: string;
|
|
851
879
|
enabled: boolean;
|
|
852
|
-
|
|
853
|
-
type?: string | string[] | undefined;
|
|
854
|
-
maximum?: number | undefined;
|
|
880
|
+
file?: any;
|
|
855
881
|
description?: string | undefined;
|
|
856
|
-
default?: any;
|
|
857
882
|
required?: boolean | undefined;
|
|
858
883
|
enum?: string[] | undefined;
|
|
859
884
|
examples?: any[] | undefined;
|
|
860
|
-
|
|
885
|
+
type?: string | string[] | undefined;
|
|
861
886
|
format?: string | undefined;
|
|
862
|
-
|
|
887
|
+
minimum?: number | undefined;
|
|
888
|
+
maximum?: number | undefined;
|
|
889
|
+
default?: any;
|
|
890
|
+
nullable?: boolean | undefined;
|
|
863
891
|
}[];
|
|
864
892
|
cookies: {
|
|
865
|
-
value: string;
|
|
866
893
|
key: string;
|
|
894
|
+
value: string;
|
|
867
895
|
enabled: boolean;
|
|
868
|
-
|
|
869
|
-
type?: string | string[] | undefined;
|
|
870
|
-
maximum?: number | undefined;
|
|
896
|
+
file?: any;
|
|
871
897
|
description?: string | undefined;
|
|
872
|
-
default?: any;
|
|
873
898
|
required?: boolean | undefined;
|
|
874
899
|
enum?: string[] | undefined;
|
|
875
900
|
examples?: any[] | undefined;
|
|
876
|
-
|
|
901
|
+
type?: string | string[] | undefined;
|
|
877
902
|
format?: string | undefined;
|
|
878
|
-
|
|
903
|
+
minimum?: number | undefined;
|
|
904
|
+
maximum?: number | undefined;
|
|
905
|
+
default?: any;
|
|
906
|
+
nullable?: boolean | undefined;
|
|
879
907
|
}[];
|
|
880
908
|
};
|
|
881
|
-
|
|
882
|
-
activeBody: "binary" | "formData" | "raw";
|
|
883
|
-
binary?: Blob | undefined;
|
|
884
|
-
formData?: {
|
|
885
|
-
value: {
|
|
886
|
-
value: string;
|
|
887
|
-
key: string;
|
|
888
|
-
enabled: boolean;
|
|
889
|
-
minimum?: number | undefined;
|
|
890
|
-
type?: string | string[] | undefined;
|
|
891
|
-
maximum?: number | undefined;
|
|
892
|
-
description?: string | undefined;
|
|
893
|
-
default?: any;
|
|
894
|
-
required?: boolean | undefined;
|
|
895
|
-
enum?: string[] | undefined;
|
|
896
|
-
examples?: any[] | undefined;
|
|
897
|
-
nullable?: boolean | undefined;
|
|
898
|
-
format?: string | undefined;
|
|
899
|
-
file?: any;
|
|
900
|
-
}[];
|
|
901
|
-
encoding: "form-data" | "urlencoded";
|
|
902
|
-
} | undefined;
|
|
903
|
-
raw?: {
|
|
904
|
-
value: string;
|
|
905
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
906
|
-
mimeType?: string | undefined;
|
|
907
|
-
} | undefined;
|
|
908
|
-
};
|
|
909
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
909
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
910
910
|
serverVariables?: Record<string, string[]> | undefined;
|
|
911
911
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
912
|
-
undo: (uid: string & import("zod")
|
|
913
|
-
redo: (uid: string & import("zod")
|
|
912
|
+
undo: (uid: string & import("zod").$brand<"example">) => void;
|
|
913
|
+
redo: (uid: string & import("zod").$brand<"example">) => void;
|
|
914
914
|
reset: () => void;
|
|
915
915
|
};
|
|
916
916
|
};
|
|
917
917
|
/** Extended example data that needs store context */
|
|
918
918
|
export declare function extendedExampleDataFactory({ requestExamples, requestExampleMutators, requestMutators, requests, }: StoreContext): {
|
|
919
919
|
addRequestExample: (request: Request, _name?: string) => {
|
|
920
|
-
uid: string & import("zod")
|
|
921
|
-
name: string;
|
|
920
|
+
uid: string & import("zod").$brand<"example">;
|
|
922
921
|
type: "requestExample";
|
|
922
|
+
name: string;
|
|
923
|
+
body: {
|
|
924
|
+
activeBody: "raw" | "formData" | "binary";
|
|
925
|
+
raw?: {
|
|
926
|
+
encoding: "html" | "xml" | "json" | "text" | "javascript" | "yaml" | "edn";
|
|
927
|
+
value: string;
|
|
928
|
+
mimeType?: string | undefined;
|
|
929
|
+
} | undefined;
|
|
930
|
+
formData?: {
|
|
931
|
+
encoding: "form-data" | "urlencoded";
|
|
932
|
+
value: {
|
|
933
|
+
key: string;
|
|
934
|
+
value: string;
|
|
935
|
+
enabled: boolean;
|
|
936
|
+
file?: any;
|
|
937
|
+
description?: string | undefined;
|
|
938
|
+
required?: boolean | undefined;
|
|
939
|
+
enum?: string[] | undefined;
|
|
940
|
+
examples?: any[] | undefined;
|
|
941
|
+
type?: string | string[] | undefined;
|
|
942
|
+
format?: string | undefined;
|
|
943
|
+
minimum?: number | undefined;
|
|
944
|
+
maximum?: number | undefined;
|
|
945
|
+
default?: any;
|
|
946
|
+
nullable?: boolean | undefined;
|
|
947
|
+
}[];
|
|
948
|
+
} | undefined;
|
|
949
|
+
binary?: Blob | undefined;
|
|
950
|
+
};
|
|
923
951
|
parameters: {
|
|
924
952
|
path: {
|
|
925
|
-
value: string;
|
|
926
953
|
key: string;
|
|
954
|
+
value: string;
|
|
927
955
|
enabled: boolean;
|
|
928
|
-
|
|
929
|
-
type?: string | string[] | undefined;
|
|
930
|
-
maximum?: number | undefined;
|
|
956
|
+
file?: any;
|
|
931
957
|
description?: string | undefined;
|
|
932
|
-
default?: any;
|
|
933
958
|
required?: boolean | undefined;
|
|
934
959
|
enum?: string[] | undefined;
|
|
935
960
|
examples?: any[] | undefined;
|
|
936
|
-
|
|
961
|
+
type?: string | string[] | undefined;
|
|
937
962
|
format?: string | undefined;
|
|
938
|
-
|
|
963
|
+
minimum?: number | undefined;
|
|
964
|
+
maximum?: number | undefined;
|
|
965
|
+
default?: any;
|
|
966
|
+
nullable?: boolean | undefined;
|
|
939
967
|
}[];
|
|
940
|
-
|
|
941
|
-
value: string;
|
|
968
|
+
query: {
|
|
942
969
|
key: string;
|
|
970
|
+
value: string;
|
|
943
971
|
enabled: boolean;
|
|
944
|
-
|
|
945
|
-
type?: string | string[] | undefined;
|
|
946
|
-
maximum?: number | undefined;
|
|
972
|
+
file?: any;
|
|
947
973
|
description?: string | undefined;
|
|
948
|
-
default?: any;
|
|
949
974
|
required?: boolean | undefined;
|
|
950
975
|
enum?: string[] | undefined;
|
|
951
976
|
examples?: any[] | undefined;
|
|
952
|
-
|
|
977
|
+
type?: string | string[] | undefined;
|
|
953
978
|
format?: string | undefined;
|
|
954
|
-
|
|
979
|
+
minimum?: number | undefined;
|
|
980
|
+
maximum?: number | undefined;
|
|
981
|
+
default?: any;
|
|
982
|
+
nullable?: boolean | undefined;
|
|
955
983
|
}[];
|
|
956
|
-
|
|
957
|
-
value: string;
|
|
984
|
+
headers: {
|
|
958
985
|
key: string;
|
|
986
|
+
value: string;
|
|
959
987
|
enabled: boolean;
|
|
960
|
-
|
|
961
|
-
type?: string | string[] | undefined;
|
|
962
|
-
maximum?: number | undefined;
|
|
988
|
+
file?: any;
|
|
963
989
|
description?: string | undefined;
|
|
964
|
-
default?: any;
|
|
965
990
|
required?: boolean | undefined;
|
|
966
991
|
enum?: string[] | undefined;
|
|
967
992
|
examples?: any[] | undefined;
|
|
968
|
-
|
|
993
|
+
type?: string | string[] | undefined;
|
|
969
994
|
format?: string | undefined;
|
|
970
|
-
|
|
995
|
+
minimum?: number | undefined;
|
|
996
|
+
maximum?: number | undefined;
|
|
997
|
+
default?: any;
|
|
998
|
+
nullable?: boolean | undefined;
|
|
971
999
|
}[];
|
|
972
1000
|
cookies: {
|
|
973
|
-
value: string;
|
|
974
1001
|
key: string;
|
|
1002
|
+
value: string;
|
|
975
1003
|
enabled: boolean;
|
|
976
|
-
|
|
977
|
-
type?: string | string[] | undefined;
|
|
978
|
-
maximum?: number | undefined;
|
|
1004
|
+
file?: any;
|
|
979
1005
|
description?: string | undefined;
|
|
980
|
-
default?: any;
|
|
981
1006
|
required?: boolean | undefined;
|
|
982
1007
|
enum?: string[] | undefined;
|
|
983
1008
|
examples?: any[] | undefined;
|
|
984
|
-
|
|
1009
|
+
type?: string | string[] | undefined;
|
|
985
1010
|
format?: string | undefined;
|
|
986
|
-
|
|
1011
|
+
minimum?: number | undefined;
|
|
1012
|
+
maximum?: number | undefined;
|
|
1013
|
+
default?: any;
|
|
1014
|
+
nullable?: boolean | undefined;
|
|
987
1015
|
}[];
|
|
988
1016
|
};
|
|
989
|
-
|
|
990
|
-
activeBody: "binary" | "formData" | "raw";
|
|
991
|
-
binary?: Blob | undefined;
|
|
992
|
-
formData?: {
|
|
993
|
-
value: {
|
|
994
|
-
value: string;
|
|
995
|
-
key: string;
|
|
996
|
-
enabled: boolean;
|
|
997
|
-
minimum?: number | undefined;
|
|
998
|
-
type?: string | string[] | undefined;
|
|
999
|
-
maximum?: number | undefined;
|
|
1000
|
-
description?: string | undefined;
|
|
1001
|
-
default?: any;
|
|
1002
|
-
required?: boolean | undefined;
|
|
1003
|
-
enum?: string[] | undefined;
|
|
1004
|
-
examples?: any[] | undefined;
|
|
1005
|
-
nullable?: boolean | undefined;
|
|
1006
|
-
format?: string | undefined;
|
|
1007
|
-
file?: any;
|
|
1008
|
-
}[];
|
|
1009
|
-
encoding: "form-data" | "urlencoded";
|
|
1010
|
-
} | undefined;
|
|
1011
|
-
raw?: {
|
|
1012
|
-
value: string;
|
|
1013
|
-
encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
|
|
1014
|
-
mimeType?: string | undefined;
|
|
1015
|
-
} | undefined;
|
|
1016
|
-
};
|
|
1017
|
-
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
1017
|
+
requestUid?: (string & import("zod").$brand<"operation">) | undefined;
|
|
1018
1018
|
serverVariables?: Record<string, string[]> | undefined;
|
|
1019
1019
|
};
|
|
1020
1020
|
deleteRequestExample: (requestExample: RequestExample) => void;
|