@scalar/schemas 0.2.0 → 0.3.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 +28 -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 +43 -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 +27 -0
- package/dist/asyncapi/3.1/index.d.ts.map +1 -0
- package/dist/asyncapi/3.1/index.js +26 -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 +9 -0
- package/dist/asyncapi/3.1/schema-payload.d.ts.map +1 -0
- package/dist/asyncapi/3.1/schema-payload.js +24 -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/asyncapi/3.1/ws-binding.d.ts +12 -0
- package/dist/asyncapi/3.1/ws-binding.d.ts.map +1 -0
- package/dist/asyncapi/3.1/ws-binding.js +24 -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 @@
|
|
|
1
|
+
{"version":3,"file":"media-type.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/media-type.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EAUZ,MAAM,oBAAoB,CAAA;AAmE3B,eAAO,MAAM,MAAM,6LAA6E,CAAA;AAEhG,eAAO,MAAM,QAAQ;;;EAWpB,CAAA;AAED,eAAO,MAAM,SAAS;;;;;;;;EAcrB,CAAA"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { any, boolean, intersection, lazy, object, optional, record, string, union, } from '@scalar/validation';
|
|
2
|
+
import { example } from '../../openapi/3.1/example.js';
|
|
3
|
+
import { normalRef, recursiveRef } from '../../openapi/3.1/reference.js';
|
|
4
|
+
import { schema } from '../../openapi/3.1/schema.js';
|
|
5
|
+
const headerBase = object({
|
|
6
|
+
description: optional(string({
|
|
7
|
+
typeComment: 'A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.',
|
|
8
|
+
})),
|
|
9
|
+
required: optional(boolean({ typeComment: 'Determines whether this header is mandatory. The default value is false.' })),
|
|
10
|
+
deprecated: optional(boolean({
|
|
11
|
+
typeComment: 'Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is false.',
|
|
12
|
+
})),
|
|
13
|
+
}, { typeName: 'HeaderBase' });
|
|
14
|
+
const headerWithSchema = intersection([
|
|
15
|
+
headerBase,
|
|
16
|
+
object({
|
|
17
|
+
style: optional(string({
|
|
18
|
+
typeComment: 'Describes how the header value will be serialized. The default (and only legal value for headers) is "simple".',
|
|
19
|
+
})),
|
|
20
|
+
explode: optional(boolean({
|
|
21
|
+
typeComment: 'When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples.',
|
|
22
|
+
})),
|
|
23
|
+
schema: optional(normalRef(lazy(() => schema))),
|
|
24
|
+
example: optional(any()),
|
|
25
|
+
examples: optional(record(string(), recursiveRef(lazy(() => example)), { typeName: 'HeaderExamples' })),
|
|
26
|
+
}, { typeName: 'HeaderObjectWithSchema' }),
|
|
27
|
+
]);
|
|
28
|
+
const headerWithContent = intersection([
|
|
29
|
+
headerBase,
|
|
30
|
+
object({
|
|
31
|
+
content: optional(record(string(), lazy(() => mediaType), { typeName: 'HeaderContent' })),
|
|
32
|
+
}, { typeName: 'HeaderObjectWithContent' }),
|
|
33
|
+
]);
|
|
34
|
+
export const header = union([headerWithSchema, headerWithContent], { typeName: 'HeaderObject' });
|
|
35
|
+
export const encoding = object({
|
|
36
|
+
contentType: optional(string({
|
|
37
|
+
typeComment: 'The Content-Type for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. image/png) or a wildcard media type (e.g. image/*).',
|
|
38
|
+
})),
|
|
39
|
+
headers: optional(record(string(), recursiveRef(lazy(() => header)), { typeName: 'EncodingHeaders' })),
|
|
40
|
+
}, { typeName: 'EncodingObject' });
|
|
41
|
+
export const mediaType = object({
|
|
42
|
+
schema: optional(normalRef(lazy(() => schema))),
|
|
43
|
+
example: optional(any({ typeComment: 'Example of the media type.' })),
|
|
44
|
+
examples: optional(record(string(), recursiveRef(lazy(() => example)), { typeName: 'MediaTypeExamples' })),
|
|
45
|
+
encoding: optional(record(string(), encoding, {
|
|
46
|
+
typeComment: 'A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property.',
|
|
47
|
+
typeName: 'MediaTypeEncoding',
|
|
48
|
+
})),
|
|
49
|
+
}, { typeName: 'MediaTypeObject' });
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
export declare const operation: import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
tags: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
3
|
+
summary: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
4
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
5
|
+
externalDocs: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
6
|
+
url: import("@scalar/validation").StringSchema;
|
|
7
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
8
|
+
}>>;
|
|
9
|
+
operationId: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
10
|
+
parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
|
|
11
|
+
requestBody: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
12
|
+
responses: import("@scalar/validation").OptionalSchema<import("@scalar/validation").LazySchema<() => import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>>;
|
|
13
|
+
deprecated: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
14
|
+
security: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>>>;
|
|
15
|
+
servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
16
|
+
url: import("@scalar/validation").StringSchema;
|
|
17
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
18
|
+
variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
|
|
19
|
+
enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
20
|
+
default: import("@scalar/validation").StringSchema;
|
|
21
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
22
|
+
}>>>;
|
|
23
|
+
}>>>;
|
|
24
|
+
callbacks: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
25
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
26
|
+
'x-badges': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
27
|
+
name: import("@scalar/validation").StringSchema;
|
|
28
|
+
position: import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"before">, import("@scalar/validation").LiteralSchema<"after">]>>;
|
|
29
|
+
color: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
30
|
+
}>>>;
|
|
31
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
32
|
+
'x-internal': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
33
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
34
|
+
'x-scalar-ignore': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
35
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
36
|
+
'x-codeSamples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
37
|
+
lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
38
|
+
label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
39
|
+
source: import("@scalar/validation").StringSchema;
|
|
40
|
+
}>>>;
|
|
41
|
+
'x-code-samples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
42
|
+
lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
43
|
+
label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
44
|
+
source: import("@scalar/validation").StringSchema;
|
|
45
|
+
}>>>;
|
|
46
|
+
'x-custom-examples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
47
|
+
lang: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
48
|
+
label: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
49
|
+
source: import("@scalar/validation").StringSchema;
|
|
50
|
+
}>>>;
|
|
51
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
52
|
+
'x-scalar-stability': import("@scalar/validation").OptionalSchema<import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"deprecated">, import("@scalar/validation").LiteralSchema<"experimental">, import("@scalar/validation").LiteralSchema<"stable">]>>;
|
|
53
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
54
|
+
'x-scalar-disable-parameters': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
|
|
55
|
+
'global-cookies': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").BooleanSchema>>>;
|
|
56
|
+
'global-headers': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").BooleanSchema>>>;
|
|
57
|
+
'default-headers': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").BooleanSchema>>>;
|
|
58
|
+
}>>;
|
|
59
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
60
|
+
'x-post-response': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
61
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
62
|
+
'x-pre-request': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
63
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
64
|
+
'x-draft-examples': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
65
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
66
|
+
'x-scalar-selected-server': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
67
|
+
}>]>;
|
|
68
|
+
//# sourceMappingURL=operation.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/operation.ts"],"names":[],"mappings":"AAqBA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiDrB,CAAA"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { array, boolean, intersection, lazy, object, optional, record, string } from '@scalar/validation';
|
|
2
|
+
import { XInternal, XScalarIgnore } from '../../extensions/document/index.js';
|
|
3
|
+
import { XPostResponse, XPreRequest } from '../../extensions/general/index.js';
|
|
4
|
+
import { XBadges, XCodeSamples, XDraftExamples, XScalarDisableParameters, XScalarStability, } from '../../extensions/operation/index.js';
|
|
5
|
+
import { XScalarSelectedServer } from '../../extensions/server/index.js';
|
|
6
|
+
import { callback } from '../../openapi/3.1/callback.js';
|
|
7
|
+
import { externalDocs } from '../../openapi/3.1/external-docs.js';
|
|
8
|
+
import { parameter } from '../../openapi/3.1/parameter.js';
|
|
9
|
+
import { recursiveRef } from '../../openapi/3.1/reference.js';
|
|
10
|
+
import { requestBody } from '../../openapi/3.1/request-body.js';
|
|
11
|
+
import { responsesObject } from '../../openapi/3.1/response.js';
|
|
12
|
+
import { securityRequirement } from '../../openapi/3.1/security-requirement.js';
|
|
13
|
+
import { server } from '../../openapi/3.1/server.js';
|
|
14
|
+
export const operation = intersection([
|
|
15
|
+
object({
|
|
16
|
+
tags: optional(array(string(), {
|
|
17
|
+
typeComment: 'A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.',
|
|
18
|
+
typeName: 'OperationTags',
|
|
19
|
+
})),
|
|
20
|
+
summary: optional(string({ typeComment: 'A short summary of what the operation does.' })),
|
|
21
|
+
description: optional(string({
|
|
22
|
+
typeComment: 'A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.',
|
|
23
|
+
})),
|
|
24
|
+
externalDocs: optional(externalDocs),
|
|
25
|
+
operationId: optional(string({
|
|
26
|
+
typeComment: 'Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.',
|
|
27
|
+
})),
|
|
28
|
+
parameters: optional(array(recursiveRef(lazy(() => parameter)), { typeName: 'OperationParameters' })),
|
|
29
|
+
requestBody: optional(recursiveRef(lazy(() => requestBody))),
|
|
30
|
+
responses: optional(lazy(() => responsesObject)),
|
|
31
|
+
deprecated: optional(boolean({
|
|
32
|
+
typeComment: 'Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.',
|
|
33
|
+
})),
|
|
34
|
+
security: optional(array(securityRequirement, { typeName: 'OperationSecurity' })),
|
|
35
|
+
servers: optional(array(server, { typeName: 'OperationServers' })),
|
|
36
|
+
callbacks: optional(record(string(), recursiveRef(lazy(() => callback)), { typeName: 'OperationCallbacks' })),
|
|
37
|
+
}),
|
|
38
|
+
XBadges,
|
|
39
|
+
XInternal,
|
|
40
|
+
XScalarIgnore,
|
|
41
|
+
XCodeSamples,
|
|
42
|
+
XScalarStability,
|
|
43
|
+
XScalarDisableParameters,
|
|
44
|
+
XPostResponse,
|
|
45
|
+
XPreRequest,
|
|
46
|
+
XDraftExamples,
|
|
47
|
+
XScalarSelectedServer,
|
|
48
|
+
], { typeName: 'OperationObject' });
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
export declare const parameter: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
name: import("@scalar/validation").StringSchema;
|
|
3
|
+
in: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"query">, import("@scalar/validation").LiteralSchema<"header">, import("@scalar/validation").LiteralSchema<"path">, import("@scalar/validation").LiteralSchema<"cookie">]>;
|
|
4
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
5
|
+
required: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
6
|
+
deprecated: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
7
|
+
allowEmptyValue: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
8
|
+
allowReserved: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
9
|
+
style: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
10
|
+
explode: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
11
|
+
schema: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
12
|
+
example: import("@scalar/validation").OptionalSchema<import("@scalar/validation").AnySchema>;
|
|
13
|
+
examples: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
14
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
15
|
+
'x-global': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
16
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
17
|
+
'x-internal': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
18
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
19
|
+
'x-scalar-ignore': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
20
|
+
}>]>, import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
21
|
+
name: import("@scalar/validation").StringSchema;
|
|
22
|
+
in: import("@scalar/validation").UnionSchema<readonly [import("@scalar/validation").LiteralSchema<"query">, import("@scalar/validation").LiteralSchema<"header">, import("@scalar/validation").LiteralSchema<"path">, import("@scalar/validation").LiteralSchema<"cookie">]>;
|
|
23
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
24
|
+
required: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
25
|
+
deprecated: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
26
|
+
allowEmptyValue: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
27
|
+
allowReserved: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
28
|
+
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
|
|
29
|
+
schema: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
30
|
+
example: import("@scalar/validation").OptionalSchema<import("@scalar/validation").AnySchema>;
|
|
31
|
+
examples: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
32
|
+
encoding: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
|
|
33
|
+
contentType: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
34
|
+
headers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
35
|
+
}>>>;
|
|
36
|
+
}>>>>;
|
|
37
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
38
|
+
'x-global': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
39
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
40
|
+
'x-internal': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
41
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
42
|
+
'x-scalar-ignore': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
43
|
+
}>]>]>;
|
|
44
|
+
//# sourceMappingURL=parameter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/parameter.ts"],"names":[],"mappings":"AAkIA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAAsF,CAAA"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { any, boolean, intersection, lazy, literal, object, optional, record, string, union } from '@scalar/validation';
|
|
2
|
+
import { XInternal, XScalarIgnore } from '../../extensions/document/index.js';
|
|
3
|
+
import { XGlobal } from '../../extensions/parameter/index.js';
|
|
4
|
+
import { example } from '../../openapi/3.1/example.js';
|
|
5
|
+
import { mediaType } from '../../openapi/3.1/media-type.js';
|
|
6
|
+
import { normalRef, recursiveRef } from '../../openapi/3.1/reference.js';
|
|
7
|
+
import { schema } from '../../openapi/3.1/schema.js';
|
|
8
|
+
const parameterWithSchema = intersection([
|
|
9
|
+
object({
|
|
10
|
+
name: string({
|
|
11
|
+
typeComment: 'REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object.',
|
|
12
|
+
}),
|
|
13
|
+
in: union([literal('query'), literal('header'), literal('path'), literal('cookie')], {
|
|
14
|
+
typeName: 'ParameterLocation',
|
|
15
|
+
typeComment: 'REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".',
|
|
16
|
+
}),
|
|
17
|
+
description: optional(string({
|
|
18
|
+
typeComment: 'A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.',
|
|
19
|
+
})),
|
|
20
|
+
required: optional(boolean({
|
|
21
|
+
typeComment: 'Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true.',
|
|
22
|
+
})),
|
|
23
|
+
deprecated: optional(boolean({
|
|
24
|
+
typeComment: 'Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.',
|
|
25
|
+
})),
|
|
26
|
+
allowEmptyValue: optional(boolean({
|
|
27
|
+
typeComment: 'If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely. This field is valid only for query parameters.',
|
|
28
|
+
})),
|
|
29
|
+
allowReserved: optional(boolean({
|
|
30
|
+
typeComment: 'When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570. This field only applies to parameters with an in value of query. The default value is false.',
|
|
31
|
+
})),
|
|
32
|
+
style: optional(string({
|
|
33
|
+
typeComment: 'Describes how the parameter value will be serialized (depending on the schema type).',
|
|
34
|
+
})),
|
|
35
|
+
explode: optional(boolean({
|
|
36
|
+
typeComment: 'When this is true, parameter values of type array or object generate separate parameters for each array item or object property.',
|
|
37
|
+
})),
|
|
38
|
+
schema: optional(normalRef(lazy(() => schema))),
|
|
39
|
+
example: optional(any()),
|
|
40
|
+
examples: optional(record(string(), recursiveRef(lazy(() => example)), { typeName: 'ParameterExamples' })),
|
|
41
|
+
}),
|
|
42
|
+
XGlobal,
|
|
43
|
+
XInternal,
|
|
44
|
+
XScalarIgnore,
|
|
45
|
+
], { typeName: 'ParameterObjectWithSchema' });
|
|
46
|
+
const parameterWithContent = intersection([
|
|
47
|
+
object({
|
|
48
|
+
name: string({
|
|
49
|
+
typeComment: 'REQUIRED. The name of the parameter. Parameter names are case sensitive. If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object.',
|
|
50
|
+
}),
|
|
51
|
+
in: union([literal('query'), literal('header'), literal('path'), literal('cookie')], {
|
|
52
|
+
typeName: 'ParameterLocation',
|
|
53
|
+
typeComment: 'REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".',
|
|
54
|
+
}),
|
|
55
|
+
description: optional(string({
|
|
56
|
+
typeComment: 'A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.',
|
|
57
|
+
})),
|
|
58
|
+
required: optional(boolean({
|
|
59
|
+
typeComment: 'Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true.',
|
|
60
|
+
})),
|
|
61
|
+
deprecated: optional(boolean({
|
|
62
|
+
typeComment: 'Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.',
|
|
63
|
+
})),
|
|
64
|
+
allowEmptyValue: optional(boolean({
|
|
65
|
+
typeComment: 'If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely. This field is valid only for query parameters.',
|
|
66
|
+
})),
|
|
67
|
+
allowReserved: optional(boolean({
|
|
68
|
+
typeComment: 'When this is true, parameter values are serialized using reserved expansion, as defined by RFC6570. This field only applies to parameters with an in value of query. The default value is false.',
|
|
69
|
+
})),
|
|
70
|
+
content: optional(record(string(), lazy(() => mediaType), { typeName: 'ParameterContent' })),
|
|
71
|
+
}),
|
|
72
|
+
XGlobal,
|
|
73
|
+
XInternal,
|
|
74
|
+
XScalarIgnore,
|
|
75
|
+
], { typeName: 'ParameterObjectWithContent' });
|
|
76
|
+
export const parameter = union([parameterWithSchema, parameterWithContent], { typeName: 'ParameterObject' });
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
export declare const pathItem: import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
$ref: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
3
|
+
summary: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
4
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
5
|
+
get: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
6
|
+
put: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
7
|
+
post: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
8
|
+
delete: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
9
|
+
patch: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
10
|
+
connect: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
11
|
+
options: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
12
|
+
head: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
13
|
+
trace: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
14
|
+
servers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
|
|
15
|
+
url: import("@scalar/validation").StringSchema;
|
|
16
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
17
|
+
variables: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
|
|
18
|
+
enum: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
|
|
19
|
+
default: import("@scalar/validation").StringSchema;
|
|
20
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
21
|
+
}>>>;
|
|
22
|
+
}>>>;
|
|
23
|
+
parameters: import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").Schema>>;
|
|
24
|
+
}>;
|
|
25
|
+
//# sourceMappingURL=path-item.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"path-item.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/path-item.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;EAgCpB,CAAA"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { array, lazy, object, optional, string } from '@scalar/validation';
|
|
2
|
+
import { operation } from '../../openapi/3.1/operation.js';
|
|
3
|
+
import { parameter } from '../../openapi/3.1/parameter.js';
|
|
4
|
+
import { recursiveRef } from '../../openapi/3.1/reference.js';
|
|
5
|
+
import { server } from '../../openapi/3.1/server.js';
|
|
6
|
+
export const pathItem = object({
|
|
7
|
+
$ref: optional(string({
|
|
8
|
+
typeComment: 'Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object.',
|
|
9
|
+
})),
|
|
10
|
+
summary: optional(string({
|
|
11
|
+
typeComment: 'An optional string summary, intended to apply to all operations in this path.',
|
|
12
|
+
})),
|
|
13
|
+
description: optional(string({
|
|
14
|
+
typeComment: 'An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.',
|
|
15
|
+
})),
|
|
16
|
+
get: optional(recursiveRef(lazy(() => operation))),
|
|
17
|
+
put: optional(recursiveRef(lazy(() => operation))),
|
|
18
|
+
post: optional(recursiveRef(lazy(() => operation))),
|
|
19
|
+
delete: optional(recursiveRef(lazy(() => operation))),
|
|
20
|
+
patch: optional(recursiveRef(lazy(() => operation))),
|
|
21
|
+
connect: optional(recursiveRef(lazy(() => operation))),
|
|
22
|
+
options: optional(recursiveRef(lazy(() => operation))),
|
|
23
|
+
head: optional(recursiveRef(lazy(() => operation))),
|
|
24
|
+
trace: optional(recursiveRef(lazy(() => operation))),
|
|
25
|
+
servers: optional(array(server, { typeName: 'PathItemServers' })),
|
|
26
|
+
parameters: optional(array(recursiveRef(lazy(() => parameter)), { typeName: 'PathItemParameters' })),
|
|
27
|
+
}, { typeName: 'PathItemObject' });
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { type Schema } from '@scalar/validation';
|
|
2
|
+
/**
|
|
3
|
+
* Wraps a JSON Schema so it may also be satisfied by a Reference Object (no resolved `$ref-value`).
|
|
4
|
+
*
|
|
5
|
+
* Use for `components.schemas` and schema composition (`allOf`, `properties`, `items`, and similar)
|
|
6
|
+
* where references follow JSON Schema / OpenAPI schema rules only.
|
|
7
|
+
*/
|
|
8
|
+
export declare const normalRef: (inner: Schema) => Schema;
|
|
9
|
+
/**
|
|
10
|
+
* Inline object or Reference Object with resolved `$ref-value` and bundle extensions.
|
|
11
|
+
*
|
|
12
|
+
* Schemas in this folder use {@link recursiveRef} directly. Use {@link recursiveRef} when generating
|
|
13
|
+
* types for resolved or proxy documents (see `generate-types.ts`).
|
|
14
|
+
*/
|
|
15
|
+
export declare const recursiveRef: (inner: Schema) => Schema;
|
|
16
|
+
//# sourceMappingURL=reference.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAA2D,MAAM,oBAAoB,CAAA;AAyBzG;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,MAAM,KAAG,MAAmC,CAAA;AAU7E;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,KAAG,MACiE,CAAA"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { isObject } from '@scalar/helpers/object/is-object';
|
|
2
|
+
import { evaluate, intersection, object, optional, string, union } from '@scalar/validation';
|
|
3
|
+
import { referenceExtensions } from '../../general/bundler-extensions.js';
|
|
4
|
+
const reference = object({
|
|
5
|
+
'$ref': string({ typeComment: 'REQUIRED. The reference identifier. This MUST be in the form of a URI.' }),
|
|
6
|
+
summary: optional(string({
|
|
7
|
+
typeComment: 'A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect.',
|
|
8
|
+
})),
|
|
9
|
+
description: optional(string({
|
|
10
|
+
typeComment: 'A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.',
|
|
11
|
+
})),
|
|
12
|
+
}, {
|
|
13
|
+
typeName: 'ReferenceObject',
|
|
14
|
+
});
|
|
15
|
+
/**
|
|
16
|
+
* Wraps a JSON Schema so it may also be satisfied by a Reference Object (no resolved `$ref-value`).
|
|
17
|
+
*
|
|
18
|
+
* Use for `components.schemas` and schema composition (`allOf`, `properties`, `items`, and similar)
|
|
19
|
+
* where references follow JSON Schema / OpenAPI schema rules only.
|
|
20
|
+
*/
|
|
21
|
+
export const normalRef = (inner) => union([inner, reference]);
|
|
22
|
+
const e = (value) => {
|
|
23
|
+
if (isObject(value) && '$ref' in value) {
|
|
24
|
+
return e(value['$ref-value']);
|
|
25
|
+
}
|
|
26
|
+
return value;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Inline object or Reference Object with resolved `$ref-value` and bundle extensions.
|
|
30
|
+
*
|
|
31
|
+
* Schemas in this folder use {@link recursiveRef} directly. Use {@link recursiveRef} when generating
|
|
32
|
+
* types for resolved or proxy documents (see `generate-types.ts`).
|
|
33
|
+
*/
|
|
34
|
+
export const recursiveRef = (inner) => union([inner, intersection([reference, object({ '$ref-value': evaluate(e, inner) }), referenceExtensions])]);
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export declare const requestBody: import("@scalar/validation").IntersectionSchema<readonly [import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
3
|
+
content: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
|
|
4
|
+
schema: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
5
|
+
example: import("@scalar/validation").OptionalSchema<import("@scalar/validation").AnySchema>;
|
|
6
|
+
examples: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
7
|
+
encoding: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
|
|
8
|
+
contentType: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
9
|
+
headers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
10
|
+
}>>>;
|
|
11
|
+
}>>>;
|
|
12
|
+
required: import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
|
|
13
|
+
}>, import("@scalar/validation").ObjectSchema<{
|
|
14
|
+
'x-scalar-selected-content-type': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").StringSchema>>;
|
|
15
|
+
}>]>;
|
|
16
|
+
//# sourceMappingURL=request-body.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request-body.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/request-body.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,WAAW;;;;;;;;;;;;;;IAyBvB,CAAA"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { boolean, intersection, lazy, object, optional, record, string } from '@scalar/validation';
|
|
2
|
+
import { XScalarSelectedContentType } from '../../extensions/operation/index.js';
|
|
3
|
+
import { mediaType } from '../../openapi/3.1/media-type.js';
|
|
4
|
+
export const requestBody = intersection([
|
|
5
|
+
object({
|
|
6
|
+
description: optional(string({
|
|
7
|
+
typeComment: 'A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.',
|
|
8
|
+
})),
|
|
9
|
+
content: record(string(), lazy(() => mediaType), {
|
|
10
|
+
typeComment: 'REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it.',
|
|
11
|
+
typeName: 'RequestBodyContent',
|
|
12
|
+
}),
|
|
13
|
+
required: optional(boolean({ typeComment: 'Determines if the request body is required in the request. Defaults to false.' })),
|
|
14
|
+
}),
|
|
15
|
+
XScalarSelectedContentType,
|
|
16
|
+
], { typeName: 'RequestBodyObject' });
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export declare const response: import("@scalar/validation").ObjectSchema<{
|
|
2
|
+
description: import("@scalar/validation").StringSchema;
|
|
3
|
+
headers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
4
|
+
content: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").LazySchema<() => import("@scalar/validation").ObjectSchema<{
|
|
5
|
+
schema: import("@scalar/validation").OptionalSchema<import("@scalar/validation").Schema>;
|
|
6
|
+
example: import("@scalar/validation").OptionalSchema<import("@scalar/validation").AnySchema>;
|
|
7
|
+
examples: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
8
|
+
encoding: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
|
|
9
|
+
contentType: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
|
|
10
|
+
headers: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
11
|
+
}>>>;
|
|
12
|
+
}>>>>;
|
|
13
|
+
links: import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>>;
|
|
14
|
+
}>;
|
|
15
|
+
export declare const responsesObject: import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").Schema>;
|
|
16
|
+
//# sourceMappingURL=response.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/response.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,QAAQ;;;;;;;;;;;;;EAiBpB,CAAA;AAED,eAAO,MAAM,eAAe,2HAE1B,CAAA"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { lazy, object, optional, record, string } from '@scalar/validation';
|
|
2
|
+
import { link } from '../../openapi/3.1/link.js';
|
|
3
|
+
import { header, mediaType } from '../../openapi/3.1/media-type.js';
|
|
4
|
+
import { recursiveRef } from '../../openapi/3.1/reference.js';
|
|
5
|
+
export const response = object({
|
|
6
|
+
description: string({
|
|
7
|
+
typeComment: 'REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.',
|
|
8
|
+
}),
|
|
9
|
+
headers: optional(record(string(), recursiveRef(lazy(() => header)), { typeName: 'ResponseHeaders' })),
|
|
10
|
+
content: optional(record(string(), lazy(() => mediaType), { typeName: 'ResponseContent' })),
|
|
11
|
+
links: optional(record(string(), recursiveRef(lazy(() => link)), { typeName: 'ResponseLinks' })),
|
|
12
|
+
}, { typeName: 'ResponseObject' });
|
|
13
|
+
export const responsesObject = record(string(), recursiveRef(lazy(() => response)), {
|
|
14
|
+
typeName: 'ResponsesObject',
|
|
15
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/openapi/3.1/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EAaZ,MAAM,oBAAoB,CAAA;AAqI3B,eAAO,MAAM,MAAM,EAAE,MAOpB,CAAA"}
|