@skmtc/core 0.29.0 → 0.30.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/esm/_dnt.polyfills.d.ts +11 -0
- package/esm/_dnt.polyfills.js +14 -0
- package/esm/context/ParseContext.js +9 -1
- package/esm/context/generateTypes.d.ts +2 -2
- package/esm/context/generateTypes.js +3 -1
- package/esm/dsl/GeneratorKeys.d.ts +2 -2
- package/esm/dsl/GeneratorKeys.js +6 -3
- package/esm/helpers/naming.d.ts +2 -1
- package/esm/helpers/naming.js +4 -2
- package/esm/oas/discriminator/Discriminator.d.ts +3 -0
- package/esm/oas/discriminator/Discriminator.js +7 -0
- package/esm/oas/document/Document.d.ts +7 -0
- package/esm/oas/document/Document.js +8 -0
- package/esm/oas/example/Example.d.ts +10 -1
- package/esm/oas/example/Example.js +16 -0
- package/esm/oas/mediaType/MediaType.d.ts +12 -0
- package/esm/oas/mediaType/MediaType.js +24 -0
- package/esm/oas/parameter/Parameter.d.ts +2 -1
- package/esm/oas/parameter/Parameter.js +5 -2
- package/esm/oas/parameter/parameter-types.d.ts +10 -2
- package/esm/oas/parameter/parameter-types.js +3 -1
- package/esm/oas/response/Response.d.ts +6 -1
- package/esm/oas/response/Response.js +8 -0
- package/esm/oas/securitySchemes/SecurityScheme.d.ts +47 -4
- package/esm/oas/securitySchemes/SecurityScheme.js +46 -1
- package/esm/oas/securitySchemes/security-scheme-types.d.ts +21 -0
- package/esm/oas/server/Server.d.ts +8 -2
- package/esm/oas/server/Server.js +10 -1
- package/esm/oas/tag/Tag.d.ts +9 -0
- package/esm/oas/tag/Tag.js +9 -0
- package/esm/parse/toOasDialect.d.ts +8 -7
- package/esm/parse/toOasDialect.js +4 -2
- package/esm/parse/v3-0/methods.d.ts +11 -0
- package/esm/parse/v3-0/methods.js +16 -0
- package/esm/parse/v3-0/operation/toOperationsV3.js +5 -5
- package/esm/parse/v3-0/parameter/toParameterV3.d.ts +4 -2
- package/esm/parse/v3-0/parameter/toParameterV3.js +17 -3
- package/esm/parse/v3-0/securitySchemes/toSecuritySchemes.js +50 -38
- package/esm/parse/v3-0/webhook/toWebhooksV3.js +5 -5
- package/esm/parse/v3-1/methods.d.ts +11 -0
- package/esm/parse/v3-1/methods.js +16 -0
- package/esm/parse/v3-1/operation/toOperationsV3.js +5 -5
- package/esm/parse/v3-1/parameter/toParameterV3.d.ts +4 -2
- package/esm/parse/v3-1/parameter/toParameterV3.js +17 -3
- package/esm/parse/v3-1/securitySchemes/toSecuritySchemes.js +50 -38
- package/esm/parse/v3-1/webhook/toWebhooksV3.js +5 -5
- package/esm/parse/v3-2/_helpers/parseDefault.d.ts +43 -0
- package/esm/parse/v3-2/_helpers/parseDefault.js +39 -0
- package/esm/parse/v3-2/_helpers/parseEnum.d.ts +13 -0
- package/esm/parse/v3-2/_helpers/parseEnum.js +23 -0
- package/esm/parse/v3-2/_helpers/parseExample.d.ts +41 -0
- package/esm/parse/v3-2/_helpers/parseExample.js +37 -0
- package/esm/parse/v3-2/_helpers/parseNullable.d.ts +141 -0
- package/esm/parse/v3-2/_helpers/parseNullable.js +140 -0
- package/esm/parse/v3-2/_merge-all-of/check-array-item-type-conflicts.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/check-array-item-type-conflicts.js +9 -0
- package/esm/parse/v3-2/_merge-all-of/check-at-least-one-type-match.d.ts +4 -0
- package/esm/parse/v3-2/_merge-all-of/check-at-least-one-type-match.js +5 -0
- package/esm/parse/v3-2/_merge-all-of/check-enum-conflicts.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/check-enum-conflicts.js +11 -0
- package/esm/parse/v3-2/_merge-all-of/check-format-conflicts.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/check-format-conflicts.js +5 -0
- package/esm/parse/v3-2/_merge-all-of/check-number-constraints-conflicts.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/check-number-constraints-conflicts.js +11 -0
- package/esm/parse/v3-2/_merge-all-of/check-read-only-write-only-conflicts.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/check-read-only-write-only-conflicts.js +5 -0
- package/esm/parse/v3-2/_merge-all-of/check-type-conflicts.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/check-type-conflicts.js +5 -0
- package/esm/parse/v3-2/_merge-all-of/cross-product.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/cross-product.js +3 -0
- package/esm/parse/v3-2/_merge-all-of/decompose-intersection.d.ts +6 -0
- package/esm/parse/v3-2/_merge-all-of/decompose-intersection.js +27 -0
- package/esm/parse/v3-2/_merge-all-of/decompose-union.d.ts +12 -0
- package/esm/parse/v3-2/_merge-all-of/decompose-union.js +69 -0
- package/esm/parse/v3-2/_merge-all-of/generic-merge.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/generic-merge.js +12 -0
- package/esm/parse/v3-2/_merge-all-of/is-equal.d.ts +1 -0
- package/esm/parse/v3-2/_merge-all-of/is-equal.js +19 -0
- package/esm/parse/v3-2/_merge-all-of/merge-array-constraints.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/merge-array-constraints.js +44 -0
- package/esm/parse/v3-2/_merge-all-of/merge-boolean-constraints.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/merge-boolean-constraints.js +7 -0
- package/esm/parse/v3-2/_merge-all-of/merge-enum-values.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/merge-enum-values.js +32 -0
- package/esm/parse/v3-2/_merge-all-of/merge-integer-constraints.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/merge-integer-constraints.js +41 -0
- package/esm/parse/v3-2/_merge-all-of/merge-intersection.d.ts +8 -0
- package/esm/parse/v3-2/_merge-all-of/merge-intersection.js +16 -0
- package/esm/parse/v3-2/_merge-all-of/merge-number-constraints.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/merge-number-constraints.js +41 -0
- package/esm/parse/v3-2/_merge-all-of/merge-object-constraints.d.ts +5 -0
- package/esm/parse/v3-2/_merge-all-of/merge-object-constraints.js +28 -0
- package/esm/parse/v3-2/_merge-all-of/merge-properties.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/merge-properties.js +25 -0
- package/esm/parse/v3-2/_merge-all-of/merge-required.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/merge-required.js +10 -0
- package/esm/parse/v3-2/_merge-all-of/merge-string-constraints.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/merge-string-constraints.js +55 -0
- package/esm/parse/v3-2/_merge-all-of/merge-union.d.ts +15 -0
- package/esm/parse/v3-2/_merge-all-of/merge-union.js +53 -0
- package/esm/parse/v3-2/_merge-all-of/merge.d.ts +2 -0
- package/esm/parse/v3-2/_merge-all-of/merge.js +155 -0
- package/esm/parse/v3-2/_merge-all-of/nullable-merge.d.ts +3 -0
- package/esm/parse/v3-2/_merge-all-of/nullable-merge.js +12 -0
- package/esm/parse/v3-2/_merge-all-of/types.d.ts +14 -0
- package/esm/parse/v3-2/_merge-all-of/types.js +2 -0
- package/esm/parse/v3-2/array/toArray.d.ts +80 -0
- package/esm/parse/v3-2/array/toArray.js +165 -0
- package/esm/parse/v3-2/boolean/toBoolean.d.ts +78 -0
- package/esm/parse/v3-2/boolean/toBoolean.js +139 -0
- package/esm/parse/v3-2/components/toComponentsV3.d.ts +14 -0
- package/esm/parse/v3-2/components/toComponentsV3.js +43 -0
- package/esm/parse/v3-2/contact/toContactV3.d.ts +5 -0
- package/esm/parse/v3-2/contact/toContactV3.js +18 -0
- package/esm/parse/v3-2/discriminator/toDiscriminatorV3.d.ts +14 -0
- package/esm/parse/v3-2/discriminator/toDiscriminatorV3.js +21 -0
- package/esm/parse/v3-2/document/toDocumentFieldsV3.d.ts +16 -0
- package/esm/parse/v3-2/document/toDocumentFieldsV3.js +33 -0
- package/esm/parse/v3-2/example/toExamplesV3.d.ts +77 -0
- package/esm/parse/v3-2/example/toExamplesV3.js +143 -0
- package/esm/parse/v3-2/externalDocs/toExternalDocs.d.ts +10 -0
- package/esm/parse/v3-2/externalDocs/toExternalDocs.js +15 -0
- package/esm/parse/v3-2/header/toHeadersV3.d.ts +18 -0
- package/esm/parse/v3-2/header/toHeadersV3.js +47 -0
- package/esm/parse/v3-2/info/toInfoV3.d.ts +10 -0
- package/esm/parse/v3-2/info/toInfoV3.js +23 -0
- package/esm/parse/v3-2/integer/toInteger.d.ts +21 -0
- package/esm/parse/v3-2/integer/toInteger.js +115 -0
- package/esm/parse/v3-2/license/toLicenseV3.d.ts +5 -0
- package/esm/parse/v3-2/license/toLicenseV3.js +17 -0
- package/esm/parse/v3-2/link/toLinksV3.d.ts +16 -0
- package/esm/parse/v3-2/link/toLinksV3.js +40 -0
- package/esm/parse/v3-2/mediaType/toMediaTypeItemV3.d.ts +323 -0
- package/esm/parse/v3-2/mediaType/toMediaTypeItemV3.js +375 -0
- package/esm/parse/v3-2/methods.d.ts +17 -0
- package/esm/parse/v3-2/methods.js +21 -0
- package/esm/parse/v3-2/number/toNumber.d.ts +10 -0
- package/esm/parse/v3-2/number/toNumber.js +115 -0
- package/esm/parse/v3-2/object/toAdditionalPropertiesV3.d.ts +11 -0
- package/esm/parse/v3-2/object/toAdditionalPropertiesV3.js +10 -0
- package/esm/parse/v3-2/object/toObject.d.ts +10 -0
- package/esm/parse/v3-2/object/toObject.js +90 -0
- package/esm/parse/v3-2/operation/toOperationsV3.d.ts +25 -0
- package/esm/parse/v3-2/operation/toOperationsV3.js +129 -0
- package/esm/parse/v3-2/parameter/toParameterV3.d.ts +39 -0
- package/esm/parse/v3-2/parameter/toParameterV3.js +152 -0
- package/esm/parse/v3-2/parameter/warnQuerystringConflictsV3.d.ts +22 -0
- package/esm/parse/v3-2/parameter/warnQuerystringConflictsV3.js +39 -0
- package/esm/parse/v3-2/pathItem/dropAdditionalOperationsV3.d.ts +17 -0
- package/esm/parse/v3-2/pathItem/dropAdditionalOperationsV3.js +34 -0
- package/esm/parse/v3-2/pathItem/toPathItemV3.d.ts +23 -0
- package/esm/parse/v3-2/pathItem/toPathItemV3.js +45 -0
- package/esm/parse/v3-2/ref/toRefV31.d.ts +19 -0
- package/esm/parse/v3-2/ref/toRefV31.js +10 -0
- package/esm/parse/v3-2/requestBody/toRequestBodiesV3.d.ts +18 -0
- package/esm/parse/v3-2/requestBody/toRequestBodiesV3.js +44 -0
- package/esm/parse/v3-2/response/toResponseV3.d.ts +29 -0
- package/esm/parse/v3-2/response/toResponseV3.js +56 -0
- package/esm/parse/v3-2/schema/toSchemasV3.d.ts +29 -0
- package/esm/parse/v3-2/schema/toSchemasV3.js +511 -0
- package/esm/parse/v3-2/securityRequirement/toSecurityRequirement.d.ts +9 -0
- package/esm/parse/v3-2/securityRequirement/toSecurityRequirement.js +9 -0
- package/esm/parse/v3-2/securitySchemes/toSecuritySchemes.d.ts +17 -0
- package/esm/parse/v3-2/securitySchemes/toSecuritySchemes.js +152 -0
- package/esm/parse/v3-2/server/toServerV3.d.ts +26 -0
- package/esm/parse/v3-2/server/toServerV3.js +31 -0
- package/esm/parse/v3-2/serverVariable/toServerVariableV3.d.ts +22 -0
- package/esm/parse/v3-2/serverVariable/toServerVariableV3.js +30 -0
- package/esm/parse/v3-2/specificationExtensions/toSpecificationExtensionsV3.d.ts +14 -0
- package/esm/parse/v3-2/specificationExtensions/toSpecificationExtensionsV3.js +25 -0
- package/esm/parse/v3-2/string/toString.d.ts +146 -0
- package/esm/parse/v3-2/string/toString.js +211 -0
- package/esm/parse/v3-2/tag/toTagsV3.d.ts +22 -0
- package/esm/parse/v3-2/tag/toTagsV3.js +78 -0
- package/esm/parse/v3-2/union/toUnion.d.ts +12 -0
- package/esm/parse/v3-2/union/toUnion.js +68 -0
- package/esm/parse/v3-2/unknown/toUnknown.d.ts +10 -0
- package/esm/parse/v3-2/unknown/toUnknown.js +19 -0
- package/esm/parse/v3-2/webhook/toWebhooksV3.d.ts +48 -0
- package/esm/parse/v3-2/webhook/toWebhooksV3.js +139 -0
- package/esm/types/Method.d.ts +7 -4
- package/esm/types/Method.js +17 -4
- package/esm/types/Preview.d.ts +2 -1
- package/esm/types/SkmtcDocument.d.ts +6 -6
- package/package.json +1 -1
- package/script/_dnt.polyfills.d.ts +11 -0
- package/script/_dnt.polyfills.js +14 -0
- package/script/context/ParseContext.js +9 -1
- package/script/context/generateTypes.d.ts +2 -2
- package/script/context/generateTypes.js +3 -1
- package/script/dsl/GeneratorKeys.d.ts +2 -2
- package/script/dsl/GeneratorKeys.js +6 -3
- package/script/helpers/naming.d.ts +2 -1
- package/script/helpers/naming.js +4 -2
- package/script/oas/discriminator/Discriminator.d.ts +3 -0
- package/script/oas/discriminator/Discriminator.js +7 -0
- package/script/oas/document/Document.d.ts +7 -0
- package/script/oas/document/Document.js +8 -0
- package/script/oas/example/Example.d.ts +10 -1
- package/script/oas/example/Example.js +16 -0
- package/script/oas/mediaType/MediaType.d.ts +12 -0
- package/script/oas/mediaType/MediaType.js +24 -0
- package/script/oas/parameter/Parameter.d.ts +2 -1
- package/script/oas/parameter/Parameter.js +5 -2
- package/script/oas/parameter/parameter-types.d.ts +10 -2
- package/script/oas/parameter/parameter-types.js +3 -1
- package/script/oas/response/Response.d.ts +6 -1
- package/script/oas/response/Response.js +8 -0
- package/script/oas/securitySchemes/SecurityScheme.d.ts +47 -4
- package/script/oas/securitySchemes/SecurityScheme.js +46 -1
- package/script/oas/securitySchemes/security-scheme-types.d.ts +21 -0
- package/script/oas/server/Server.d.ts +8 -2
- package/script/oas/server/Server.js +10 -1
- package/script/oas/tag/Tag.d.ts +9 -0
- package/script/oas/tag/Tag.js +9 -0
- package/script/parse/toOasDialect.d.ts +8 -7
- package/script/parse/toOasDialect.js +4 -2
- package/script/parse/v3-0/methods.d.ts +11 -0
- package/script/parse/v3-0/methods.js +20 -0
- package/script/parse/v3-0/operation/toOperationsV3.js +5 -5
- package/script/parse/v3-0/parameter/toParameterV3.d.ts +4 -2
- package/script/parse/v3-0/parameter/toParameterV3.js +17 -3
- package/script/parse/v3-0/securitySchemes/toSecuritySchemes.js +49 -37
- package/script/parse/v3-0/webhook/toWebhooksV3.js +5 -5
- package/script/parse/v3-1/methods.d.ts +11 -0
- package/script/parse/v3-1/methods.js +20 -0
- package/script/parse/v3-1/operation/toOperationsV3.js +5 -5
- package/script/parse/v3-1/parameter/toParameterV3.d.ts +4 -2
- package/script/parse/v3-1/parameter/toParameterV3.js +17 -3
- package/script/parse/v3-1/securitySchemes/toSecuritySchemes.js +49 -37
- package/script/parse/v3-1/webhook/toWebhooksV3.js +5 -5
- package/script/parse/v3-2/_helpers/parseDefault.d.ts +43 -0
- package/script/parse/v3-2/_helpers/parseDefault.js +43 -0
- package/script/parse/v3-2/_helpers/parseEnum.d.ts +13 -0
- package/script/parse/v3-2/_helpers/parseEnum.js +27 -0
- package/script/parse/v3-2/_helpers/parseExample.d.ts +41 -0
- package/script/parse/v3-2/_helpers/parseExample.js +41 -0
- package/script/parse/v3-2/_helpers/parseNullable.d.ts +141 -0
- package/script/parse/v3-2/_helpers/parseNullable.js +144 -0
- package/script/parse/v3-2/_merge-all-of/check-array-item-type-conflicts.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/check-array-item-type-conflicts.js +13 -0
- package/script/parse/v3-2/_merge-all-of/check-at-least-one-type-match.d.ts +4 -0
- package/script/parse/v3-2/_merge-all-of/check-at-least-one-type-match.js +9 -0
- package/script/parse/v3-2/_merge-all-of/check-enum-conflicts.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/check-enum-conflicts.js +15 -0
- package/script/parse/v3-2/_merge-all-of/check-format-conflicts.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/check-format-conflicts.js +9 -0
- package/script/parse/v3-2/_merge-all-of/check-number-constraints-conflicts.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/check-number-constraints-conflicts.js +15 -0
- package/script/parse/v3-2/_merge-all-of/check-read-only-write-only-conflicts.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/check-read-only-write-only-conflicts.js +9 -0
- package/script/parse/v3-2/_merge-all-of/check-type-conflicts.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/check-type-conflicts.js +9 -0
- package/script/parse/v3-2/_merge-all-of/cross-product.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/cross-product.js +7 -0
- package/script/parse/v3-2/_merge-all-of/decompose-intersection.d.ts +6 -0
- package/script/parse/v3-2/_merge-all-of/decompose-intersection.js +31 -0
- package/script/parse/v3-2/_merge-all-of/decompose-union.d.ts +12 -0
- package/script/parse/v3-2/_merge-all-of/decompose-union.js +73 -0
- package/script/parse/v3-2/_merge-all-of/generic-merge.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/generic-merge.js +16 -0
- package/script/parse/v3-2/_merge-all-of/is-equal.d.ts +1 -0
- package/script/parse/v3-2/_merge-all-of/is-equal.js +23 -0
- package/script/parse/v3-2/_merge-all-of/merge-array-constraints.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/merge-array-constraints.js +80 -0
- package/script/parse/v3-2/_merge-all-of/merge-boolean-constraints.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/merge-boolean-constraints.js +43 -0
- package/script/parse/v3-2/_merge-all-of/merge-enum-values.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/merge-enum-values.js +68 -0
- package/script/parse/v3-2/_merge-all-of/merge-integer-constraints.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/merge-integer-constraints.js +77 -0
- package/script/parse/v3-2/_merge-all-of/merge-intersection.d.ts +8 -0
- package/script/parse/v3-2/_merge-all-of/merge-intersection.js +20 -0
- package/script/parse/v3-2/_merge-all-of/merge-number-constraints.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/merge-number-constraints.js +77 -0
- package/script/parse/v3-2/_merge-all-of/merge-object-constraints.d.ts +5 -0
- package/script/parse/v3-2/_merge-all-of/merge-object-constraints.js +65 -0
- package/script/parse/v3-2/_merge-all-of/merge-properties.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/merge-properties.js +29 -0
- package/script/parse/v3-2/_merge-all-of/merge-required.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/merge-required.js +15 -0
- package/script/parse/v3-2/_merge-all-of/merge-string-constraints.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/merge-string-constraints.js +91 -0
- package/script/parse/v3-2/_merge-all-of/merge-union.d.ts +15 -0
- package/script/parse/v3-2/_merge-all-of/merge-union.js +58 -0
- package/script/parse/v3-2/_merge-all-of/merge.d.ts +2 -0
- package/script/parse/v3-2/_merge-all-of/merge.js +159 -0
- package/script/parse/v3-2/_merge-all-of/nullable-merge.d.ts +3 -0
- package/script/parse/v3-2/_merge-all-of/nullable-merge.js +17 -0
- package/script/parse/v3-2/_merge-all-of/types.d.ts +14 -0
- package/script/parse/v3-2/_merge-all-of/types.js +38 -0
- package/script/parse/v3-2/array/toArray.d.ts +80 -0
- package/script/parse/v3-2/array/toArray.js +203 -0
- package/script/parse/v3-2/boolean/toBoolean.d.ts +78 -0
- package/script/parse/v3-2/boolean/toBoolean.js +177 -0
- package/script/parse/v3-2/components/toComponentsV3.d.ts +14 -0
- package/script/parse/v3-2/components/toComponentsV3.js +47 -0
- package/script/parse/v3-2/contact/toContactV3.d.ts +5 -0
- package/script/parse/v3-2/contact/toContactV3.js +22 -0
- package/script/parse/v3-2/discriminator/toDiscriminatorV3.d.ts +14 -0
- package/script/parse/v3-2/discriminator/toDiscriminatorV3.js +25 -0
- package/script/parse/v3-2/document/toDocumentFieldsV3.d.ts +16 -0
- package/script/parse/v3-2/document/toDocumentFieldsV3.js +37 -0
- package/script/parse/v3-2/example/toExamplesV3.d.ts +77 -0
- package/script/parse/v3-2/example/toExamplesV3.js +149 -0
- package/script/parse/v3-2/externalDocs/toExternalDocs.d.ts +10 -0
- package/script/parse/v3-2/externalDocs/toExternalDocs.js +52 -0
- package/script/parse/v3-2/header/toHeadersV3.d.ts +18 -0
- package/script/parse/v3-2/header/toHeadersV3.js +51 -0
- package/script/parse/v3-2/info/toInfoV3.d.ts +10 -0
- package/script/parse/v3-2/info/toInfoV3.js +27 -0
- package/script/parse/v3-2/integer/toInteger.d.ts +21 -0
- package/script/parse/v3-2/integer/toInteger.js +153 -0
- package/script/parse/v3-2/license/toLicenseV3.d.ts +5 -0
- package/script/parse/v3-2/license/toLicenseV3.js +21 -0
- package/script/parse/v3-2/link/toLinksV3.d.ts +16 -0
- package/script/parse/v3-2/link/toLinksV3.js +44 -0
- package/script/parse/v3-2/mediaType/toMediaTypeItemV3.d.ts +323 -0
- package/script/parse/v3-2/mediaType/toMediaTypeItemV3.js +381 -0
- package/script/parse/v3-2/methods.d.ts +17 -0
- package/script/parse/v3-2/methods.js +25 -0
- package/script/parse/v3-2/number/toNumber.d.ts +10 -0
- package/script/parse/v3-2/number/toNumber.js +152 -0
- package/script/parse/v3-2/object/toAdditionalPropertiesV3.d.ts +11 -0
- package/script/parse/v3-2/object/toAdditionalPropertiesV3.js +14 -0
- package/script/parse/v3-2/object/toObject.d.ts +10 -0
- package/script/parse/v3-2/object/toObject.js +94 -0
- package/script/parse/v3-2/operation/toOperationsV3.d.ts +25 -0
- package/script/parse/v3-2/operation/toOperationsV3.js +134 -0
- package/script/parse/v3-2/parameter/toParameterV3.d.ts +39 -0
- package/script/parse/v3-2/parameter/toParameterV3.js +191 -0
- package/script/parse/v3-2/parameter/warnQuerystringConflictsV3.d.ts +22 -0
- package/script/parse/v3-2/parameter/warnQuerystringConflictsV3.js +43 -0
- package/script/parse/v3-2/pathItem/dropAdditionalOperationsV3.d.ts +17 -0
- package/script/parse/v3-2/pathItem/dropAdditionalOperationsV3.js +38 -0
- package/script/parse/v3-2/pathItem/toPathItemV3.d.ts +23 -0
- package/script/parse/v3-2/pathItem/toPathItemV3.js +50 -0
- package/script/parse/v3-2/ref/toRefV31.d.ts +19 -0
- package/script/parse/v3-2/ref/toRefV31.js +14 -0
- package/script/parse/v3-2/requestBody/toRequestBodiesV3.d.ts +18 -0
- package/script/parse/v3-2/requestBody/toRequestBodiesV3.js +49 -0
- package/script/parse/v3-2/response/toResponseV3.d.ts +29 -0
- package/script/parse/v3-2/response/toResponseV3.js +62 -0
- package/script/parse/v3-2/schema/toSchemasV3.d.ts +29 -0
- package/script/parse/v3-2/schema/toSchemasV3.js +518 -0
- package/script/parse/v3-2/securityRequirement/toSecurityRequirement.d.ts +9 -0
- package/script/parse/v3-2/securityRequirement/toSecurityRequirement.js +13 -0
- package/script/parse/v3-2/securitySchemes/toSecuritySchemes.d.ts +17 -0
- package/script/parse/v3-2/securitySchemes/toSecuritySchemes.js +189 -0
- package/script/parse/v3-2/server/toServerV3.d.ts +26 -0
- package/script/parse/v3-2/server/toServerV3.js +37 -0
- package/script/parse/v3-2/serverVariable/toServerVariableV3.d.ts +22 -0
- package/script/parse/v3-2/serverVariable/toServerVariableV3.js +36 -0
- package/script/parse/v3-2/specificationExtensions/toSpecificationExtensionsV3.d.ts +14 -0
- package/script/parse/v3-2/specificationExtensions/toSpecificationExtensionsV3.js +30 -0
- package/script/parse/v3-2/string/toString.d.ts +146 -0
- package/script/parse/v3-2/string/toString.js +249 -0
- package/script/parse/v3-2/tag/toTagsV3.d.ts +22 -0
- package/script/parse/v3-2/tag/toTagsV3.js +83 -0
- package/script/parse/v3-2/union/toUnion.d.ts +12 -0
- package/script/parse/v3-2/union/toUnion.js +72 -0
- package/script/parse/v3-2/unknown/toUnknown.d.ts +10 -0
- package/script/parse/v3-2/unknown/toUnknown.js +23 -0
- package/script/parse/v3-2/webhook/toWebhooksV3.d.ts +48 -0
- package/script/parse/v3-2/webhook/toWebhooksV3.js +144 -0
- package/script/types/Method.d.ts +7 -4
- package/script/types/Method.js +17 -4
- package/script/types/Preview.d.ts +2 -1
- package/script/types/SkmtcDocument.d.ts +6 -6
|
@@ -4,7 +4,7 @@ import type { Method } from '../types/Method.js';
|
|
|
4
4
|
* Determines the endpoint type based on HTTP method.
|
|
5
5
|
*
|
|
6
6
|
* @param operation - The OpenAPI operation to analyze
|
|
7
|
-
* @returns 'query' for GET operations, 'mutation' for all others
|
|
7
|
+
* @returns 'query' for GET and QUERY operations, 'mutation' for all others
|
|
8
8
|
*
|
|
9
9
|
* @example
|
|
10
10
|
* ```typescript
|
|
@@ -67,6 +67,7 @@ export declare const toArgsName: (operation: OasOperation) => string;
|
|
|
67
67
|
* console.log(toMethodVerb('put')); // 'Update'
|
|
68
68
|
* console.log(toMethodVerb('get')); // 'get'
|
|
69
69
|
* console.log(toMethodVerb('delete')); // 'delete'
|
|
70
|
+
* console.log(toMethodVerb('query')); // 'Query'
|
|
70
71
|
* ```
|
|
71
72
|
*/
|
|
72
73
|
export declare const toMethodVerb: (method: Method) => string;
|
package/script/helpers/naming.js
CHANGED
|
@@ -6,7 +6,7 @@ const strings_js_1 = require("./strings.js");
|
|
|
6
6
|
* Determines the endpoint type based on HTTP method.
|
|
7
7
|
*
|
|
8
8
|
* @param operation - The OpenAPI operation to analyze
|
|
9
|
-
* @returns 'query' for GET operations, 'mutation' for all others
|
|
9
|
+
* @returns 'query' for GET and QUERY operations, 'mutation' for all others
|
|
10
10
|
*
|
|
11
11
|
* @example
|
|
12
12
|
* ```typescript
|
|
@@ -18,7 +18,8 @@ const strings_js_1 = require("./strings.js");
|
|
|
18
18
|
* ```
|
|
19
19
|
*/
|
|
20
20
|
const toEndpointType = (operation) => {
|
|
21
|
-
|
|
21
|
+
// QUERY is safe and idempotent, like GET.
|
|
22
|
+
return operation.method === 'get' || operation.method === 'query' ? 'query' : 'mutation';
|
|
22
23
|
};
|
|
23
24
|
exports.toEndpointType = toEndpointType;
|
|
24
25
|
/**
|
|
@@ -85,6 +86,7 @@ exports.toArgsName = toArgsName;
|
|
|
85
86
|
* console.log(toMethodVerb('put')); // 'Update'
|
|
86
87
|
* console.log(toMethodVerb('get')); // 'get'
|
|
87
88
|
* console.log(toMethodVerb('delete')); // 'delete'
|
|
89
|
+
* console.log(toMethodVerb('query')); // 'Query'
|
|
88
90
|
* ```
|
|
89
91
|
*/
|
|
90
92
|
const toMethodVerb = (method) => {
|
|
@@ -2,10 +2,13 @@ import "../../_dnt.polyfills.js";
|
|
|
2
2
|
export type DiscriminatorFields = {
|
|
3
3
|
propertyName: string;
|
|
4
4
|
mapping?: Record<string, string>;
|
|
5
|
+
/** Schema to use when the discriminating value has no mapping entry (OpenAPI 3.2) */
|
|
6
|
+
defaultMapping?: string;
|
|
5
7
|
};
|
|
6
8
|
export declare class OasDiscriminator {
|
|
7
9
|
oasType: 'discriminator';
|
|
8
10
|
propertyName: string;
|
|
9
11
|
mapping?: Record<string, string>;
|
|
12
|
+
defaultMapping?: string;
|
|
10
13
|
constructor(fields: DiscriminatorFields);
|
|
11
14
|
}
|
|
@@ -22,8 +22,15 @@ class OasDiscriminator {
|
|
|
22
22
|
writable: true,
|
|
23
23
|
value: void 0
|
|
24
24
|
});
|
|
25
|
+
Object.defineProperty(this, "defaultMapping", {
|
|
26
|
+
enumerable: true,
|
|
27
|
+
configurable: true,
|
|
28
|
+
writable: true,
|
|
29
|
+
value: void 0
|
|
30
|
+
});
|
|
25
31
|
this.propertyName = fields.propertyName;
|
|
26
32
|
this.mapping = fields.mapping;
|
|
33
|
+
this.defaultMapping = fields.defaultMapping;
|
|
27
34
|
}
|
|
28
35
|
}
|
|
29
36
|
exports.OasDiscriminator = OasDiscriminator;
|
|
@@ -20,6 +20,11 @@ import type { OasExternalDocs } from '../externalDocs/ExternalDocs.js';
|
|
|
20
20
|
export type DocumentFields = {
|
|
21
21
|
/** OpenAPI specification version (e.g., '3.0.0', '3.1.0') */
|
|
22
22
|
openapi: string;
|
|
23
|
+
/**
|
|
24
|
+
* The document's own URI (OpenAPI 3.2 `$self`). Stored only: reference
|
|
25
|
+
* resolution does not use it.
|
|
26
|
+
*/
|
|
27
|
+
$self?: string | undefined;
|
|
23
28
|
/** API metadata including title, version, description */
|
|
24
29
|
info: OasInfo;
|
|
25
30
|
/** Array of server objects providing connectivity information */
|
|
@@ -215,6 +220,8 @@ export declare class OasDocument {
|
|
|
215
220
|
set fields(fields: DocumentFields);
|
|
216
221
|
/** OpenAPI specification version */
|
|
217
222
|
get openapi(): string;
|
|
223
|
+
/** The document's own URI (OpenAPI 3.2 `$self`) */
|
|
224
|
+
get $self(): string | undefined;
|
|
218
225
|
/** API metadata */
|
|
219
226
|
get info(): OasInfo;
|
|
220
227
|
get servers(): OasServer[] | undefined;
|
|
@@ -228,6 +228,13 @@ class OasDocument {
|
|
|
228
228
|
}
|
|
229
229
|
return __classPrivateFieldGet(this, _OasDocument_fields, "f").openapi;
|
|
230
230
|
}
|
|
231
|
+
/** The document's own URI (OpenAPI 3.2 `$self`) */
|
|
232
|
+
get $self() {
|
|
233
|
+
if (!__classPrivateFieldGet(this, _OasDocument_fields, "f")) {
|
|
234
|
+
throw new Error(`Accessing '$self' before fields are set`);
|
|
235
|
+
}
|
|
236
|
+
return __classPrivateFieldGet(this, _OasDocument_fields, "f").$self;
|
|
237
|
+
}
|
|
231
238
|
/** API metadata */
|
|
232
239
|
get info() {
|
|
233
240
|
if (!__classPrivateFieldGet(this, _OasDocument_fields, "f")) {
|
|
@@ -314,6 +321,7 @@ class OasDocument {
|
|
|
314
321
|
toJSON() {
|
|
315
322
|
return {
|
|
316
323
|
openapi: this.openapi,
|
|
324
|
+
...(this.$self !== undefined ? { $self: this.$self } : {}),
|
|
317
325
|
info: this.info,
|
|
318
326
|
servers: this.servers,
|
|
319
327
|
operations: this.operations,
|
|
@@ -11,6 +11,10 @@ export type ExampleFields = {
|
|
|
11
11
|
description?: string;
|
|
12
12
|
/** The example value — absent when the example is given as an `externalValue` */
|
|
13
13
|
value?: unknown;
|
|
14
|
+
/** The example as data that is valid against its schema (OpenAPI 3.2) */
|
|
15
|
+
dataValue?: unknown;
|
|
16
|
+
/** The example in its serialized form (OpenAPI 3.2) */
|
|
17
|
+
serializedValue?: string;
|
|
14
18
|
/** The external value of the example */
|
|
15
19
|
externalValue?: string;
|
|
16
20
|
/** Custom extension fields (x-* properties) */
|
|
@@ -23,6 +27,8 @@ export declare class OasExample {
|
|
|
23
27
|
summary?: string;
|
|
24
28
|
description?: string;
|
|
25
29
|
value?: unknown;
|
|
30
|
+
dataValue?: unknown;
|
|
31
|
+
serializedValue?: string;
|
|
26
32
|
externalValue?: string;
|
|
27
33
|
extensionFields?: Record<string, unknown>;
|
|
28
34
|
constructor(fields: ExampleFields);
|
|
@@ -31,5 +37,8 @@ export declare class OasExample {
|
|
|
31
37
|
/** Returns itself */
|
|
32
38
|
resolve(): OasExample;
|
|
33
39
|
resolveOnce(): OasExample;
|
|
34
|
-
toJsonSchema(_options: ToJsonSchemaOptions): OpenAPIV3.ExampleObject
|
|
40
|
+
toJsonSchema(_options: ToJsonSchemaOptions): OpenAPIV3.ExampleObject & {
|
|
41
|
+
dataValue?: unknown;
|
|
42
|
+
serializedValue?: string;
|
|
43
|
+
};
|
|
35
44
|
}
|
|
@@ -29,6 +29,18 @@ class OasExample {
|
|
|
29
29
|
writable: true,
|
|
30
30
|
value: void 0
|
|
31
31
|
});
|
|
32
|
+
Object.defineProperty(this, "dataValue", {
|
|
33
|
+
enumerable: true,
|
|
34
|
+
configurable: true,
|
|
35
|
+
writable: true,
|
|
36
|
+
value: void 0
|
|
37
|
+
});
|
|
38
|
+
Object.defineProperty(this, "serializedValue", {
|
|
39
|
+
enumerable: true,
|
|
40
|
+
configurable: true,
|
|
41
|
+
writable: true,
|
|
42
|
+
value: void 0
|
|
43
|
+
});
|
|
32
44
|
Object.defineProperty(this, "externalValue", {
|
|
33
45
|
enumerable: true,
|
|
34
46
|
configurable: true,
|
|
@@ -44,6 +56,8 @@ class OasExample {
|
|
|
44
56
|
this.summary = fields.summary;
|
|
45
57
|
this.description = fields.description;
|
|
46
58
|
this.value = fields.value;
|
|
59
|
+
this.dataValue = fields.dataValue;
|
|
60
|
+
this.serializedValue = fields.serializedValue;
|
|
47
61
|
this.externalValue = fields.externalValue;
|
|
48
62
|
this.extensionFields = fields.extensionFields;
|
|
49
63
|
}
|
|
@@ -63,6 +77,8 @@ class OasExample {
|
|
|
63
77
|
summary: this.summary,
|
|
64
78
|
description: this.description,
|
|
65
79
|
value: this.value,
|
|
80
|
+
...(this.dataValue !== undefined ? { dataValue: this.dataValue } : {}),
|
|
81
|
+
...(this.serializedValue !== undefined ? { serializedValue: this.serializedValue } : {}),
|
|
66
82
|
// Without this an `externalValue`-only example round-trips to an Example
|
|
67
83
|
// Object holding neither an inline value nor a pointer to one.
|
|
68
84
|
externalValue: this.externalValue
|
|
@@ -13,12 +13,18 @@ export type MediaTypeFields = {
|
|
|
13
13
|
mediaType: string;
|
|
14
14
|
/** The schema defining the structure of the content */
|
|
15
15
|
schema?: OasSchema | OasRef<'schema'> | undefined;
|
|
16
|
+
/** The schema of each item in a sequential media type (OpenAPI 3.2) */
|
|
17
|
+
itemSchema?: OasSchema | OasRef<'schema'> | undefined;
|
|
16
18
|
/** Example values for the media type */
|
|
17
19
|
examples?: Record<string, OasExample | OasRef<'example'>> | undefined;
|
|
18
20
|
/** Custom extension fields (x-* properties) */
|
|
19
21
|
extensionFields?: Record<string, unknown>;
|
|
20
22
|
/** Encoding information for multipart or form data */
|
|
21
23
|
encoding?: Record<string, unknown> | undefined;
|
|
24
|
+
/** Positional Encoding Objects for a multipart array (OpenAPI 3.2) */
|
|
25
|
+
prefixEncoding?: Record<string, unknown>[] | undefined;
|
|
26
|
+
/** Encoding Object for each array item (OpenAPI 3.2) */
|
|
27
|
+
itemEncoding?: Record<string, unknown> | undefined;
|
|
22
28
|
};
|
|
23
29
|
/**
|
|
24
30
|
* Represents a Media Type Object in the OpenAPI Specification.
|
|
@@ -104,12 +110,18 @@ export declare class OasMediaType extends OasBase {
|
|
|
104
110
|
mediaType: string;
|
|
105
111
|
/** The schema defining the structure and validation rules for the content */
|
|
106
112
|
schema: OasSchema | OasRef<'schema'> | undefined;
|
|
113
|
+
/** The schema of each item in a sequential media type (OpenAPI 3.2) */
|
|
114
|
+
itemSchema: OasSchema | OasRef<'schema'> | undefined;
|
|
107
115
|
/** Example values demonstrating the media type content */
|
|
108
116
|
examples: Record<string, OasExample | OasRef<'example'>> | undefined;
|
|
109
117
|
/** Custom extension fields (x-* properties) defined for this media type */
|
|
110
118
|
extensionFields: Record<string, unknown> | undefined;
|
|
111
119
|
/** Encoding information for multipart and form data serialization */
|
|
112
120
|
encoding?: Record<string, unknown> | undefined;
|
|
121
|
+
/** Positional Encoding Objects for a multipart array (OpenAPI 3.2), stored as-is */
|
|
122
|
+
prefixEncoding?: Record<string, unknown>[] | undefined;
|
|
123
|
+
/** Encoding Object for each array item (OpenAPI 3.2), stored as-is */
|
|
124
|
+
itemEncoding?: Record<string, unknown> | undefined;
|
|
113
125
|
/**
|
|
114
126
|
* Creates a new OasMediaType instance.
|
|
115
127
|
*
|
|
@@ -108,6 +108,13 @@ class OasMediaType extends OasBase_js_1.OasBase {
|
|
|
108
108
|
writable: true,
|
|
109
109
|
value: void 0
|
|
110
110
|
});
|
|
111
|
+
/** The schema of each item in a sequential media type (OpenAPI 3.2) */
|
|
112
|
+
Object.defineProperty(this, "itemSchema", {
|
|
113
|
+
enumerable: true,
|
|
114
|
+
configurable: true,
|
|
115
|
+
writable: true,
|
|
116
|
+
value: void 0
|
|
117
|
+
});
|
|
111
118
|
/** Example values demonstrating the media type content */
|
|
112
119
|
Object.defineProperty(this, "examples", {
|
|
113
120
|
enumerable: true,
|
|
@@ -129,10 +136,27 @@ class OasMediaType extends OasBase_js_1.OasBase {
|
|
|
129
136
|
writable: true,
|
|
130
137
|
value: void 0
|
|
131
138
|
});
|
|
139
|
+
/** Positional Encoding Objects for a multipart array (OpenAPI 3.2), stored as-is */
|
|
140
|
+
Object.defineProperty(this, "prefixEncoding", {
|
|
141
|
+
enumerable: true,
|
|
142
|
+
configurable: true,
|
|
143
|
+
writable: true,
|
|
144
|
+
value: void 0
|
|
145
|
+
});
|
|
146
|
+
/** Encoding Object for each array item (OpenAPI 3.2), stored as-is */
|
|
147
|
+
Object.defineProperty(this, "itemEncoding", {
|
|
148
|
+
enumerable: true,
|
|
149
|
+
configurable: true,
|
|
150
|
+
writable: true,
|
|
151
|
+
value: void 0
|
|
152
|
+
});
|
|
132
153
|
this.mediaType = fields.mediaType;
|
|
133
154
|
this.schema = fields.schema;
|
|
155
|
+
this.itemSchema = fields.itemSchema;
|
|
134
156
|
this.examples = fields.examples;
|
|
135
157
|
this.encoding = fields.encoding;
|
|
158
|
+
this.prefixEncoding = fields.prefixEncoding;
|
|
159
|
+
this.itemEncoding = fields.itemEncoding;
|
|
136
160
|
this.extensionFields = fields.extensionFields;
|
|
137
161
|
}
|
|
138
162
|
/**
|
|
@@ -240,7 +240,8 @@ export declare class OasParameter extends OasBase {
|
|
|
240
240
|
* Extracts the schema for this parameter.
|
|
241
241
|
*
|
|
242
242
|
* Returns the direct schema if available, or extracts schema from content
|
|
243
|
-
* for the specified media type.
|
|
243
|
+
* for the specified media type. When `content` has exactly one entry, its
|
|
244
|
+
* schema is used whatever the media type.
|
|
244
245
|
*
|
|
245
246
|
* @param mediaType - Media type to extract schema from when using content definitions
|
|
246
247
|
* @returns The parameter's schema object
|
|
@@ -295,7 +295,8 @@ class OasParameter extends OasBase_js_1.OasBase {
|
|
|
295
295
|
* Extracts the schema for this parameter.
|
|
296
296
|
*
|
|
297
297
|
* Returns the direct schema if available, or extracts schema from content
|
|
298
|
-
* for the specified media type.
|
|
298
|
+
* for the specified media type. When `content` has exactly one entry, its
|
|
299
|
+
* schema is used whatever the media type.
|
|
299
300
|
*
|
|
300
301
|
* @param mediaType - Media type to extract schema from when using content definitions
|
|
301
302
|
* @returns The parameter's schema object
|
|
@@ -305,7 +306,9 @@ class OasParameter extends OasBase_js_1.OasBase {
|
|
|
305
306
|
if (this.schema) {
|
|
306
307
|
return this.schema;
|
|
307
308
|
}
|
|
308
|
-
const
|
|
309
|
+
const contentEntries = Object.values(this.content ?? {});
|
|
310
|
+
const onlyEntry = contentEntries.length === 1 ? contentEntries[0] : undefined;
|
|
311
|
+
const schema = this.content?.[mediaType]?.schema ?? onlyEntry?.schema;
|
|
309
312
|
if (!schema) {
|
|
310
313
|
throw new Error(`Schema not found for media type ${mediaType}`);
|
|
311
314
|
}
|
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
import * as v from 'valibot';
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* Parameter locations across OpenAPI 3.0 to 3.2. `querystring` is new in
|
|
4
|
+
* 3.2; each parser tree accepts its own subset.
|
|
5
|
+
*/
|
|
6
|
+
export type OasParameterLocation = 'query' | 'querystring' | 'header' | 'path' | 'cookie';
|
|
3
7
|
export declare const oasParameterLocation: v.GenericSchema<OasParameterLocation>;
|
|
4
|
-
|
|
8
|
+
/**
|
|
9
|
+
* Parameter styles across OpenAPI 3.0 to 3.2. `cookie` is new in 3.2; each
|
|
10
|
+
* parser tree accepts its own subset.
|
|
11
|
+
*/
|
|
12
|
+
export type OasParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject' | 'cookie';
|
|
5
13
|
export declare const oasParameterStyle: v.GenericSchema<OasParameterStyle>;
|
|
@@ -37,6 +37,7 @@ exports.oasParameterStyle = exports.oasParameterLocation = void 0;
|
|
|
37
37
|
const v = __importStar(require("valibot"));
|
|
38
38
|
exports.oasParameterLocation = v.enum({
|
|
39
39
|
query: 'query',
|
|
40
|
+
querystring: 'querystring',
|
|
40
41
|
header: 'header',
|
|
41
42
|
path: 'path',
|
|
42
43
|
cookie: 'cookie'
|
|
@@ -48,5 +49,6 @@ exports.oasParameterStyle = v.enum({
|
|
|
48
49
|
simple: 'simple',
|
|
49
50
|
spaceDelimited: 'spaceDelimited',
|
|
50
51
|
pipeDelimited: 'pipeDelimited',
|
|
51
|
-
deepObject: 'deepObject'
|
|
52
|
+
deepObject: 'deepObject',
|
|
53
|
+
cookie: 'cookie'
|
|
52
54
|
});
|
|
@@ -12,6 +12,8 @@ import type { ParseContextType } from '../../context/parseTypes.js';
|
|
|
12
12
|
* Constructor fields for {@link OasResponse}.
|
|
13
13
|
*/
|
|
14
14
|
export type ResponseFields = {
|
|
15
|
+
/** A short summary of the response (OpenAPI 3.2) */
|
|
16
|
+
summary?: string | undefined;
|
|
15
17
|
/** A description of the response */
|
|
16
18
|
description?: string | undefined;
|
|
17
19
|
/** Response headers that can be sent */
|
|
@@ -208,6 +210,7 @@ export type ResponseFields = {
|
|
|
208
210
|
*/
|
|
209
211
|
export declare class OasResponse extends OasBase {
|
|
210
212
|
oasType: 'response';
|
|
213
|
+
summary: string | undefined;
|
|
211
214
|
description: string | undefined;
|
|
212
215
|
headers: Record<string, OasHeader | OasRef<'header'>> | undefined;
|
|
213
216
|
links: Record<string, OasLink | OasRef<'link'>> | undefined;
|
|
@@ -218,5 +221,7 @@ export declare class OasResponse extends OasBase {
|
|
|
218
221
|
resolve(): OasResponse;
|
|
219
222
|
resolveOnce(): OasResponse;
|
|
220
223
|
toSchema(mediaType?: string): OasSchema | OasRef<'schema'> | undefined;
|
|
221
|
-
toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.ResponseObject
|
|
224
|
+
toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.ResponseObject & {
|
|
225
|
+
summary?: string;
|
|
226
|
+
};
|
|
222
227
|
}
|
|
@@ -195,6 +195,12 @@ class OasResponse extends OasBase_js_1.OasBase {
|
|
|
195
195
|
writable: true,
|
|
196
196
|
value: 'response'
|
|
197
197
|
});
|
|
198
|
+
Object.defineProperty(this, "summary", {
|
|
199
|
+
enumerable: true,
|
|
200
|
+
configurable: true,
|
|
201
|
+
writable: true,
|
|
202
|
+
value: void 0
|
|
203
|
+
});
|
|
198
204
|
Object.defineProperty(this, "description", {
|
|
199
205
|
enumerable: true,
|
|
200
206
|
configurable: true,
|
|
@@ -225,6 +231,7 @@ class OasResponse extends OasBase_js_1.OasBase {
|
|
|
225
231
|
writable: true,
|
|
226
232
|
value: void 0
|
|
227
233
|
});
|
|
234
|
+
this.summary = fields.summary;
|
|
228
235
|
this.description = fields.description;
|
|
229
236
|
this.headers = fields.headers;
|
|
230
237
|
this.links = fields.links;
|
|
@@ -245,6 +252,7 @@ class OasResponse extends OasBase_js_1.OasBase {
|
|
|
245
252
|
}
|
|
246
253
|
toJsonSchema(options) {
|
|
247
254
|
return {
|
|
255
|
+
...(this.summary !== undefined ? { summary: this.summary } : {}),
|
|
248
256
|
description: this.description ?? '',
|
|
249
257
|
headers: this.headers
|
|
250
258
|
? Object.fromEntries(Object.entries(this.headers).map(([header, headerObject]) => [
|
|
@@ -3,16 +3,20 @@ import type { OpenAPIV3 } from 'openapi-types';
|
|
|
3
3
|
export type SecuritySchemeFields = HttpSecuritySchemeFields | ApiKeySecuritySchemeFields | OAuth2SecuritySchemeFields | OpenIdSecuritySchemeFields;
|
|
4
4
|
export type HttpSecuritySchemeFields = {
|
|
5
5
|
description?: string;
|
|
6
|
+
deprecated?: boolean;
|
|
6
7
|
scheme: string;
|
|
7
8
|
bearerFormat?: string;
|
|
8
9
|
};
|
|
9
10
|
export type ApiKeySecuritySchemeFields = {
|
|
10
11
|
description?: string;
|
|
12
|
+
deprecated?: boolean;
|
|
11
13
|
name: string;
|
|
12
14
|
in: 'header' | 'query' | 'cookie';
|
|
13
15
|
};
|
|
14
16
|
export type OAuth2SecuritySchemeFields = {
|
|
15
17
|
description?: string;
|
|
18
|
+
deprecated?: boolean;
|
|
19
|
+
oauth2MetadataUrl?: string;
|
|
16
20
|
flows: {
|
|
17
21
|
authorizationCode?: {
|
|
18
22
|
authorizationUrl: string;
|
|
@@ -35,40 +39,72 @@ export type OAuth2SecuritySchemeFields = {
|
|
|
35
39
|
refreshUrl?: string | undefined;
|
|
36
40
|
scopes: Record<string, string>;
|
|
37
41
|
};
|
|
42
|
+
deviceAuthorization?: {
|
|
43
|
+
deviceAuthorizationUrl: string;
|
|
44
|
+
tokenUrl: string;
|
|
45
|
+
refreshUrl?: string | undefined;
|
|
46
|
+
scopes?: Record<string, string> | undefined;
|
|
47
|
+
};
|
|
38
48
|
};
|
|
39
49
|
};
|
|
40
50
|
export type OpenIdSecuritySchemeFields = {
|
|
41
51
|
description?: string;
|
|
52
|
+
deprecated?: boolean;
|
|
42
53
|
openIdConnectUrl: string;
|
|
43
54
|
};
|
|
55
|
+
/** `OpenAPIV3.HttpSecurityScheme` with the OpenAPI 3.2 `deprecated` field. */
|
|
56
|
+
export type HttpSecuritySchemeJson = OpenAPIV3.HttpSecurityScheme & {
|
|
57
|
+
deprecated?: boolean;
|
|
58
|
+
};
|
|
59
|
+
/** `OpenAPIV3.ApiKeySecurityScheme` with the OpenAPI 3.2 `deprecated` field. */
|
|
60
|
+
export type ApiKeySecuritySchemeJson = OpenAPIV3.ApiKeySecurityScheme & {
|
|
61
|
+
deprecated?: boolean;
|
|
62
|
+
};
|
|
63
|
+
/** `OpenAPIV3.OpenIdSecurityScheme` with the OpenAPI 3.2 `deprecated` field. */
|
|
64
|
+
export type OpenIdSecuritySchemeJson = OpenAPIV3.OpenIdSecurityScheme & {
|
|
65
|
+
deprecated?: boolean;
|
|
66
|
+
};
|
|
44
67
|
export declare class OasHttpSecurityScheme {
|
|
45
68
|
oasType: 'securityScheme';
|
|
46
69
|
type: 'http';
|
|
47
70
|
description: string | undefined;
|
|
71
|
+
deprecated: boolean | undefined;
|
|
48
72
|
scheme: string;
|
|
49
73
|
bearerFormat: string | undefined;
|
|
50
74
|
constructor(fields: HttpSecuritySchemeFields);
|
|
51
75
|
isRef(): this is OasRef<'securityScheme'>;
|
|
52
76
|
resolve(): OasHttpSecurityScheme;
|
|
53
77
|
resolveOnce(): OasHttpSecurityScheme;
|
|
54
|
-
toJsonSchema():
|
|
78
|
+
toJsonSchema(): HttpSecuritySchemeJson;
|
|
55
79
|
}
|
|
56
80
|
export declare class OasApiKeySecurityScheme {
|
|
57
81
|
oasType: 'securityScheme';
|
|
58
82
|
type: 'apiKey';
|
|
59
83
|
description: string | undefined;
|
|
84
|
+
deprecated: boolean | undefined;
|
|
60
85
|
name: string;
|
|
61
86
|
location: 'query' | 'header' | 'cookie';
|
|
62
87
|
constructor(fields: ApiKeySecuritySchemeFields);
|
|
63
88
|
isRef(): this is OasRef<'securityScheme'>;
|
|
64
89
|
resolve(): OasApiKeySecurityScheme;
|
|
65
90
|
resolveOnce(): OasApiKeySecurityScheme;
|
|
66
|
-
toJsonSchema():
|
|
91
|
+
toJsonSchema(): ApiKeySecuritySchemeJson;
|
|
67
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* `OpenAPIV3.OAuth2SecurityScheme` with the OpenAPI 3.2 fields:
|
|
95
|
+
* `deprecated`, `oauth2MetadataUrl` and the `deviceAuthorization` flow.
|
|
96
|
+
*/
|
|
97
|
+
export type OAuth2SecuritySchemeJson = OpenAPIV3.OAuth2SecurityScheme & {
|
|
98
|
+
deprecated?: boolean;
|
|
99
|
+
oauth2MetadataUrl?: string;
|
|
100
|
+
flows: OAuth2SecuritySchemeFields['flows'];
|
|
101
|
+
};
|
|
68
102
|
export declare class OasOAuth2SecurityScheme {
|
|
69
103
|
oasType: 'securityScheme';
|
|
70
104
|
type: 'oauth2';
|
|
71
105
|
description: string | undefined;
|
|
106
|
+
deprecated: boolean | undefined;
|
|
107
|
+
oauth2MetadataUrl: string | undefined;
|
|
72
108
|
flows: {
|
|
73
109
|
authorizationCode?: {
|
|
74
110
|
authorizationUrl: string;
|
|
@@ -91,22 +127,29 @@ export declare class OasOAuth2SecurityScheme {
|
|
|
91
127
|
refreshUrl?: string | undefined;
|
|
92
128
|
scopes: Record<string, string>;
|
|
93
129
|
};
|
|
130
|
+
deviceAuthorization?: {
|
|
131
|
+
deviceAuthorizationUrl: string;
|
|
132
|
+
tokenUrl: string;
|
|
133
|
+
refreshUrl?: string | undefined;
|
|
134
|
+
scopes?: Record<string, string> | undefined;
|
|
135
|
+
};
|
|
94
136
|
};
|
|
95
137
|
constructor(fields: OAuth2SecuritySchemeFields);
|
|
96
138
|
isRef(): this is OasRef<'securityScheme'>;
|
|
97
139
|
resolve(): OasOAuth2SecurityScheme;
|
|
98
140
|
resolveOnce(): OasOAuth2SecurityScheme;
|
|
99
|
-
toJsonSchema():
|
|
141
|
+
toJsonSchema(): OAuth2SecuritySchemeJson;
|
|
100
142
|
}
|
|
101
143
|
export declare class OasOpenIdSecurityScheme {
|
|
102
144
|
oasType: 'securityScheme';
|
|
103
145
|
type: 'openIdConnect';
|
|
104
146
|
description: string | undefined;
|
|
147
|
+
deprecated: boolean | undefined;
|
|
105
148
|
openIdConnectUrl: string;
|
|
106
149
|
constructor(fields: OpenIdSecuritySchemeFields);
|
|
107
150
|
isRef(): this is OasRef<'securityScheme'>;
|
|
108
151
|
resolve(): OasOpenIdSecurityScheme;
|
|
109
152
|
resolveOnce(): OasOpenIdSecurityScheme;
|
|
110
|
-
toJsonSchema():
|
|
153
|
+
toJsonSchema(): OpenIdSecuritySchemeJson;
|
|
111
154
|
}
|
|
112
155
|
export type OasSecurityScheme = OasHttpSecurityScheme | OasApiKeySecurityScheme | OasOAuth2SecurityScheme | OasOpenIdSecurityScheme;
|
|
@@ -21,6 +21,12 @@ class OasHttpSecurityScheme {
|
|
|
21
21
|
writable: true,
|
|
22
22
|
value: void 0
|
|
23
23
|
});
|
|
24
|
+
Object.defineProperty(this, "deprecated", {
|
|
25
|
+
enumerable: true,
|
|
26
|
+
configurable: true,
|
|
27
|
+
writable: true,
|
|
28
|
+
value: void 0
|
|
29
|
+
});
|
|
24
30
|
Object.defineProperty(this, "scheme", {
|
|
25
31
|
enumerable: true,
|
|
26
32
|
configurable: true,
|
|
@@ -34,6 +40,7 @@ class OasHttpSecurityScheme {
|
|
|
34
40
|
value: void 0
|
|
35
41
|
});
|
|
36
42
|
this.description = fields.description;
|
|
43
|
+
this.deprecated = fields.deprecated;
|
|
37
44
|
this.scheme = fields.scheme;
|
|
38
45
|
this.bearerFormat = fields.bearerFormat;
|
|
39
46
|
}
|
|
@@ -50,6 +57,7 @@ class OasHttpSecurityScheme {
|
|
|
50
57
|
return {
|
|
51
58
|
type: 'http',
|
|
52
59
|
description: this.description,
|
|
60
|
+
...(this.deprecated === undefined ? {} : { deprecated: this.deprecated }),
|
|
53
61
|
scheme: this.scheme,
|
|
54
62
|
bearerFormat: this.bearerFormat
|
|
55
63
|
};
|
|
@@ -76,6 +84,12 @@ class OasApiKeySecurityScheme {
|
|
|
76
84
|
writable: true,
|
|
77
85
|
value: void 0
|
|
78
86
|
});
|
|
87
|
+
Object.defineProperty(this, "deprecated", {
|
|
88
|
+
enumerable: true,
|
|
89
|
+
configurable: true,
|
|
90
|
+
writable: true,
|
|
91
|
+
value: void 0
|
|
92
|
+
});
|
|
79
93
|
Object.defineProperty(this, "name", {
|
|
80
94
|
enumerable: true,
|
|
81
95
|
configurable: true,
|
|
@@ -89,6 +103,7 @@ class OasApiKeySecurityScheme {
|
|
|
89
103
|
value: void 0
|
|
90
104
|
});
|
|
91
105
|
this.description = fields.description;
|
|
106
|
+
this.deprecated = fields.deprecated;
|
|
92
107
|
this.name = fields.name;
|
|
93
108
|
this.location = fields.in;
|
|
94
109
|
}
|
|
@@ -104,6 +119,7 @@ class OasApiKeySecurityScheme {
|
|
|
104
119
|
toJsonSchema() {
|
|
105
120
|
return {
|
|
106
121
|
type: 'apiKey',
|
|
122
|
+
...(this.deprecated === undefined ? {} : { deprecated: this.deprecated }),
|
|
107
123
|
name: this.name,
|
|
108
124
|
in: this.location
|
|
109
125
|
};
|
|
@@ -130,6 +146,18 @@ class OasOAuth2SecurityScheme {
|
|
|
130
146
|
writable: true,
|
|
131
147
|
value: void 0
|
|
132
148
|
});
|
|
149
|
+
Object.defineProperty(this, "deprecated", {
|
|
150
|
+
enumerable: true,
|
|
151
|
+
configurable: true,
|
|
152
|
+
writable: true,
|
|
153
|
+
value: void 0
|
|
154
|
+
});
|
|
155
|
+
Object.defineProperty(this, "oauth2MetadataUrl", {
|
|
156
|
+
enumerable: true,
|
|
157
|
+
configurable: true,
|
|
158
|
+
writable: true,
|
|
159
|
+
value: void 0
|
|
160
|
+
});
|
|
133
161
|
Object.defineProperty(this, "flows", {
|
|
134
162
|
enumerable: true,
|
|
135
163
|
configurable: true,
|
|
@@ -137,6 +165,8 @@ class OasOAuth2SecurityScheme {
|
|
|
137
165
|
value: void 0
|
|
138
166
|
});
|
|
139
167
|
this.description = fields.description;
|
|
168
|
+
this.deprecated = fields.deprecated;
|
|
169
|
+
this.oauth2MetadataUrl = fields.oauth2MetadataUrl;
|
|
140
170
|
this.flows = fields.flows;
|
|
141
171
|
}
|
|
142
172
|
isRef() {
|
|
@@ -152,11 +182,18 @@ class OasOAuth2SecurityScheme {
|
|
|
152
182
|
return {
|
|
153
183
|
type: 'oauth2',
|
|
154
184
|
description: this.description,
|
|
185
|
+
...(this.deprecated === undefined ? {} : { deprecated: this.deprecated }),
|
|
186
|
+
...(this.oauth2MetadataUrl === undefined
|
|
187
|
+
? {}
|
|
188
|
+
: { oauth2MetadataUrl: this.oauth2MetadataUrl }),
|
|
155
189
|
flows: {
|
|
156
190
|
authorizationCode: this.flows.authorizationCode,
|
|
157
191
|
clientCredentials: this.flows.clientCredentials,
|
|
158
192
|
implicit: this.flows.implicit,
|
|
159
|
-
password: this.flows.password
|
|
193
|
+
password: this.flows.password,
|
|
194
|
+
...(this.flows.deviceAuthorization === undefined
|
|
195
|
+
? {}
|
|
196
|
+
: { deviceAuthorization: this.flows.deviceAuthorization })
|
|
160
197
|
}
|
|
161
198
|
};
|
|
162
199
|
}
|
|
@@ -182,6 +219,12 @@ class OasOpenIdSecurityScheme {
|
|
|
182
219
|
writable: true,
|
|
183
220
|
value: void 0
|
|
184
221
|
});
|
|
222
|
+
Object.defineProperty(this, "deprecated", {
|
|
223
|
+
enumerable: true,
|
|
224
|
+
configurable: true,
|
|
225
|
+
writable: true,
|
|
226
|
+
value: void 0
|
|
227
|
+
});
|
|
185
228
|
Object.defineProperty(this, "openIdConnectUrl", {
|
|
186
229
|
enumerable: true,
|
|
187
230
|
configurable: true,
|
|
@@ -189,6 +232,7 @@ class OasOpenIdSecurityScheme {
|
|
|
189
232
|
value: void 0
|
|
190
233
|
});
|
|
191
234
|
this.description = fields.description;
|
|
235
|
+
this.deprecated = fields.deprecated;
|
|
192
236
|
this.openIdConnectUrl = fields.openIdConnectUrl;
|
|
193
237
|
}
|
|
194
238
|
isRef() {
|
|
@@ -204,6 +248,7 @@ class OasOpenIdSecurityScheme {
|
|
|
204
248
|
return {
|
|
205
249
|
type: 'openIdConnect',
|
|
206
250
|
description: this.description,
|
|
251
|
+
...(this.deprecated === undefined ? {} : { deprecated: this.deprecated }),
|
|
207
252
|
openIdConnectUrl: this.openIdConnectUrl
|
|
208
253
|
};
|
|
209
254
|
}
|