@scalar/workspace-store 0.14.2 → 0.15.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -0
- package/dist/client.d.ts +24 -4
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +58 -52
- package/dist/client.js.map +2 -2
- package/dist/events/definitions.d.ts +155 -0
- package/dist/events/definitions.d.ts.map +1 -0
- package/dist/events/definitions.js +13 -0
- package/dist/events/definitions.js.map +7 -0
- package/dist/events/index.d.ts +3 -0
- package/dist/events/index.d.ts.map +1 -0
- package/dist/events/index.js +7 -0
- package/dist/events/index.js.map +7 -0
- package/dist/events/listeners.d.ts +8 -0
- package/dist/events/listeners.d.ts.map +1 -0
- package/dist/events/listeners.js +23 -0
- package/dist/events/listeners.js.map +7 -0
- package/dist/helpers/apply-selective-updates.d.ts +1 -1
- package/dist/helpers/apply-selective-updates.d.ts.map +1 -1
- package/dist/helpers/apply-selective-updates.js +1 -1
- package/dist/helpers/apply-selective-updates.js.map +2 -2
- package/dist/helpers/deep-clone.d.ts.map +1 -1
- package/dist/helpers/general.d.ts.map +1 -1
- package/dist/helpers/get-resolved-ref.d.ts.map +1 -1
- package/dist/helpers/merge-object.d.ts.map +1 -1
- package/dist/helpers/merge-object.js.map +2 -2
- package/dist/helpers/overrides-proxy.d.ts.map +1 -1
- package/dist/helpers/overrides-proxy.js.map +2 -2
- package/dist/mutators/cookie.d.ts.map +1 -1
- package/dist/mutators/environment.d.ts +1 -1
- package/dist/mutators/environment.d.ts.map +1 -1
- package/dist/mutators/environment.js.map +1 -1
- package/dist/mutators/helpers.d.ts.map +1 -1
- package/dist/mutators/index.d.ts +9 -9
- package/dist/mutators/request-example.d.ts.map +1 -1
- package/dist/mutators/request.d.ts +1 -1
- package/dist/mutators/request.d.ts.map +1 -1
- package/dist/mutators/request.js.map +2 -2
- package/dist/mutators/security-schemes.d.ts +1 -2
- package/dist/mutators/security-schemes.d.ts.map +1 -1
- package/dist/mutators/security-schemes.js.map +2 -2
- package/dist/mutators/server.d.ts +2 -2
- package/dist/mutators/server.d.ts.map +1 -1
- package/dist/mutators/server.js +4 -2
- package/dist/mutators/server.js.map +2 -2
- package/dist/navigation/helpers/get-tag.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-description.d.ts +3 -1
- package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-document.d.ts +30 -30
- package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-document.js.map +2 -2
- package/dist/navigation/helpers/traverse-paths.d.ts +5 -1
- package/dist/navigation/helpers/traverse-paths.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-paths.js +3 -3
- package/dist/navigation/helpers/traverse-paths.js.map +2 -2
- package/dist/navigation/helpers/traverse-schemas.d.ts +5 -1
- package/dist/navigation/helpers/traverse-schemas.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-schemas.js +1 -1
- package/dist/navigation/helpers/traverse-schemas.js.map +2 -2
- package/dist/navigation/helpers/traverse-tags.d.ts +6 -2
- package/dist/navigation/helpers/traverse-tags.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-tags.js.map +2 -2
- package/dist/navigation/helpers/traverse-webhooks.d.ts +6 -2
- package/dist/navigation/helpers/traverse-webhooks.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-webhooks.js +2 -2
- package/dist/navigation/helpers/traverse-webhooks.js.map +2 -2
- package/dist/navigation/helpers/utils.d.ts.map +1 -1
- package/dist/navigation/helpers/utils.js.map +2 -2
- package/dist/navigation/index.d.ts +1 -1
- package/dist/navigation/index.d.ts.map +1 -1
- package/dist/navigation/index.js.map +2 -2
- package/dist/navigation/types.d.ts +1 -2
- package/dist/navigation/types.d.ts.map +1 -1
- package/dist/plugins.d.ts +5 -37
- package/dist/plugins.d.ts.map +1 -1
- package/dist/plugins.js +0 -21
- package/dist/plugins.js.map +2 -2
- package/dist/preprocessing/server.d.ts +23 -0
- package/dist/preprocessing/server.d.ts.map +1 -0
- package/dist/preprocessing/server.js +84 -0
- package/dist/preprocessing/server.js.map +7 -0
- package/dist/schemas/compose.d.ts +1 -1
- package/dist/schemas/compose.d.ts.map +1 -1
- package/dist/schemas/compose.js +1 -1
- package/dist/schemas/compose.js.map +2 -2
- package/dist/schemas/extensions/document/x-internal.d.ts +2 -2
- package/dist/schemas/extensions/document/x-internal.js +1 -1
- package/dist/schemas/extensions/document/x-internal.js.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-icon.d.ts +2 -2
- package/dist/schemas/extensions/document/x-scalar-icon.js +1 -1
- package/dist/schemas/extensions/document/x-scalar-icon.js.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-ignore.d.ts +2 -2
- package/dist/schemas/extensions/document/x-scalar-ignore.js +1 -1
- package/dist/schemas/extensions/document/x-scalar-ignore.js.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +7 -5
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.js +1 -1
- package/dist/schemas/extensions/document/x-scalar-sdk-installation.js.map +2 -2
- package/dist/schemas/extensions/document/x-tags.d.ts +4 -0
- package/dist/schemas/extensions/document/x-tags.d.ts.map +1 -0
- package/dist/schemas/extensions/document/x-tags.js +8 -0
- package/dist/schemas/extensions/document/x-tags.js.map +7 -0
- package/dist/schemas/extensions/operation/x-badge.d.ts +10 -10
- package/dist/schemas/extensions/operation/x-badge.d.ts.map +1 -1
- package/dist/schemas/extensions/operation/x-badge.js +1 -1
- package/dist/schemas/extensions/operation/x-badge.js.map +2 -2
- package/dist/schemas/extensions/operation/x-code-samples.d.ts +17 -17
- package/dist/schemas/extensions/operation/x-code-samples.js +1 -1
- package/dist/schemas/extensions/operation/x-code-samples.js.map +1 -1
- package/dist/schemas/extensions/operation/x-post-response.d.ts +2 -2
- package/dist/schemas/extensions/operation/x-post-response.js +1 -1
- package/dist/schemas/extensions/operation/x-post-response.js.map +1 -1
- package/dist/schemas/extensions/operation/x-scalar-stability.d.ts +2 -2
- package/dist/schemas/extensions/operation/x-scalar-stability.js +1 -1
- package/dist/schemas/extensions/operation/x-scalar-stability.js.map +1 -1
- package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts +2 -2
- package/dist/schemas/extensions/schema/x-additional-properties-name.js +1 -1
- package/dist/schemas/extensions/schema/x-additional-properties-name.js.map +1 -1
- package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts +2 -2
- package/dist/schemas/extensions/schema/x-enum-descriptions.js +1 -1
- package/dist/schemas/extensions/schema/x-enum-descriptions.js.map +1 -1
- package/dist/schemas/extensions/schema/x-variable.d.ts +2 -2
- package/dist/schemas/extensions/schema/x-variable.js +1 -1
- package/dist/schemas/extensions/schema/x-variable.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts +2 -2
- package/dist/schemas/extensions/security/x-scalar-credentials-location.js +1 -1
- package/dist/schemas/extensions/security/x-scalar-credentials-location.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts +2 -2
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.js +1 -1
- package/dist/schemas/extensions/security/x-scalar-redirect-uri.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-body.d.ts +2 -2
- package/dist/schemas/extensions/security/x-scalar-security-body.js +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-body.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-query.d.ts +2 -2
- package/dist/schemas/extensions/security/x-scalar-security-query.js +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-query.js.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts +5 -5
- package/dist/schemas/extensions/security/x-scalar-security-secrets.js +1 -1
- package/dist/schemas/extensions/security/x-scalar-security-secrets.js.map +1 -1
- package/dist/schemas/extensions/security/x-tokenName.d.ts +2 -2
- package/dist/schemas/extensions/security/x-tokenName.js +1 -1
- package/dist/schemas/extensions/security/x-tokenName.js.map +1 -1
- package/dist/schemas/extensions/security/x-use-pkce.d.ts +2 -2
- package/dist/schemas/extensions/security/x-use-pkce.js +1 -1
- package/dist/schemas/extensions/security/x-use-pkce.js.map +1 -1
- package/dist/schemas/extensions/tag/x-display-name.d.ts +2 -2
- package/dist/schemas/extensions/tag/x-display-name.js +1 -1
- package/dist/schemas/extensions/tag/x-display-name.js.map +1 -1
- package/dist/schemas/extensions/tag/x-tag-groups.d.ts +7 -7
- package/dist/schemas/extensions/tag/x-tag-groups.js +1 -1
- package/dist/schemas/extensions/tag/x-tag-groups.js.map +1 -1
- package/dist/schemas/inmemory-workspace.d.ts +2470 -190
- package/dist/schemas/inmemory-workspace.d.ts.map +1 -1
- package/dist/schemas/inmemory-workspace.js +2 -3
- package/dist/schemas/inmemory-workspace.js.map +2 -2
- package/dist/schemas/navigation.d.ts +140 -134
- package/dist/schemas/navigation.d.ts.map +1 -1
- package/dist/schemas/navigation.js +13 -9
- package/dist/schemas/navigation.js.map +2 -2
- package/dist/schemas/reference-config/appearance.d.ts +9 -9
- package/dist/schemas/reference-config/appearance.d.ts.map +1 -1
- package/dist/schemas/reference-config/appearance.js +1 -1
- package/dist/schemas/reference-config/appearance.js.map +2 -2
- package/dist/schemas/reference-config/features.d.ts +11 -11
- package/dist/schemas/reference-config/features.d.ts.map +1 -1
- package/dist/schemas/reference-config/features.js +1 -1
- package/dist/schemas/reference-config/features.js.map +2 -2
- package/dist/schemas/reference-config/index.d.ts +1247 -46
- package/dist/schemas/reference-config/index.d.ts.map +1 -1
- package/dist/schemas/reference-config/index.js +5 -5
- package/dist/schemas/reference-config/index.js.map +2 -2
- package/dist/schemas/reference-config/meta.d.ts +8 -8
- package/dist/schemas/reference-config/meta.d.ts.map +1 -1
- package/dist/schemas/reference-config/meta.js +1 -1
- package/dist/schemas/reference-config/meta.js.map +2 -2
- package/dist/schemas/reference-config/routing.d.ts +4 -4
- package/dist/schemas/reference-config/routing.d.ts.map +1 -1
- package/dist/schemas/reference-config/routing.js +1 -1
- package/dist/schemas/reference-config/routing.js.map +2 -2
- package/dist/schemas/reference-config/settings.d.ts +1215 -14
- package/dist/schemas/reference-config/settings.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.js +2 -2
- package/dist/schemas/reference-config/settings.js.map +2 -2
- package/dist/schemas/typebox-coerce.d.ts +1 -1
- package/dist/schemas/typebox-coerce.d.ts.map +1 -1
- package/dist/schemas/typebox-coerce.js +2 -2
- package/dist/schemas/typebox-coerce.js.map +2 -2
- package/dist/schemas/v3.1/strict/callback.d.ts +1 -2
- package/dist/schemas/v3.1/strict/callback.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/callback.js +5 -4
- package/dist/schemas/v3.1/strict/callback.js.map +2 -2
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts +11 -11
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js.map +2 -2
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts +19 -19
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js.map +2 -2
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts +27 -27
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js +1 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js.map +2 -2
- package/dist/schemas/v3.1/strict/components.d.ts +22 -42
- package/dist/schemas/v3.1/strict/components.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/components.js +24 -29
- package/dist/schemas/v3.1/strict/components.js.map +2 -2
- package/dist/schemas/v3.1/strict/contact.d.ts +4 -6
- package/dist/schemas/v3.1/strict/contact.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/contact.js +3 -3
- package/dist/schemas/v3.1/strict/contact.js.map +2 -2
- package/dist/schemas/v3.1/strict/discriminator.d.ts +3 -5
- package/dist/schemas/v3.1/strict/discriminator.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/discriminator.js +3 -3
- package/dist/schemas/v3.1/strict/discriminator.js.map +2 -2
- package/dist/schemas/v3.1/strict/encoding.d.ts +10 -4
- package/dist/schemas/v3.1/strict/encoding.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/encoding.js +5 -4
- package/dist/schemas/v3.1/strict/encoding.js.map +2 -2
- package/dist/schemas/v3.1/strict/example.d.ts +5 -7
- package/dist/schemas/v3.1/strict/example.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/example.js +3 -3
- package/dist/schemas/v3.1/strict/example.js.map +2 -2
- package/dist/schemas/v3.1/strict/external-documentation.d.ts +3 -5
- package/dist/schemas/v3.1/strict/external-documentation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/external-documentation.js +3 -3
- package/dist/schemas/v3.1/strict/external-documentation.js.map +2 -2
- package/dist/schemas/v3.1/strict/header.d.ts +39 -347
- package/dist/schemas/v3.1/strict/header.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/header.js +8 -11
- package/dist/schemas/v3.1/strict/header.js.map +2 -2
- package/dist/schemas/v3.1/strict/info.d.ts +13 -23
- package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/info.js +7 -8
- package/dist/schemas/v3.1/strict/info.js.map +2 -2
- package/dist/schemas/v3.1/strict/license.d.ts +4 -6
- package/dist/schemas/v3.1/strict/license.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/license.js +3 -3
- package/dist/schemas/v3.1/strict/license.js.map +2 -2
- package/dist/schemas/v3.1/strict/link.d.ts +7 -17
- package/dist/schemas/v3.1/strict/link.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/link.js +5 -5
- package/dist/schemas/v3.1/strict/link.js.map +2 -2
- package/dist/schemas/v3.1/strict/media-type.d.ts +10 -164
- package/dist/schemas/v3.1/strict/media-type.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/media-type.js +7 -10
- package/dist/schemas/v3.1/strict/media-type.js.map +2 -2
- package/dist/schemas/v3.1/strict/oauth-flow.d.ts +59 -60
- package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/oauth-flow.js +3 -3
- package/dist/schemas/v3.1/strict/oauth-flow.js.map +2 -2
- package/dist/schemas/v3.1/strict/oauthflows.d.ts +30 -32
- package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/oauthflows.js +6 -6
- package/dist/schemas/v3.1/strict/oauthflows.js.map +2 -2
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +33908 -112
- package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.js +139 -24
- package/dist/schemas/v3.1/strict/openapi-document.js.map +2 -2
- package/dist/schemas/v3.1/strict/operation.d.ts +52 -4946
- package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/operation.js +22 -19
- package/dist/schemas/v3.1/strict/operation.js.map +2 -2
- package/dist/schemas/v3.1/strict/parameter.d.ts +51 -1397
- package/dist/schemas/v3.1/strict/parameter.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/parameter.js +10 -11
- package/dist/schemas/v3.1/strict/parameter.js.map +2 -2
- package/dist/schemas/v3.1/strict/path-item.d.ts +15 -1412
- package/dist/schemas/v3.1/strict/path-item.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/path-item.js +15 -16
- package/dist/schemas/v3.1/strict/path-item.js.map +2 -2
- package/dist/schemas/v3.1/strict/paths.d.ts +1 -4
- package/dist/schemas/v3.1/strict/paths.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/paths.js +5 -5
- package/dist/schemas/v3.1/strict/paths.js.map +2 -2
- package/dist/schemas/v3.1/strict/ref-definitions.d.ts +63 -0
- package/dist/schemas/v3.1/strict/ref-definitions.d.ts.map +1 -0
- package/dist/schemas/v3.1/strict/ref-definitions.js +88 -0
- package/dist/schemas/v3.1/strict/ref-definitions.js.map +7 -0
- package/dist/schemas/v3.1/strict/reference.d.ts +8 -8
- package/dist/schemas/v3.1/strict/reference.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/reference.js +1 -1
- package/dist/schemas/v3.1/strict/reference.js.map +2 -2
- package/dist/schemas/v3.1/strict/request-body.d.ts +4 -520
- package/dist/schemas/v3.1/strict/request-body.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/request-body.js +5 -5
- package/dist/schemas/v3.1/strict/request-body.js.map +2 -2
- package/dist/schemas/v3.1/strict/response.d.ts +5 -1231
- package/dist/schemas/v3.1/strict/response.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/response.js +7 -8
- package/dist/schemas/v3.1/strict/response.js.map +2 -2
- package/dist/schemas/v3.1/strict/responses.d.ts +1 -2461
- package/dist/schemas/v3.1/strict/responses.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/responses.js +5 -5
- package/dist/schemas/v3.1/strict/responses.js.map +2 -2
- package/dist/schemas/v3.1/strict/schema.d.ts +337 -192
- package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/schema.js +215 -207
- package/dist/schemas/v3.1/strict/schema.js.map +2 -2
- package/dist/schemas/v3.1/strict/security-requirement.d.ts +1 -3
- package/dist/schemas/v3.1/strict/security-requirement.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/security-requirement.js +3 -3
- package/dist/schemas/v3.1/strict/security-requirement.js.map +2 -2
- package/dist/schemas/v3.1/strict/security-scheme.d.ts +60 -130
- package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/security-scheme.js +5 -5
- package/dist/schemas/v3.1/strict/security-scheme.js.map +2 -2
- package/dist/schemas/v3.1/strict/server-variable.d.ts +4 -6
- package/dist/schemas/v3.1/strict/server-variable.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/server-variable.js +3 -3
- package/dist/schemas/v3.1/strict/server-variable.js.map +2 -2
- package/dist/schemas/v3.1/strict/server.d.ts +4 -10
- package/dist/schemas/v3.1/strict/server.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/server.js +5 -5
- package/dist/schemas/v3.1/strict/server.js.map +2 -2
- package/dist/schemas/v3.1/strict/tag.d.ts +10 -15
- package/dist/schemas/v3.1/strict/tag.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/tag.js +6 -6
- package/dist/schemas/v3.1/strict/tag.js.map +2 -2
- package/dist/schemas/v3.1/strict/xml.d.ts +6 -8
- package/dist/schemas/v3.1/strict/xml.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/xml.js +3 -3
- package/dist/schemas/v3.1/strict/xml.js.map +2 -2
- package/dist/schemas/workspace-specification/config.d.ts +1248 -47
- package/dist/schemas/workspace-specification/config.d.ts.map +1 -1
- package/dist/schemas/workspace-specification/config.js +1 -1
- package/dist/schemas/workspace-specification/config.js.map +2 -2
- package/dist/schemas/workspace-specification/index.d.ts +1260 -224
- package/dist/schemas/workspace-specification/index.d.ts.map +1 -1
- package/dist/schemas/workspace-specification/index.js +2 -3
- package/dist/schemas/workspace-specification/index.js.map +2 -2
- package/dist/schemas/workspace-specification/info.d.ts +3 -3
- package/dist/schemas/workspace-specification/info.js +1 -1
- package/dist/schemas/workspace-specification/info.js.map +1 -1
- package/dist/schemas/workspace.d.ts +8520 -199
- package/dist/schemas/workspace.d.ts.map +1 -1
- package/dist/schemas/workspace.js +6 -8
- package/dist/schemas/workspace.js.map +2 -2
- package/dist/schemas.d.ts +1 -1
- package/dist/schemas.d.ts.map +1 -1
- package/dist/schemas.js +1 -4
- package/dist/schemas.js.map +2 -2
- package/dist/server.d.ts +2 -4
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +7 -5
- package/dist/server.js.map +2 -2
- package/package.json +12 -6
- package/dist/schemas/typebox-types.d.ts +0 -14
- package/dist/schemas/typebox-types.d.ts.map +0 -1
- package/dist/schemas/typebox-types.js +0 -19
- package/dist/schemas/typebox-types.js.map +0 -7
- package/dist/schemas/v3.1/loose/callback.d.ts +0 -10
- package/dist/schemas/v3.1/loose/callback.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/callback.js +0 -11
- package/dist/schemas/v3.1/loose/callback.js.map +0 -7
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-cookies.d.ts +0 -16
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-cookies.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-cookies.js +0 -13
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-cookies.js.map +0 -7
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-environments.d.ts +0 -27
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-environments.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-environments.js +0 -23
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-environments.js.map +0 -7
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-request-example.d.ts +0 -38
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-request-example.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-request-example.js +0 -45
- package/dist/schemas/v3.1/loose/client-config-extensions/x-scalar-client-config-request-example.js.map +0 -7
- package/dist/schemas/v3.1/loose/components.d.ts +0 -43
- package/dist/schemas/v3.1/loose/components.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/components.js +0 -41
- package/dist/schemas/v3.1/loose/components.js.map +0 -7
- package/dist/schemas/v3.1/loose/contact.d.ts +0 -10
- package/dist/schemas/v3.1/loose/contact.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/contact.js +0 -13
- package/dist/schemas/v3.1/loose/contact.js.map +0 -7
- package/dist/schemas/v3.1/loose/discriminator.d.ts +0 -12
- package/dist/schemas/v3.1/loose/discriminator.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/discriminator.js +0 -11
- package/dist/schemas/v3.1/loose/discriminator.js.map +0 -7
- package/dist/schemas/v3.1/loose/encoding.d.ts +0 -15
- package/dist/schemas/v3.1/loose/encoding.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/encoding.js +0 -12
- package/dist/schemas/v3.1/loose/encoding.js.map +0 -7
- package/dist/schemas/v3.1/loose/example.d.ts +0 -16
- package/dist/schemas/v3.1/loose/example.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/example.js +0 -15
- package/dist/schemas/v3.1/loose/example.js.map +0 -7
- package/dist/schemas/v3.1/loose/external-documentation.d.ts +0 -8
- package/dist/schemas/v3.1/loose/external-documentation.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/external-documentation.js +0 -11
- package/dist/schemas/v3.1/loose/external-documentation.js.map +0 -7
- package/dist/schemas/v3.1/loose/header.d.ts +0 -355
- package/dist/schemas/v3.1/loose/header.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/header.js +0 -43
- package/dist/schemas/v3.1/loose/header.js.map +0 -7
- package/dist/schemas/v3.1/loose/info.d.ts +0 -48
- package/dist/schemas/v3.1/loose/info.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/info.js +0 -29
- package/dist/schemas/v3.1/loose/info.js.map +0 -7
- package/dist/schemas/v3.1/loose/license.d.ts +0 -10
- package/dist/schemas/v3.1/loose/license.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/license.js +0 -13
- package/dist/schemas/v3.1/loose/license.js.map +0 -7
- package/dist/schemas/v3.1/loose/link.d.ts +0 -30
- package/dist/schemas/v3.1/loose/link.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/link.js +0 -20
- package/dist/schemas/v3.1/loose/link.js.map +0 -7
- package/dist/schemas/v3.1/loose/media-header-encoding.d.ts +0 -1012
- package/dist/schemas/v3.1/loose/media-header-encoding.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/media-header-encoding.js +0 -19
- package/dist/schemas/v3.1/loose/media-header-encoding.js.map +0 -7
- package/dist/schemas/v3.1/loose/media-type.d.ts +0 -161
- package/dist/schemas/v3.1/loose/media-type.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/media-type.js +0 -18
- package/dist/schemas/v3.1/loose/media-type.js.map +0 -7
- package/dist/schemas/v3.1/loose/oauth-flow.d.ts +0 -95
- package/dist/schemas/v3.1/loose/oauth-flow.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/oauth-flow.js +0 -57
- package/dist/schemas/v3.1/loose/oauth-flow.js.map +0 -7
- package/dist/schemas/v3.1/loose/oauthflows.d.ts +0 -43
- package/dist/schemas/v3.1/loose/oauthflows.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/oauthflows.js +0 -21
- package/dist/schemas/v3.1/loose/oauthflows.js.map +0 -7
- package/dist/schemas/v3.1/loose/openapi-document.d.ts +0 -115
- package/dist/schemas/v3.1/loose/openapi-document.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/openapi-document.js +0 -64
- package/dist/schemas/v3.1/loose/openapi-document.js.map +0 -7
- package/dist/schemas/v3.1/loose/operation.d.ts +0 -1645
- package/dist/schemas/v3.1/loose/operation.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/operation.js +0 -61
- package/dist/schemas/v3.1/loose/operation.js.map +0 -7
- package/dist/schemas/v3.1/loose/parameter.d.ts +0 -1074
- package/dist/schemas/v3.1/loose/parameter.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/parameter.js +0 -54
- package/dist/schemas/v3.1/loose/parameter.js.map +0 -7
- package/dist/schemas/v3.1/loose/path-item.d.ts +0 -551
- package/dist/schemas/v3.1/loose/path-item.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/path-item.js +0 -42
- package/dist/schemas/v3.1/loose/path-item.js.map +0 -7
- package/dist/schemas/v3.1/loose/path-operations.d.ts +0 -2196
- package/dist/schemas/v3.1/loose/path-operations.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/path-operations.js +0 -21
- package/dist/schemas/v3.1/loose/path-operations.js.map +0 -7
- package/dist/schemas/v3.1/loose/paths.d.ts +0 -20
- package/dist/schemas/v3.1/loose/paths.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/paths.js +0 -11
- package/dist/schemas/v3.1/loose/paths.js.map +0 -7
- package/dist/schemas/v3.1/loose/reference.d.ts +0 -26
- package/dist/schemas/v3.1/loose/reference.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/reference.js +0 -24
- package/dist/schemas/v3.1/loose/reference.js.map +0 -7
- package/dist/schemas/v3.1/loose/request-body.d.ts +0 -339
- package/dist/schemas/v3.1/loose/request-body.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/request-body.js +0 -14
- package/dist/schemas/v3.1/loose/request-body.js.map +0 -7
- package/dist/schemas/v3.1/loose/response.d.ts +0 -698
- package/dist/schemas/v3.1/loose/response.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/response.js +0 -18
- package/dist/schemas/v3.1/loose/response.js.map +0 -7
- package/dist/schemas/v3.1/loose/responses.d.ts +0 -710
- package/dist/schemas/v3.1/loose/responses.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/responses.js +0 -11
- package/dist/schemas/v3.1/loose/responses.js.map +0 -7
- package/dist/schemas/v3.1/loose/schema.d.ts +0 -373
- package/dist/schemas/v3.1/loose/schema.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/schema.js +0 -146
- package/dist/schemas/v3.1/loose/schema.js.map +0 -7
- package/dist/schemas/v3.1/loose/security-requirement.d.ts +0 -11
- package/dist/schemas/v3.1/loose/security-requirement.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/security-requirement.js +0 -10
- package/dist/schemas/v3.1/loose/security-requirement.js.map +0 -7
- package/dist/schemas/v3.1/loose/security-scheme.d.ts +0 -169
- package/dist/schemas/v3.1/loose/security-scheme.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/security-scheme.js +0 -64
- package/dist/schemas/v3.1/loose/security-scheme.js.map +0 -7
- package/dist/schemas/v3.1/loose/server-variable.d.ts +0 -10
- package/dist/schemas/v3.1/loose/server-variable.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/server-variable.js +0 -13
- package/dist/schemas/v3.1/loose/server-variable.js.map +0 -7
- package/dist/schemas/v3.1/loose/server.d.ts +0 -14
- package/dist/schemas/v3.1/loose/server.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/server.js +0 -14
- package/dist/schemas/v3.1/loose/server.js.map +0 -7
- package/dist/schemas/v3.1/loose/tag.d.ts +0 -19
- package/dist/schemas/v3.1/loose/tag.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/tag.js +0 -23
- package/dist/schemas/v3.1/loose/tag.js.map +0 -7
- package/dist/schemas/v3.1/loose/xml.d.ts +0 -18
- package/dist/schemas/v3.1/loose/xml.d.ts.map +0 -1
- package/dist/schemas/v3.1/loose/xml.js +0 -17
- package/dist/schemas/v3.1/loose/xml.js.map +0 -7
- package/dist/schemas/v3.1/strict/media-header-encoding.d.ts +0 -1560
- package/dist/schemas/v3.1/strict/media-header-encoding.d.ts.map +0 -1
- package/dist/schemas/v3.1/strict/media-header-encoding.js +0 -19
- package/dist/schemas/v3.1/strict/media-header-encoding.js.map +0 -7
- package/dist/schemas/v3.1/strict/path-operations.d.ts +0 -10628
- package/dist/schemas/v3.1/strict/path-operations.d.ts.map +0 -1
- package/dist/schemas/v3.1/strict/path-operations.js +0 -21
- package/dist/schemas/v3.1/strict/path-operations.js.map +0 -7
|
@@ -1,260 +1,405 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import
|
|
4
|
-
|
|
5
|
-
import { XAdditionalPropertiesNameSchema } from '../../../schemas/extensions/schema/x-additional-properties-name.js';
|
|
6
|
-
/**
|
|
7
|
-
* Builds the recursive schema schema
|
|
8
|
-
*
|
|
9
|
-
* We hit the typescript limit if we type this out correctly with the sub schemas (string, number etc)
|
|
10
|
-
*/
|
|
11
|
-
export declare const schemaObjectSchemaBuilder: <S extends TSchema>(schema: S) => TIntersect<[TIntersect<[TObject<{
|
|
12
|
-
type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"null">, import("@sinclair/typebox").TLiteral<"boolean">, import("@sinclair/typebox").TLiteral<"string">, import("@sinclair/typebox").TLiteral<"number">, import("@sinclair/typebox").TLiteral<"integer">, import("@sinclair/typebox").TLiteral<"object">, import("@sinclair/typebox").TLiteral<"array">, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"null">, import("@sinclair/typebox").TLiteral<"boolean">, import("@sinclair/typebox").TLiteral<"string">, import("@sinclair/typebox").TLiteral<"number">, import("@sinclair/typebox").TLiteral<"integer">, import("@sinclair/typebox").TLiteral<"object">, import("@sinclair/typebox").TLiteral<"array">]>>]>>;
|
|
13
|
-
/** Different subtypes */
|
|
14
|
-
format: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
1
|
+
/** Builds the recursive schema schema */
|
|
2
|
+
export declare const SchemaObjectSchemaDefinition: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
3
|
+
_: import("@scalar/typebox").TString;
|
|
4
|
+
}>, import("@scalar/typebox").TObject<{
|
|
15
5
|
/** A title for the schema. */
|
|
16
|
-
title: import("@
|
|
6
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
17
7
|
/** A description of the schema. */
|
|
18
|
-
description: import("@
|
|
8
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
19
9
|
/** Default value for the schema. */
|
|
20
|
-
default: import("@
|
|
10
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
21
11
|
/** Array of allowed values. */
|
|
22
|
-
enum: import("@
|
|
12
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
23
13
|
/** Constant value that must match exactly. */
|
|
24
|
-
const: import("@
|
|
14
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
15
|
+
/** Media type for content validation. */
|
|
16
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
17
|
+
/** Content encoding. */
|
|
18
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
19
|
+
/** Schema for content validation. */
|
|
20
|
+
contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
21
|
+
/** Whether the schema is deprecated. */
|
|
22
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
23
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
24
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
25
|
+
/** Whether the schema is read-only. */
|
|
26
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
27
|
+
/** Whether the schema is write-only. */
|
|
28
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
29
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
30
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
31
|
+
/** Additional external documentation for this schema. */
|
|
32
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
33
|
+
/**
|
|
34
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
35
|
+
*
|
|
36
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
37
|
+
*/
|
|
38
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
39
|
+
/**
|
|
40
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
41
|
+
* Each example should be a valid instance of the schema.
|
|
42
|
+
*/
|
|
43
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
25
44
|
/** All schemas must be valid. */
|
|
26
|
-
allOf: import("@
|
|
45
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
27
46
|
/** Exactly one schema must be valid. */
|
|
28
|
-
oneOf: import("@
|
|
47
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
29
48
|
/** At least one schema must be valid. */
|
|
30
|
-
anyOf: import("@
|
|
49
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
31
50
|
/** Schema must not be valid. */
|
|
32
|
-
not: import("@
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
51
|
+
not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
52
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
53
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
54
|
+
}>, import("@scalar/typebox").TObject<{
|
|
55
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
56
|
+
}>, import("@scalar/typebox").TObject<{
|
|
57
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
58
|
+
}>, import("@scalar/typebox").TObject<{
|
|
59
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
60
|
+
}>, import("@scalar/typebox").TObject<{
|
|
61
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
62
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
63
|
+
type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"null">, import("@scalar/typebox").TLiteral<"boolean">, import("@scalar/typebox").TLiteral<"string">, import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">, import("@scalar/typebox").TLiteral<"object">, import("@scalar/typebox").TLiteral<"array">]>>]>;
|
|
64
|
+
}>, import("@scalar/typebox").TObject<{
|
|
65
|
+
/** A title for the schema. */
|
|
66
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
67
|
+
/** A description of the schema. */
|
|
68
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
69
|
+
/** Default value for the schema. */
|
|
70
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
71
|
+
/** Array of allowed values. */
|
|
72
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
73
|
+
/** Constant value that must match exactly. */
|
|
74
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
40
75
|
/** Media type for content validation. */
|
|
41
|
-
contentMediaType: import("@
|
|
76
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
42
77
|
/** Content encoding. */
|
|
43
|
-
contentEncoding: import("@
|
|
78
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
44
79
|
/** Schema for content validation. */
|
|
45
|
-
contentSchema: import("@
|
|
80
|
+
contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
46
81
|
/** Whether the schema is deprecated. */
|
|
47
|
-
deprecated: import("@
|
|
82
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
48
83
|
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
49
|
-
discriminator: import("@
|
|
50
|
-
propertyName: import("@sinclair/typebox").TString;
|
|
51
|
-
mapping: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>>;
|
|
52
|
-
}>>;
|
|
84
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
53
85
|
/** Whether the schema is read-only. */
|
|
54
|
-
readOnly: import("@
|
|
86
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
55
87
|
/** Whether the schema is write-only. */
|
|
56
|
-
writeOnly: import("@
|
|
88
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
57
89
|
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
58
|
-
xml: import("@
|
|
59
|
-
name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
60
|
-
namespace: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
61
|
-
prefix: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
62
|
-
attribute: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
63
|
-
wrapped: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
64
|
-
}>>;
|
|
90
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
65
91
|
/** Additional external documentation for this schema. */
|
|
66
|
-
externalDocs: import("@
|
|
67
|
-
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
68
|
-
url: import("@sinclair/typebox").TString;
|
|
69
|
-
}>>;
|
|
92
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
70
93
|
/**
|
|
71
94
|
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
72
95
|
*
|
|
73
96
|
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
74
97
|
*/
|
|
75
|
-
example: import("@
|
|
98
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
76
99
|
/**
|
|
77
100
|
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
78
101
|
* Each example should be a valid instance of the schema.
|
|
79
102
|
*/
|
|
80
|
-
examples: import("@
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
patternProperties: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnion<[S, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<S>]>>>;
|
|
104
|
-
/** Maximum string length. */
|
|
105
|
-
maxLength: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TInteger>;
|
|
106
|
-
/** Minimum string length. */
|
|
107
|
-
minLength: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TInteger>;
|
|
108
|
-
/** Regular expression pattern. */
|
|
109
|
-
pattern: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
103
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
104
|
+
/** All schemas must be valid. */
|
|
105
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
106
|
+
/** Exactly one schema must be valid. */
|
|
107
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
108
|
+
/** At least one schema must be valid. */
|
|
109
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
110
|
+
/** Schema must not be valid. */
|
|
111
|
+
not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
112
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
113
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
114
|
+
}>, import("@scalar/typebox").TObject<{
|
|
115
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
116
|
+
}>, import("@scalar/typebox").TObject<{
|
|
117
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
118
|
+
}>, import("@scalar/typebox").TObject<{
|
|
119
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
120
|
+
}>, import("@scalar/typebox").TObject<{
|
|
121
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
122
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
123
|
+
type: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"number">, import("@scalar/typebox").TLiteral<"integer">]>;
|
|
124
|
+
/** Different subtypes */
|
|
125
|
+
format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"int8">, import("@scalar/typebox").TLiteral<"int16">, import("@scalar/typebox").TLiteral<"int32">, import("@scalar/typebox").TLiteral<"int64">, import("@scalar/typebox").TLiteral<"uint8">, import("@scalar/typebox").TLiteral<"uint16">, import("@scalar/typebox").TLiteral<"uint32">, import("@scalar/typebox").TLiteral<"uint64">, import("@scalar/typebox").TLiteral<"double-int">, import("@scalar/typebox").TLiteral<"float">, import("@scalar/typebox").TLiteral<"double">, import("@scalar/typebox").TLiteral<"decimal">, import("@scalar/typebox").TLiteral<"decimal128">, import("@scalar/typebox").TLiteral<"sf-integer">, import("@scalar/typebox").TLiteral<"sf-decimal">]>>;
|
|
110
126
|
/** Number must be a multiple of this value. */
|
|
111
|
-
multipleOf: import("@
|
|
127
|
+
multipleOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
112
128
|
/** Maximum value (inclusive). */
|
|
113
|
-
maximum: import("@
|
|
129
|
+
maximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
114
130
|
/** Maximum value (exclusive). */
|
|
115
|
-
exclusiveMaximum: import("@
|
|
131
|
+
exclusiveMaximum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TBoolean, import("@scalar/typebox").TNumber]>>;
|
|
116
132
|
/** Minimum value (inclusive). */
|
|
117
|
-
minimum: import("@
|
|
133
|
+
minimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TNumber>;
|
|
118
134
|
/** Minimum value (exclusive). */
|
|
119
|
-
exclusiveMinimum: import("@
|
|
120
|
-
}>, TObject<{
|
|
121
|
-
'x-scalar-ignore': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
122
|
-
}>, TObject<{
|
|
123
|
-
'x-internal': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
124
|
-
}>, TObject<{
|
|
125
|
-
'x-variable': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
126
|
-
}>, TObject<{
|
|
127
|
-
'x-additionalPropertiesName': import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
128
|
-
}>]>, typeof XScalarIgnoreSchema, typeof XInternalSchema, typeof XVariableSchema, typeof XAdditionalPropertiesNameSchema, TObject<{
|
|
129
|
-
_resolvedRefSchema: TAny;
|
|
130
|
-
}>]>;
|
|
131
|
-
export declare const SchemaObjectSchema: import("@sinclair/typebox").TRecursive<TIntersect<[TIntersect<[TObject<{
|
|
132
|
-
type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"null">, import("@sinclair/typebox").TLiteral<"boolean">, import("@sinclair/typebox").TLiteral<"string">, import("@sinclair/typebox").TLiteral<"number">, import("@sinclair/typebox").TLiteral<"integer">, import("@sinclair/typebox").TLiteral<"object">, import("@sinclair/typebox").TLiteral<"array">, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"null">, import("@sinclair/typebox").TLiteral<"boolean">, import("@sinclair/typebox").TLiteral<"string">, import("@sinclair/typebox").TLiteral<"number">, import("@sinclair/typebox").TLiteral<"integer">, import("@sinclair/typebox").TLiteral<"object">, import("@sinclair/typebox").TLiteral<"array">]>>]>>;
|
|
133
|
-
/** Different subtypes */
|
|
134
|
-
format: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
135
|
+
exclusiveMinimum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TBoolean, import("@scalar/typebox").TNumber]>>;
|
|
136
|
+
}>, import("@scalar/typebox").TObject<{
|
|
135
137
|
/** A title for the schema. */
|
|
136
|
-
title: import("@
|
|
138
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
137
139
|
/** A description of the schema. */
|
|
138
|
-
description: import("@
|
|
140
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
139
141
|
/** Default value for the schema. */
|
|
140
|
-
default: import("@
|
|
142
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
141
143
|
/** Array of allowed values. */
|
|
142
|
-
enum: import("@
|
|
144
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
143
145
|
/** Constant value that must match exactly. */
|
|
144
|
-
const: import("@
|
|
146
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
147
|
+
/** Media type for content validation. */
|
|
148
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
149
|
+
/** Content encoding. */
|
|
150
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
151
|
+
/** Schema for content validation. */
|
|
152
|
+
contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
153
|
+
/** Whether the schema is deprecated. */
|
|
154
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
155
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
156
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
157
|
+
/** Whether the schema is read-only. */
|
|
158
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
159
|
+
/** Whether the schema is write-only. */
|
|
160
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
161
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
162
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
163
|
+
/** Additional external documentation for this schema. */
|
|
164
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
165
|
+
/**
|
|
166
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
167
|
+
*
|
|
168
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
169
|
+
*/
|
|
170
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
171
|
+
/**
|
|
172
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
173
|
+
* Each example should be a valid instance of the schema.
|
|
174
|
+
*/
|
|
175
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
145
176
|
/** All schemas must be valid. */
|
|
146
|
-
allOf: import("@
|
|
177
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
147
178
|
/** Exactly one schema must be valid. */
|
|
148
|
-
oneOf: import("@
|
|
179
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
149
180
|
/** At least one schema must be valid. */
|
|
150
|
-
anyOf: import("@
|
|
181
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
151
182
|
/** Schema must not be valid. */
|
|
152
|
-
not: import("@
|
|
183
|
+
not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
184
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
185
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
186
|
+
}>, import("@scalar/typebox").TObject<{
|
|
187
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
188
|
+
}>, import("@scalar/typebox").TObject<{
|
|
189
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
190
|
+
}>, import("@scalar/typebox").TObject<{
|
|
191
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
192
|
+
}>, import("@scalar/typebox").TObject<{
|
|
193
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
194
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
195
|
+
type: import("@scalar/typebox").TLiteral<"string">;
|
|
196
|
+
/** Different subtypes */
|
|
197
|
+
format: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"date">, import("@scalar/typebox").TLiteral<"date-time">, import("@scalar/typebox").TLiteral<"date-time-local">, import("@scalar/typebox").TLiteral<"time">, import("@scalar/typebox").TLiteral<"time-local">, import("@scalar/typebox").TLiteral<"duration">, import("@scalar/typebox").TLiteral<"http-date">, import("@scalar/typebox").TLiteral<"email">, import("@scalar/typebox").TLiteral<"idn-email">, import("@scalar/typebox").TLiteral<"hostname">, import("@scalar/typebox").TLiteral<"idn-hostname">, import("@scalar/typebox").TLiteral<"ipv4">, import("@scalar/typebox").TLiteral<"ipv6">, import("@scalar/typebox").TLiteral<"uri">, import("@scalar/typebox").TLiteral<"uri-reference">, import("@scalar/typebox").TLiteral<"uri-template">, import("@scalar/typebox").TLiteral<"iri">, import("@scalar/typebox").TLiteral<"iri-reference">, import("@scalar/typebox").TLiteral<"uuid">, import("@scalar/typebox").TLiteral<"binary">, import("@scalar/typebox").TLiteral<"byte">, import("@scalar/typebox").TLiteral<"base64url">, import("@scalar/typebox").TLiteral<"html">, import("@scalar/typebox").TLiteral<"commonmark">, import("@scalar/typebox").TLiteral<"password">, import("@scalar/typebox").TLiteral<"regex">, import("@scalar/typebox").TLiteral<"json-pointer">, import("@scalar/typebox").TLiteral<"relative-json-pointer">, import("@scalar/typebox").TLiteral<"media-range">, import("@scalar/typebox").TLiteral<"char">, import("@scalar/typebox").TLiteral<"sf-string">, import("@scalar/typebox").TLiteral<"sf-token">, import("@scalar/typebox").TLiteral<"sf-binary">, import("@scalar/typebox").TLiteral<"sf-boolean">]>>;
|
|
198
|
+
/** Maximum string length. */
|
|
199
|
+
maxLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
200
|
+
/** Minimum string length. */
|
|
201
|
+
minLength: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
202
|
+
/** Regular expression pattern. */
|
|
203
|
+
pattern: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
204
|
+
}>, import("@scalar/typebox").TObject<{
|
|
205
|
+
/** A title for the schema. */
|
|
206
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
207
|
+
/** A description of the schema. */
|
|
208
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
209
|
+
/** Default value for the schema. */
|
|
210
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
211
|
+
/** Array of allowed values. */
|
|
212
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
213
|
+
/** Constant value that must match exactly. */
|
|
214
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
215
|
+
/** Media type for content validation. */
|
|
216
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
217
|
+
/** Content encoding. */
|
|
218
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
219
|
+
/** Schema for content validation. */
|
|
220
|
+
contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
221
|
+
/** Whether the schema is deprecated. */
|
|
222
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
223
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
224
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
225
|
+
/** Whether the schema is read-only. */
|
|
226
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
227
|
+
/** Whether the schema is write-only. */
|
|
228
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
229
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
230
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
231
|
+
/** Additional external documentation for this schema. */
|
|
232
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
153
233
|
/**
|
|
154
|
-
*
|
|
234
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
155
235
|
*
|
|
156
|
-
* @deprecated
|
|
157
|
-
* @see https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
|
|
236
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
158
237
|
*/
|
|
159
|
-
|
|
238
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
239
|
+
/**
|
|
240
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
241
|
+
* Each example should be a valid instance of the schema.
|
|
242
|
+
*/
|
|
243
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
244
|
+
/** All schemas must be valid. */
|
|
245
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
246
|
+
/** Exactly one schema must be valid. */
|
|
247
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
248
|
+
/** At least one schema must be valid. */
|
|
249
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
250
|
+
/** Schema must not be valid. */
|
|
251
|
+
not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
252
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
253
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
254
|
+
}>, import("@scalar/typebox").TObject<{
|
|
255
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
256
|
+
}>, import("@scalar/typebox").TObject<{
|
|
257
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
258
|
+
}>, import("@scalar/typebox").TObject<{
|
|
259
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
260
|
+
}>, import("@scalar/typebox").TObject<{
|
|
261
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
262
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
263
|
+
type: import("@scalar/typebox").TLiteral<"object">;
|
|
264
|
+
/** Maximum number of properties. */
|
|
265
|
+
maxProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
266
|
+
/** Minimum number of properties. */
|
|
267
|
+
minProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
268
|
+
/** Array of required property names. */
|
|
269
|
+
required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
270
|
+
/** Object property definitions. */
|
|
271
|
+
properties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
272
|
+
/** Schema for additional properties. */
|
|
273
|
+
additionalProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TBoolean, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>]>>;
|
|
274
|
+
/** Properties matching regex patterns. */
|
|
275
|
+
patternProperties: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
276
|
+
}>, import("@scalar/typebox").TObject<{
|
|
277
|
+
/** A title for the schema. */
|
|
278
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
279
|
+
/** A description of the schema. */
|
|
280
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
281
|
+
/** Default value for the schema. */
|
|
282
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
283
|
+
/** Array of allowed values. */
|
|
284
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
285
|
+
/** Constant value that must match exactly. */
|
|
286
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
160
287
|
/** Media type for content validation. */
|
|
161
|
-
contentMediaType: import("@
|
|
288
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
162
289
|
/** Content encoding. */
|
|
163
|
-
contentEncoding: import("@
|
|
290
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
164
291
|
/** Schema for content validation. */
|
|
165
|
-
contentSchema: import("@
|
|
292
|
+
contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
166
293
|
/** Whether the schema is deprecated. */
|
|
167
|
-
deprecated: import("@
|
|
294
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
168
295
|
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
169
|
-
discriminator: import("@
|
|
170
|
-
propertyName: import("@sinclair/typebox").TString;
|
|
171
|
-
mapping: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>>;
|
|
172
|
-
}>>;
|
|
296
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
173
297
|
/** Whether the schema is read-only. */
|
|
174
|
-
readOnly: import("@
|
|
298
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
175
299
|
/** Whether the schema is write-only. */
|
|
176
|
-
writeOnly: import("@
|
|
300
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
177
301
|
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
178
|
-
xml: import("@
|
|
179
|
-
name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
180
|
-
namespace: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
181
|
-
prefix: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
182
|
-
attribute: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
183
|
-
wrapped: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
|
|
184
|
-
}>>;
|
|
302
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
185
303
|
/** Additional external documentation for this schema. */
|
|
186
|
-
externalDocs: import("@
|
|
187
|
-
description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
|
|
188
|
-
url: import("@sinclair/typebox").TString;
|
|
189
|
-
}>>;
|
|
304
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
190
305
|
/**
|
|
191
306
|
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
192
307
|
*
|
|
193
308
|
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
194
309
|
*/
|
|
195
|
-
example: import("@
|
|
310
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
196
311
|
/**
|
|
197
312
|
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
198
313
|
* Each example should be a valid instance of the schema.
|
|
199
314
|
*/
|
|
200
|
-
examples: import("@
|
|
201
|
-
|
|
315
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
316
|
+
/** All schemas must be valid. */
|
|
317
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
318
|
+
/** Exactly one schema must be valid. */
|
|
319
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
320
|
+
/** At least one schema must be valid. */
|
|
321
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
322
|
+
/** Schema must not be valid. */
|
|
323
|
+
not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
324
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
325
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
326
|
+
}>, import("@scalar/typebox").TObject<{
|
|
327
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
328
|
+
}>, import("@scalar/typebox").TObject<{
|
|
329
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
330
|
+
}>, import("@scalar/typebox").TObject<{
|
|
331
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
332
|
+
}>, import("@scalar/typebox").TObject<{
|
|
333
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
334
|
+
}>]>]>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
335
|
+
type: import("@scalar/typebox").TLiteral<"array">;
|
|
202
336
|
/** Maximum number of items in array. */
|
|
203
|
-
maxItems: import("@
|
|
337
|
+
maxItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
204
338
|
/** Minimum number of items in array. */
|
|
205
|
-
minItems: import("@
|
|
339
|
+
minItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TInteger>;
|
|
206
340
|
/** Whether array items must be unique. */
|
|
207
|
-
uniqueItems: import("@
|
|
341
|
+
uniqueItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
208
342
|
/** Schema for array items. */
|
|
209
|
-
items: import("@
|
|
343
|
+
items: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
210
344
|
/** Schema for tuple validation. */
|
|
211
|
-
prefixItems: import("@
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
345
|
+
prefixItems: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
346
|
+
}>, import("@scalar/typebox").TObject<{
|
|
347
|
+
/** A title for the schema. */
|
|
348
|
+
title: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
349
|
+
/** A description of the schema. */
|
|
350
|
+
description: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
351
|
+
/** Default value for the schema. */
|
|
352
|
+
default: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
353
|
+
/** Array of allowed values. */
|
|
354
|
+
enum: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
355
|
+
/** Constant value that must match exactly. */
|
|
356
|
+
const: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
357
|
+
/** Media type for content validation. */
|
|
358
|
+
contentMediaType: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
359
|
+
/** Content encoding. */
|
|
360
|
+
contentEncoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
361
|
+
/** Schema for content validation. */
|
|
362
|
+
contentSchema: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
363
|
+
/** Whether the schema is deprecated. */
|
|
364
|
+
deprecated: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
365
|
+
/** Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See Composition and Inheritance for more details. */
|
|
366
|
+
discriminator: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"DiscriminatorObject">>;
|
|
367
|
+
/** Whether the schema is read-only. */
|
|
368
|
+
readOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
369
|
+
/** Whether the schema is write-only. */
|
|
370
|
+
writeOnly: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
371
|
+
/** This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. */
|
|
372
|
+
xml: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"XMLObject">>;
|
|
373
|
+
/** Additional external documentation for this schema. */
|
|
374
|
+
externalDocs: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ExternalDocumentationObject">>;
|
|
375
|
+
/**
|
|
376
|
+
* A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
|
|
377
|
+
*
|
|
378
|
+
* @deprecated The example field has been deprecated in favor of the JSON Schema examples keyword. Use of example is discouraged, and later versions of this specification may remove it.
|
|
379
|
+
*/
|
|
380
|
+
example: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnknown>;
|
|
381
|
+
/**
|
|
382
|
+
* An array of examples of valid instances for this schema. This keyword follows the JSON Schema Draft 2020-12 specification.
|
|
383
|
+
* Each example should be a valid instance of the schema.
|
|
384
|
+
*/
|
|
385
|
+
examples: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnknown>>;
|
|
386
|
+
/** All schemas must be valid. */
|
|
387
|
+
allOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
388
|
+
/** Exactly one schema must be valid. */
|
|
389
|
+
oneOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
390
|
+
/** At least one schema must be valid. */
|
|
391
|
+
anyOf: import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>>;
|
|
392
|
+
/** Schema must not be valid. */
|
|
393
|
+
not: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TRef<"SchemaObject">, import("../../../schemas/v3.1/strict/reference.js").ReferenceType<import("@scalar/typebox").TRef<"SchemaObject">>]>>;
|
|
394
|
+
}>, import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
|
|
395
|
+
'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
396
|
+
}>, import("@scalar/typebox").TObject<{
|
|
397
|
+
'x-internal': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
|
|
398
|
+
}>, import("@scalar/typebox").TObject<{
|
|
399
|
+
'x-variable': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
400
|
+
}>, import("@scalar/typebox").TObject<{
|
|
401
|
+
'x-additionalPropertiesName': import("@scalar/typebox").TOptional<import("@scalar/typebox").TString>;
|
|
402
|
+
}>, import("@scalar/typebox").TObject<{
|
|
403
|
+
'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
|
|
404
|
+
}>]>]>]>;
|
|
260
405
|
//# sourceMappingURL=schema.d.ts.map
|