@scalar/schemas 0.2.0 → 0.3.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 +19 -0
- package/dist/api-reference/api-reference-configuration.d.ts +18 -16
- package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
- package/dist/api-reference/api-reference-configuration.js +11 -1
- package/dist/api-reference/base-configuration.d.ts +6 -6
- package/dist/api-reference/source-configuration.d.ts +2 -2
- package/dist/api-reference/source-configuration.d.ts.map +1 -1
- package/dist/asyncapi/3.1/asyncapi-object.d.ts +50 -0
- package/dist/asyncapi/3.1/asyncapi-object.d.ts.map +1 -0
- package/dist/asyncapi/3.1/asyncapi-object.js +48 -0
- package/dist/asyncapi/3.1/bindings.d.ts +6 -0
- package/dist/asyncapi/3.1/bindings.d.ts.map +1 -0
- package/dist/asyncapi/3.1/bindings.js +42 -0
- package/dist/asyncapi/3.1/channel.d.ts +4 -0
- package/dist/asyncapi/3.1/channel.d.ts.map +1 -0
- package/dist/asyncapi/3.1/channel.js +29 -0
- package/dist/asyncapi/3.1/components.d.ts +22 -0
- package/dist/asyncapi/3.1/components.d.ts.map +1 -0
- package/dist/asyncapi/3.1/components.js +44 -0
- package/dist/asyncapi/3.1/contact.d.ts +6 -0
- package/dist/asyncapi/3.1/contact.d.ts.map +1 -0
- package/dist/asyncapi/3.1/contact.js +8 -0
- package/dist/asyncapi/3.1/correlation-id.d.ts +3 -0
- package/dist/asyncapi/3.1/correlation-id.d.ts.map +1 -0
- package/dist/asyncapi/3.1/correlation-id.js +11 -0
- package/dist/asyncapi/3.1/external-documentation.d.ts +3 -0
- package/dist/asyncapi/3.1/external-documentation.d.ts.map +1 -0
- package/dist/asyncapi/3.1/external-documentation.js +11 -0
- package/dist/asyncapi/3.1/index.d.ts +26 -0
- package/dist/asyncapi/3.1/index.d.ts.map +1 -0
- package/dist/asyncapi/3.1/index.js +25 -0
- package/dist/asyncapi/3.1/info.d.ts +15 -0
- package/dist/asyncapi/3.1/info.d.ts.map +1 -0
- package/dist/asyncapi/3.1/info.js +19 -0
- package/dist/asyncapi/3.1/license.d.ts +3 -0
- package/dist/asyncapi/3.1/license.d.ts.map +1 -0
- package/dist/asyncapi/3.1/license.js +9 -0
- package/dist/asyncapi/3.1/message-example.d.ts +7 -0
- package/dist/asyncapi/3.1/message-example.d.ts.map +1 -0
- package/dist/asyncapi/3.1/message-example.js +9 -0
- package/dist/asyncapi/3.1/message-trait.d.ts +3 -0
- package/dist/asyncapi/3.1/message-trait.d.ts.map +1 -0
- package/dist/asyncapi/3.1/message-trait.js +26 -0
- package/dist/asyncapi/3.1/message.d.ts +4 -0
- package/dist/asyncapi/3.1/message.d.ts.map +1 -0
- package/dist/asyncapi/3.1/message.js +33 -0
- package/dist/asyncapi/3.1/oauth.d.ts +13 -0
- package/dist/asyncapi/3.1/oauth.d.ts.map +1 -0
- package/dist/asyncapi/3.1/oauth.js +22 -0
- package/dist/asyncapi/3.1/operation-reply-address.d.ts +3 -0
- package/dist/asyncapi/3.1/operation-reply-address.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation-reply-address.js +11 -0
- package/dist/asyncapi/3.1/operation-reply.d.ts +3 -0
- package/dist/asyncapi/3.1/operation-reply.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation-reply.js +13 -0
- package/dist/asyncapi/3.1/operation-trait.d.ts +3 -0
- package/dist/asyncapi/3.1/operation-trait.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation-trait.js +20 -0
- package/dist/asyncapi/3.1/operation.d.ts +4 -0
- package/dist/asyncapi/3.1/operation.d.ts.map +1 -0
- package/dist/asyncapi/3.1/operation.js +37 -0
- package/dist/asyncapi/3.1/parameter.d.ts +3 -0
- package/dist/asyncapi/3.1/parameter.d.ts.map +1 -0
- package/dist/asyncapi/3.1/parameter.js +14 -0
- package/dist/asyncapi/3.1/parameters.d.ts +2 -0
- package/dist/asyncapi/3.1/parameters.d.ts.map +1 -0
- package/dist/asyncapi/3.1/parameters.js +6 -0
- package/dist/asyncapi/3.1/reference.d.ts +25 -0
- package/dist/asyncapi/3.1/reference.d.ts.map +1 -0
- package/dist/asyncapi/3.1/reference.js +25 -0
- package/dist/asyncapi/3.1/schema-payload.d.ts +7 -0
- package/dist/asyncapi/3.1/schema-payload.d.ts.map +1 -0
- package/dist/asyncapi/3.1/schema-payload.js +22 -0
- package/dist/asyncapi/3.1/security-scheme.d.ts +3 -0
- package/dist/asyncapi/3.1/security-scheme.d.ts.map +1 -0
- package/dist/asyncapi/3.1/security-scheme.js +39 -0
- package/dist/asyncapi/3.1/server-variable.d.ts +3 -0
- package/dist/asyncapi/3.1/server-variable.d.ts.map +1 -0
- package/dist/asyncapi/3.1/server-variable.js +13 -0
- package/dist/asyncapi/3.1/server.d.ts +4 -0
- package/dist/asyncapi/3.1/server.d.ts.map +1 -0
- package/dist/asyncapi/3.1/server.js +36 -0
- package/dist/asyncapi/3.1/tag.d.ts +4 -0
- package/dist/asyncapi/3.1/tag.d.ts.map +1 -0
- package/dist/asyncapi/3.1/tag.js +15 -0
- package/dist/extensions/document/index.d.ts +21 -0
- package/dist/extensions/document/index.d.ts.map +1 -0
- package/dist/extensions/document/index.js +20 -0
- package/dist/extensions/document/x-internal.d.ts +4 -0
- package/dist/extensions/document/x-internal.d.ts.map +1 -0
- package/dist/extensions/document/x-internal.js +11 -0
- package/dist/extensions/document/x-original-aas-version.d.ts +4 -0
- package/dist/extensions/document/x-original-aas-version.d.ts.map +1 -0
- package/dist/extensions/document/x-original-aas-version.js +8 -0
- package/dist/extensions/document/x-original-oas-version.d.ts +4 -0
- package/dist/extensions/document/x-original-oas-version.d.ts.map +1 -0
- package/dist/extensions/document/x-original-oas-version.js +8 -0
- package/dist/extensions/document/x-scalar-environments.d.ts +34 -0
- package/dist/extensions/document/x-scalar-environments.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-environments.js +41 -0
- package/dist/extensions/document/x-scalar-icon.d.ts +4 -0
- package/dist/extensions/document/x-scalar-icon.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-icon.js +11 -0
- package/dist/extensions/document/x-scalar-ignore.d.ts +5 -0
- package/dist/extensions/document/x-scalar-ignore.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-ignore.js +12 -0
- package/dist/extensions/document/x-scalar-is-dirty.d.ts +4 -0
- package/dist/extensions/document/x-scalar-is-dirty.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-is-dirty.js +13 -0
- package/dist/extensions/document/x-scalar-navigation.d.ts +4 -0
- package/dist/extensions/document/x-scalar-navigation.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-navigation.js +9 -0
- package/dist/extensions/document/x-scalar-original-document-hash.d.ts +4 -0
- package/dist/extensions/document/x-scalar-original-document-hash.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-original-document-hash.js +10 -0
- package/dist/extensions/document/x-scalar-original-source-url.d.ts +4 -0
- package/dist/extensions/document/x-scalar-original-source-url.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-original-source-url.js +8 -0
- package/dist/extensions/document/x-scalar-registry-meta.d.ts +11 -0
- package/dist/extensions/document/x-scalar-registry-meta.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-registry-meta.js +31 -0
- package/dist/extensions/document/x-scalar-sdk-installation.d.ts +8 -0
- package/dist/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-sdk-installation.js +23 -0
- package/dist/extensions/document/x-scalar-watch-mode.d.ts +4 -0
- package/dist/extensions/document/x-scalar-watch-mode.d.ts.map +1 -0
- package/dist/extensions/document/x-scalar-watch-mode.js +8 -0
- package/dist/extensions/document/x-tags.d.ts +4 -0
- package/dist/extensions/document/x-tags.d.ts.map +1 -0
- package/dist/extensions/document/x-tags.js +15 -0
- package/dist/extensions/example/index.d.ts +7 -0
- package/dist/extensions/example/index.d.ts.map +1 -0
- package/dist/extensions/example/index.js +6 -0
- package/dist/extensions/example/x-disabled.d.ts +17 -0
- package/dist/extensions/example/x-disabled.d.ts.map +1 -0
- package/dist/extensions/example/x-disabled.js +23 -0
- package/dist/extensions/general/index.d.ts +12 -0
- package/dist/extensions/general/index.d.ts.map +1 -0
- package/dist/extensions/general/index.js +11 -0
- package/dist/extensions/general/x-post-response.d.ts +19 -0
- package/dist/extensions/general/x-post-response.d.ts.map +1 -0
- package/dist/extensions/general/x-post-response.js +31 -0
- package/dist/extensions/general/x-pre-request.d.ts +19 -0
- package/dist/extensions/general/x-pre-request.d.ts.map +1 -0
- package/dist/extensions/general/x-pre-request.js +30 -0
- package/dist/extensions/general/x-scalar-active-environment.d.ts +5 -0
- package/dist/extensions/general/x-scalar-active-environment.d.ts.map +1 -0
- package/dist/extensions/general/x-scalar-active-environment.js +12 -0
- package/dist/extensions/general/x-scalar-cookies.d.ts +17 -0
- package/dist/extensions/general/x-scalar-cookies.d.ts.map +1 -0
- package/dist/extensions/general/x-scalar-cookies.js +26 -0
- package/dist/extensions/general/x-scalar-order.d.ts +4 -0
- package/dist/extensions/general/x-scalar-order.d.ts.map +1 -0
- package/dist/extensions/general/x-scalar-order.js +16 -0
- package/dist/extensions/operation/index.d.ts +13 -0
- package/dist/extensions/operation/index.d.ts.map +1 -0
- package/dist/extensions/operation/index.js +12 -0
- package/dist/extensions/operation/x-badge.d.ts +38 -0
- package/dist/extensions/operation/x-badge.d.ts.map +1 -0
- package/dist/extensions/operation/x-badge.js +60 -0
- package/dist/extensions/operation/x-code-samples.d.ts +23 -0
- package/dist/extensions/operation/x-code-samples.d.ts.map +1 -0
- package/dist/extensions/operation/x-code-samples.js +24 -0
- package/dist/extensions/operation/x-draft-examples.d.ts +4 -0
- package/dist/extensions/operation/x-draft-examples.d.ts.map +1 -0
- package/dist/extensions/operation/x-draft-examples.js +15 -0
- package/dist/extensions/operation/x-scalar-disable-parameters.d.ts +8 -0
- package/dist/extensions/operation/x-scalar-disable-parameters.d.ts.map +1 -0
- package/dist/extensions/operation/x-scalar-disable-parameters.js +74 -0
- package/dist/extensions/operation/x-scalar-selected-content-type.d.ts +10 -0
- package/dist/extensions/operation/x-scalar-selected-content-type.d.ts.map +1 -0
- package/dist/extensions/operation/x-scalar-selected-content-type.js +21 -0
- package/dist/extensions/operation/x-scalar-stability.d.ts +9 -0
- package/dist/extensions/operation/x-scalar-stability.d.ts.map +1 -0
- package/dist/extensions/operation/x-scalar-stability.js +18 -0
- package/dist/extensions/parameter/index.d.ts +8 -0
- package/dist/extensions/parameter/index.d.ts.map +1 -0
- package/dist/extensions/parameter/index.js +7 -0
- package/dist/extensions/parameter/x-global.d.ts +13 -0
- package/dist/extensions/parameter/x-global.d.ts.map +1 -0
- package/dist/extensions/parameter/x-global.js +22 -0
- package/dist/extensions/schema/index.d.ts +12 -0
- package/dist/extensions/schema/index.d.ts.map +1 -0
- package/dist/extensions/schema/index.js +11 -0
- package/dist/extensions/schema/x-additional-properties-name.d.ts +10 -0
- package/dist/extensions/schema/x-additional-properties-name.d.ts.map +1 -0
- package/dist/extensions/schema/x-additional-properties-name.js +19 -0
- package/dist/extensions/schema/x-enum-descriptions.d.ts +20 -0
- package/dist/extensions/schema/x-enum-descriptions.d.ts.map +1 -0
- package/dist/extensions/schema/x-enum-descriptions.js +33 -0
- package/dist/extensions/schema/x-enum-varnames.d.ts +22 -0
- package/dist/extensions/schema/x-enum-varnames.d.ts.map +1 -0
- package/dist/extensions/schema/x-enum-varnames.js +34 -0
- package/dist/extensions/schema/x-examples.d.ts +4 -0
- package/dist/extensions/schema/x-examples.d.ts.map +1 -0
- package/dist/extensions/schema/x-examples.js +16 -0
- package/dist/extensions/schema/x-variable.d.ts +4 -0
- package/dist/extensions/schema/x-variable.d.ts.map +1 -0
- package/dist/extensions/schema/x-variable.js +11 -0
- package/dist/extensions/security/index.d.ts +14 -0
- package/dist/extensions/security/index.d.ts.map +1 -0
- package/dist/extensions/security/index.js +13 -0
- package/dist/extensions/security/x-default-scopes.d.ts +14 -0
- package/dist/extensions/security/x-default-scopes.d.ts.map +1 -0
- package/dist/extensions/security/x-default-scopes.js +23 -0
- package/dist/extensions/security/x-scalar-credentials-location.d.ts +17 -0
- package/dist/extensions/security/x-scalar-credentials-location.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-credentials-location.js +26 -0
- package/dist/extensions/security/x-scalar-security-body.d.ts +14 -0
- package/dist/extensions/security/x-scalar-security-body.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-security-body.js +25 -0
- package/dist/extensions/security/x-scalar-security-query.d.ts +14 -0
- package/dist/extensions/security/x-scalar-security-query.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-security-query.js +25 -0
- package/dist/extensions/security/x-scalar-security-secrets.d.ts +26 -0
- package/dist/extensions/security/x-scalar-security-secrets.d.ts.map +1 -0
- package/dist/extensions/security/x-scalar-security-secrets.js +57 -0
- package/dist/extensions/security/x-tokenName.d.ts +12 -0
- package/dist/extensions/security/x-tokenName.d.ts.map +1 -0
- package/dist/extensions/security/x-tokenName.js +21 -0
- package/dist/extensions/security/x-use-pkce.d.ts +7 -0
- package/dist/extensions/security/x-use-pkce.d.ts.map +1 -0
- package/dist/extensions/security/x-use-pkce.js +13 -0
- package/dist/extensions/server/index.d.ts +7 -0
- package/dist/extensions/server/index.d.ts.map +1 -0
- package/dist/extensions/server/index.js +6 -0
- package/dist/extensions/server/x-scalar-selected-server.d.ts +4 -0
- package/dist/extensions/server/x-scalar-selected-server.d.ts.map +1 -0
- package/dist/extensions/server/x-scalar-selected-server.js +11 -0
- package/dist/extensions/tag/index.d.ts +8 -0
- package/dist/extensions/tag/index.d.ts.map +1 -0
- package/dist/extensions/tag/index.js +7 -0
- package/dist/extensions/tag/x-display-name.d.ts +12 -0
- package/dist/extensions/tag/x-display-name.d.ts.map +1 -0
- package/dist/extensions/tag/x-display-name.js +21 -0
- package/dist/extensions/tag/x-tag-groups.d.ts +20 -0
- package/dist/extensions/tag/x-tag-groups.d.ts.map +1 -0
- package/dist/extensions/tag/x-tag-groups.js +33 -0
- package/dist/extensions/type-comment.d.ts +17 -0
- package/dist/extensions/type-comment.d.ts.map +1 -0
- package/dist/extensions/type-comment.js +14 -0
- package/dist/extensions/workspace/index.d.ts +9 -0
- package/dist/extensions/workspace/index.d.ts.map +1 -0
- package/dist/extensions/workspace/index.js +8 -0
- package/dist/extensions/workspace/x-scalar-active-proxy.d.ts +14 -0
- package/dist/extensions/workspace/x-scalar-active-proxy.d.ts.map +1 -0
- package/dist/extensions/workspace/x-scalar-active-proxy.js +23 -0
- package/dist/extensions/workspace/x-scalar-tabs.d.ts +20 -0
- package/dist/extensions/workspace/x-scalar-tabs.d.ts.map +1 -0
- package/dist/extensions/workspace/x-scalar-tabs.js +33 -0
- package/dist/general/bundler-extensions.d.ts +5 -0
- package/dist/general/bundler-extensions.d.ts.map +1 -0
- package/dist/general/bundler-extensions.js +9 -0
- package/dist/openapi/3.1/callback.d.ts +2 -0
- package/dist/openapi/3.1/callback.d.ts.map +1 -0
- package/dist/openapi/3.1/callback.js +6 -0
- package/dist/openapi/3.1/components.d.ts +36 -0
- package/dist/openapi/3.1/components.d.ts.map +1 -0
- package/dist/openapi/3.1/components.js +24 -0
- package/dist/openapi/3.1/contact.d.ts +6 -0
- package/dist/openapi/3.1/contact.d.ts.map +1 -0
- package/dist/openapi/3.1/contact.js +8 -0
- package/dist/openapi/3.1/discriminator.d.ts +5 -0
- package/dist/openapi/3.1/discriminator.d.ts.map +1 -0
- package/dist/openapi/3.1/discriminator.js +9 -0
- package/dist/openapi/3.1/document.d.ts +201 -0
- package/dist/openapi/3.1/document.d.ts.map +1 -0
- package/dist/openapi/3.1/document.js +67 -0
- package/dist/openapi/3.1/example.d.ts +9 -0
- package/dist/openapi/3.1/example.d.ts.map +1 -0
- package/dist/openapi/3.1/example.js +17 -0
- package/dist/openapi/3.1/external-docs.d.ts +5 -0
- package/dist/openapi/3.1/external-docs.d.ts.map +1 -0
- package/dist/openapi/3.1/external-docs.js +9 -0
- package/dist/openapi/3.1/index.d.ts +25 -0
- package/dist/openapi/3.1/index.d.ts.map +1 -0
- package/dist/openapi/3.1/index.js +24 -0
- package/dist/openapi/3.1/info.d.ts +24 -0
- package/dist/openapi/3.1/info.d.ts.map +1 -0
- package/dist/openapi/3.1/info.js +20 -0
- package/dist/openapi/3.1/license.d.ts +6 -0
- package/dist/openapi/3.1/license.d.ts.map +1 -0
- package/dist/openapi/3.1/license.js +10 -0
- package/dist/openapi/3.1/link.d.ts +17 -0
- package/dist/openapi/3.1/link.d.ts.map +1 -0
- package/dist/openapi/3.1/link.js +21 -0
- package/dist/openapi/3.1/media-type.d.ts +16 -0
- package/dist/openapi/3.1/media-type.d.ts.map +1 -0
- package/dist/openapi/3.1/media-type.js +49 -0
- package/dist/openapi/3.1/operation.d.ts +68 -0
- package/dist/openapi/3.1/operation.d.ts.map +1 -0
- package/dist/openapi/3.1/operation.js +48 -0
- package/dist/openapi/3.1/parameter.d.ts +44 -0
- package/dist/openapi/3.1/parameter.d.ts.map +1 -0
- package/dist/openapi/3.1/parameter.js +76 -0
- package/dist/openapi/3.1/path-item.d.ts +25 -0
- package/dist/openapi/3.1/path-item.d.ts.map +1 -0
- package/dist/openapi/3.1/path-item.js +27 -0
- package/dist/openapi/3.1/reference.d.ts +16 -0
- package/dist/openapi/3.1/reference.d.ts.map +1 -0
- package/dist/openapi/3.1/reference.js +34 -0
- package/dist/openapi/3.1/request-body.d.ts +16 -0
- package/dist/openapi/3.1/request-body.d.ts.map +1 -0
- package/dist/openapi/3.1/request-body.js +16 -0
- package/dist/openapi/3.1/response.d.ts +16 -0
- package/dist/openapi/3.1/response.d.ts.map +1 -0
- package/dist/openapi/3.1/response.js +15 -0
- package/dist/openapi/3.1/schema.d.ts +3 -0
- package/dist/openapi/3.1/schema.d.ts.map +1 -0
- package/dist/openapi/3.1/schema.js +100 -0
- package/dist/openapi/3.1/security-requirement.d.ts +2 -0
- package/dist/openapi/3.1/security-requirement.d.ts.map +1 -0
- package/dist/openapi/3.1/security-requirement.js +5 -0
- package/dist/openapi/3.1/security-schemes.d.ts +96 -0
- package/dist/openapi/3.1/security-schemes.d.ts.map +1 -0
- package/dist/openapi/3.1/security-schemes.js +107 -0
- package/dist/openapi/3.1/server-variable.d.ts +6 -0
- package/dist/openapi/3.1/server-variable.d.ts.map +1 -0
- package/dist/openapi/3.1/server-variable.js +12 -0
- package/dist/openapi/3.1/server.d.ts +10 -0
- package/dist/openapi/3.1/server.d.ts.map +1 -0
- package/dist/openapi/3.1/server.js +13 -0
- package/dist/openapi/3.1/tag.d.ts +17 -0
- package/dist/openapi/3.1/tag.d.ts.map +1 -0
- package/dist/openapi/3.1/tag.js +18 -0
- package/dist/openapi/3.1/xml.d.ts +8 -0
- package/dist/openapi/3.1/xml.d.ts.map +1 -0
- package/dist/openapi/3.1/xml.js +16 -0
- package/package.json +16 -4
- package/LICENSE +0 -21
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
export declare const securityScheme: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
type: import("@scalar/validation").LiteralSchema<"apiKey">;
|
|
3
|
+
name: import("@scalar/validation").StringSchema;
|
|
4
|
+
in: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"query">, import("@scalar/validation").LiteralSchema<"header">, import("@scalar/validation").LiteralSchema<"cookie">]>;
|
|
5
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
6
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
7
|
+
type: import("@scalar/validation").LiteralSchema<"http">;
|
|
8
|
+
scheme: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"basic">, import("@scalar/validation").LiteralSchema<"bearer">]>;
|
|
9
|
+
bearerFormat: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
10
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
11
|
+
}>, import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
12
|
+
type: import("@scalar/validation").LiteralSchema<"oauth2">;
|
|
13
|
+
flows: import("@scalar/validation").ObjectSchema<{
|
|
14
|
+
implicit: import("@scalar/validation").OptionalSchema<import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
15
|
+
refreshUrl: import("@scalar/validation").StringSchema;
|
|
16
|
+
scopes: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>;
|
|
17
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
18
|
+
'x-scalar-security-query': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
19
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
20
|
+
'x-scalar-security-body': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
21
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
22
|
+
'x-tokenName': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
23
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
24
|
+
'x-scalar-secret-auth-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
25
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
26
|
+
'x-scalar-secret-token-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
27
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
28
|
+
authorizationUrl: import("@scalar/validation").StringSchema;
|
|
29
|
+
}>]>>;
|
|
30
|
+
password: import("@scalar/validation").OptionalSchema<import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
31
|
+
refreshUrl: import("@scalar/validation").StringSchema;
|
|
32
|
+
scopes: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>;
|
|
33
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
34
|
+
'x-scalar-security-query': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
35
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
36
|
+
'x-scalar-security-body': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
37
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
38
|
+
'x-tokenName': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
39
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
40
|
+
'x-scalar-secret-auth-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
41
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
42
|
+
'x-scalar-secret-token-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
43
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
44
|
+
tokenUrl: import("@scalar/validation").StringSchema;
|
|
45
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
46
|
+
'x-scalar-credentials-location': import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"header">, import("@scalar/validation").LiteralSchema<"body">]>>;
|
|
47
|
+
}>]>>;
|
|
48
|
+
clientCredentials: import("@scalar/validation").OptionalSchema<import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
49
|
+
refreshUrl: import("@scalar/validation").StringSchema;
|
|
50
|
+
scopes: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>;
|
|
51
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
52
|
+
'x-scalar-security-query': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
53
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
54
|
+
'x-scalar-security-body': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
55
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
56
|
+
'x-tokenName': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
57
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
58
|
+
'x-scalar-secret-auth-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
59
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
60
|
+
'x-scalar-secret-token-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
61
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
62
|
+
tokenUrl: import("@scalar/validation").StringSchema;
|
|
63
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
64
|
+
'x-scalar-credentials-location': import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"header">, import("@scalar/validation").LiteralSchema<"body">]>>;
|
|
65
|
+
}>]>>;
|
|
66
|
+
authorizationCode: import("@scalar/validation").OptionalSchema<import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
67
|
+
refreshUrl: import("@scalar/validation").StringSchema;
|
|
68
|
+
scopes: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>;
|
|
69
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
70
|
+
'x-scalar-security-query': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
71
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
72
|
+
'x-scalar-security-body': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
73
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
74
|
+
'x-tokenName': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
75
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
76
|
+
'x-scalar-secret-auth-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
77
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
78
|
+
'x-scalar-secret-token-url': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
79
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
80
|
+
authorizationUrl: import("@scalar/validation").StringSchema;
|
|
81
|
+
tokenUrl: import("@scalar/validation").StringSchema;
|
|
82
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
83
|
+
'x-usePkce': import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"no">, import("@scalar/validation").LiteralSchema<"SHA-256">, import("@scalar/validation").LiteralSchema<"plain">]>;
|
|
84
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
85
|
+
'x-scalar-credentials-location': import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"header">, import("@scalar/validation").LiteralSchema<"body">]>>;
|
|
86
|
+
}>]>>;
|
|
87
|
+
}>;
|
|
88
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
89
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
90
|
+
'x-default-scopes': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
91
|
+
}>]>, import("@scalar/validation").ObjectSchema<{
|
|
92
|
+
type: import("@scalar/validation").LiteralSchema<"openIdConnect">;
|
|
93
|
+
openIdConnectUrl: import("@scalar/validation").StringSchema;
|
|
94
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
95
|
+
}>]>;
|
|
96
|
+
//# sourceMappingURL=security-schemes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"security-schemes.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/security-schemes.ts"],"names":[],"mappings":"AA4KA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAG1B,CAAA"}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { intersection, literal, object, optional, record, string, union } from '@scalar/validation';
|
|
2
|
+
import { XDefaultScopes, XScalarAuthUrl, XScalarCredentialsLocation, XScalarSecurityBody, XScalarSecurityQuery, XScalarTokenUrl, XTokenName, XusePkce, } from '../../extensions/security/index.js';
|
|
3
|
+
const securitySchemeBase = object({
|
|
4
|
+
description: optional(string({
|
|
5
|
+
typeComment: 'A description for security scheme. CommonMark syntax MAY be used for rich text representation.',
|
|
6
|
+
})),
|
|
7
|
+
});
|
|
8
|
+
const apiKeySecurityScheme = object({
|
|
9
|
+
...securitySchemeBase.properties,
|
|
10
|
+
type: literal('apiKey'),
|
|
11
|
+
name: string({ typeComment: 'REQUIRED. The name of the header, query or cookie parameter to be used.' }),
|
|
12
|
+
in: union([literal('query'), literal('header'), literal('cookie')], {
|
|
13
|
+
typeComment: 'REQUIRED. The location of the API key. Valid values are "query", "header", or "cookie".',
|
|
14
|
+
}),
|
|
15
|
+
}, { typeName: 'ApiKeySecuritySchemeObject' });
|
|
16
|
+
const httpSecurityScheme = object({
|
|
17
|
+
...securitySchemeBase.properties,
|
|
18
|
+
type: literal('http'),
|
|
19
|
+
scheme: union([literal('basic'), literal('bearer')], {
|
|
20
|
+
typeName: 'HttpSecuritySchemeScheme',
|
|
21
|
+
typeComment: 'REQUIRED. The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235.',
|
|
22
|
+
}),
|
|
23
|
+
bearerFormat: optional(string({
|
|
24
|
+
typeComment: 'A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.',
|
|
25
|
+
})),
|
|
26
|
+
}, { typeName: 'HttpSecuritySchemeObject' });
|
|
27
|
+
const oauthFlowExtensionObjects = [
|
|
28
|
+
XScalarSecurityQuery,
|
|
29
|
+
XScalarSecurityBody,
|
|
30
|
+
XTokenName,
|
|
31
|
+
XScalarAuthUrl,
|
|
32
|
+
XScalarTokenUrl,
|
|
33
|
+
];
|
|
34
|
+
const oauthFlowCore = object({
|
|
35
|
+
refreshUrl: string({
|
|
36
|
+
typeComment: 'The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.',
|
|
37
|
+
}),
|
|
38
|
+
scopes: record(string(), string(), {
|
|
39
|
+
typeComment: 'REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.',
|
|
40
|
+
typeName: 'OAuthFlowScopes',
|
|
41
|
+
}),
|
|
42
|
+
}, { typeName: 'OAuthFlowBaseCore' });
|
|
43
|
+
const implicitOAuth2Flow = intersection([
|
|
44
|
+
oauthFlowCore,
|
|
45
|
+
...oauthFlowExtensionObjects,
|
|
46
|
+
object({
|
|
47
|
+
authorizationUrl: string({
|
|
48
|
+
typeComment: 'REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.',
|
|
49
|
+
}),
|
|
50
|
+
}),
|
|
51
|
+
], { typeName: 'ImplicitOAuthFlowObject' });
|
|
52
|
+
const passwordOAuth2Flow = intersection([
|
|
53
|
+
oauthFlowCore,
|
|
54
|
+
...oauthFlowExtensionObjects,
|
|
55
|
+
object({
|
|
56
|
+
tokenUrl: string({
|
|
57
|
+
typeComment: 'REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.',
|
|
58
|
+
}),
|
|
59
|
+
}),
|
|
60
|
+
XScalarCredentialsLocation,
|
|
61
|
+
], { typeName: 'PasswordOAuthFlowObject' });
|
|
62
|
+
const clientCredentialsOAuth2Flow = intersection([
|
|
63
|
+
oauthFlowCore,
|
|
64
|
+
...oauthFlowExtensionObjects,
|
|
65
|
+
object({
|
|
66
|
+
tokenUrl: string({
|
|
67
|
+
typeComment: 'REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.',
|
|
68
|
+
}),
|
|
69
|
+
}),
|
|
70
|
+
XScalarCredentialsLocation,
|
|
71
|
+
], { typeName: 'ClientCredentialsOAuthFlowObject' });
|
|
72
|
+
const authorizationCodeOAuth2Flow = intersection([
|
|
73
|
+
oauthFlowCore,
|
|
74
|
+
...oauthFlowExtensionObjects,
|
|
75
|
+
object({
|
|
76
|
+
authorizationUrl: string({
|
|
77
|
+
typeComment: 'REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.',
|
|
78
|
+
}),
|
|
79
|
+
tokenUrl: string({
|
|
80
|
+
typeComment: 'REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.',
|
|
81
|
+
}),
|
|
82
|
+
}),
|
|
83
|
+
XusePkce,
|
|
84
|
+
XScalarCredentialsLocation,
|
|
85
|
+
], { typeName: 'AuthorizationCodeOAuthFlowObject' });
|
|
86
|
+
const oauth2Flows = object({
|
|
87
|
+
implicit: optional(implicitOAuth2Flow),
|
|
88
|
+
password: optional(passwordOAuth2Flow),
|
|
89
|
+
clientCredentials: optional(clientCredentialsOAuth2Flow),
|
|
90
|
+
authorizationCode: optional(authorizationCodeOAuth2Flow),
|
|
91
|
+
}, { typeName: 'OAuthFlowsObject' });
|
|
92
|
+
const oauth2SecurityScheme = intersection([
|
|
93
|
+
object({
|
|
94
|
+
...securitySchemeBase.properties,
|
|
95
|
+
type: literal('oauth2'),
|
|
96
|
+
flows: oauth2Flows,
|
|
97
|
+
}),
|
|
98
|
+
XDefaultScopes,
|
|
99
|
+
], { typeName: 'OAuth2SecuritySchemeObject' });
|
|
100
|
+
const openIdConnectSecurityScheme = object({
|
|
101
|
+
...securitySchemeBase.properties,
|
|
102
|
+
type: literal('openIdConnect'),
|
|
103
|
+
openIdConnectUrl: string({
|
|
104
|
+
typeComment: 'REQUIRED. Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.',
|
|
105
|
+
}),
|
|
106
|
+
}, { typeName: 'OpenIdConnectSecuritySchemeObject' });
|
|
107
|
+
export const securityScheme = union([apiKeySecurityScheme, httpSecurityScheme, oauth2SecurityScheme, openIdConnectSecurityScheme], { typeName: 'SecuritySchemeObject' });
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const serverVariable: import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
3
|
+
default: import("@scalar/validation").StringSchema;
|
|
4
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
5
|
+
}>;
|
|
6
|
+
//# sourceMappingURL=server-variable.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server-variable.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/server-variable.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,cAAc;;;;EAmB1B,CAAA"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { array, object, optional, string } from '@scalar/validation';
|
|
2
|
+
export const serverVariable = object({
|
|
3
|
+
enum: optional(array(string(), {
|
|
4
|
+
typeComment: 'An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty.',
|
|
5
|
+
})),
|
|
6
|
+
default: string({
|
|
7
|
+
typeComment: `REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. If the enum is defined, the value MUST exist in the enum\'s values. Note that this behavior is different from the Schema Object's default keyword, which documents the receiver's behavior rather than inserting the value into the data.`,
|
|
8
|
+
}),
|
|
9
|
+
description: optional(string({
|
|
10
|
+
typeComment: 'An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.',
|
|
11
|
+
})),
|
|
12
|
+
}, { typeName: 'ServerVariableObject' });
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare const server: import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
url: import("@scalar/validation").StringSchema;
|
|
3
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
4
|
+
variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
|
|
5
|
+
enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
6
|
+
default: import("@scalar/validation").StringSchema;
|
|
7
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
8
|
+
}>>>;
|
|
9
|
+
}>;
|
|
10
|
+
//# sourceMappingURL=server.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/server.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,MAAM;;;;;;;;EAmBlB,CAAA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { object, optional, record, string } from '@scalar/validation';
|
|
2
|
+
import { serverVariable } from '../../openapi/3.1/server-variable.js';
|
|
3
|
+
export const server = object({
|
|
4
|
+
url: string({
|
|
5
|
+
typeComment: 'REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in {braces}.',
|
|
6
|
+
}),
|
|
7
|
+
description: optional(string({
|
|
8
|
+
typeComment: 'An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.',
|
|
9
|
+
})),
|
|
10
|
+
variables: optional(record(string(), serverVariable, {
|
|
11
|
+
typeComment: `A map between a variable name and its value. The value is used for substitution in the server's URL template.`,
|
|
12
|
+
})),
|
|
13
|
+
}, { typeName: 'ServerObject' });
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare const tag: import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
name: import("@scalar/validation").StringSchema;
|
|
3
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
4
|
+
externalDocs: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
5
|
+
url: import("@scalar/validation").StringSchema;
|
|
6
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
7
|
+
}>>;
|
|
8
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
9
|
+
'x-displayName': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
10
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
11
|
+
'x-internal': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
12
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
13
|
+
'x-scalar-ignore': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
14
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
15
|
+
'x-scalar-order': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
16
|
+
}>]>;
|
|
17
|
+
//# sourceMappingURL=tag.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/tag.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;IAiBf,CAAA"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { intersection, object, optional, string } from '@scalar/validation';
|
|
2
|
+
import { XInternal, XScalarIgnore } from '../../extensions/document/index.js';
|
|
3
|
+
import { XScalarOrder } from '../../extensions/general/index.js';
|
|
4
|
+
import { XDisplayName } from '../../extensions/tag/index.js';
|
|
5
|
+
import { externalDocs } from '../../openapi/3.1/external-docs.js';
|
|
6
|
+
export const tag = intersection([
|
|
7
|
+
object({
|
|
8
|
+
name: string({ typeComment: 'REQUIRED. The name of the tag.' }),
|
|
9
|
+
description: optional(string({
|
|
10
|
+
typeComment: 'A description for the tag. CommonMark syntax MAY be used for rich text representation.',
|
|
11
|
+
})),
|
|
12
|
+
externalDocs: optional(externalDocs),
|
|
13
|
+
}),
|
|
14
|
+
XDisplayName,
|
|
15
|
+
XInternal,
|
|
16
|
+
XScalarIgnore,
|
|
17
|
+
XScalarOrder,
|
|
18
|
+
], { typeName: 'TagObject' });
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const xml: import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
name: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
3
|
+
namespace: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
4
|
+
prefix: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
5
|
+
attribute: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
6
|
+
wrapped: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
7
|
+
}>;
|
|
8
|
+
//# sourceMappingURL=xml.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/xml.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,GAAG;;;;;;EA4Bf,CAAA"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { boolean, object, optional, string } from '@scalar/validation';
|
|
2
|
+
export const xml = object({
|
|
3
|
+
name: optional(string({
|
|
4
|
+
typeComment: 'Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being "array" (outside the items), it will affect the wrapping element if and only if wrapped is true. If wrapped is false, it will be ignored.',
|
|
5
|
+
})),
|
|
6
|
+
namespace: optional(string({
|
|
7
|
+
typeComment: 'The URI of the namespace definition. Value MUST be in the form of a non-relative URI.',
|
|
8
|
+
})),
|
|
9
|
+
prefix: optional(string({ typeComment: 'The prefix to be used for the name.' })),
|
|
10
|
+
attribute: optional(boolean({
|
|
11
|
+
typeComment: 'Declares whether the property definition translates to an attribute instead of an element. Default value is false.',
|
|
12
|
+
})),
|
|
13
|
+
wrapped: optional(boolean({
|
|
14
|
+
typeComment: 'MAY be used only for an array definition. Signifies whether the array is wrapped (for example, <books><book/><book/></books>) or unwrapped (<book/><book/>). Default value is false. The definition takes effect only when defined alongside type being "array" (outside the items).',
|
|
15
|
+
})),
|
|
16
|
+
}, { typeName: 'XMLObject' });
|
package/package.json
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"schemas",
|
|
15
15
|
"scalar"
|
|
16
16
|
],
|
|
17
|
-
"version": "0.
|
|
17
|
+
"version": "0.3.0",
|
|
18
18
|
"engines": {
|
|
19
19
|
"node": ">=22"
|
|
20
20
|
},
|
|
@@ -24,6 +24,16 @@
|
|
|
24
24
|
"import": "./dist/api-reference/index.js",
|
|
25
25
|
"types": "./dist/api-reference/index.d.ts",
|
|
26
26
|
"default": "./dist/api-reference/index.js"
|
|
27
|
+
},
|
|
28
|
+
"./asyncapi/3.1": {
|
|
29
|
+
"import": "./dist/asyncapi/3.1/index.js",
|
|
30
|
+
"types": "./dist/asyncapi/3.1/index.d.ts",
|
|
31
|
+
"default": "./dist/asyncapi/3.1/index.js"
|
|
32
|
+
},
|
|
33
|
+
"./openapi/3.1": {
|
|
34
|
+
"import": "./dist/openapi/3.1/index.js",
|
|
35
|
+
"types": "./dist/openapi/3.1/index.d.ts",
|
|
36
|
+
"default": "./dist/openapi/3.1/index.js"
|
|
27
37
|
}
|
|
28
38
|
},
|
|
29
39
|
"files": [
|
|
@@ -31,16 +41,18 @@
|
|
|
31
41
|
"CHANGELOG.md"
|
|
32
42
|
],
|
|
33
43
|
"dependencies": {
|
|
34
|
-
"@scalar/validation": "0.
|
|
44
|
+
"@scalar/validation": "0.6.0",
|
|
45
|
+
"@scalar/helpers": "0.8.0"
|
|
35
46
|
},
|
|
36
47
|
"devDependencies": {
|
|
37
48
|
"vitest": "4.1.0",
|
|
38
|
-
"@scalar/types": "0.
|
|
49
|
+
"@scalar/types": "0.12.0"
|
|
39
50
|
},
|
|
40
51
|
"scripts": {
|
|
41
52
|
"build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
|
|
42
53
|
"test": "vitest --run",
|
|
43
54
|
"types:check": "tsc --noEmit",
|
|
44
|
-
"types:generate": "tsx scripts/generate-types.ts"
|
|
55
|
+
"types:generate": "tsx scripts/generate-types.ts",
|
|
56
|
+
"types:generate:stage": "tsx scripts/stage-generated-types.ts"
|
|
45
57
|
}
|
|
46
58
|
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2023-present Scalar
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|