@redocly/openapi-core 1.0.0-beta.99 → 1.0.0-rc.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/README.md +6 -6
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +0 -1
- package/lib/benchmark/benches/recommended-oas3.bench.js +1 -1
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +1 -1
- package/lib/benchmark/utils.d.ts +2 -2
- package/lib/benchmark/utils.js +2 -2
- package/lib/bundle.d.ts +10 -15
- package/lib/bundle.js +32 -12
- package/lib/config/all.d.ts +2 -2
- package/lib/config/all.js +16 -6
- package/lib/config/builtIn.d.ts +2 -2
- package/lib/config/builtIn.js +2 -2
- package/lib/config/config-resolvers.d.ts +5 -5
- package/lib/config/config-resolvers.js +121 -66
- package/lib/config/config.d.ts +12 -18
- package/lib/config/config.js +42 -26
- package/lib/config/load.d.ts +16 -3
- package/lib/config/load.js +36 -14
- package/lib/config/minimal.d.ts +2 -2
- package/lib/config/minimal.js +10 -6
- package/lib/config/recommended.d.ts +2 -2
- package/lib/config/recommended.js +10 -6
- package/lib/config/rules.d.ts +7 -4
- package/lib/config/rules.js +5 -4
- package/lib/config/types.d.ts +72 -23
- package/lib/config/types.js +13 -0
- package/lib/config/utils.d.ts +6 -5
- package/lib/config/utils.js +110 -32
- package/lib/decorators/common/filters/filter-helper.d.ts +3 -0
- package/lib/decorators/common/filters/filter-helper.js +67 -0
- package/lib/decorators/common/filters/filter-in.d.ts +2 -0
- package/lib/decorators/common/filters/filter-in.js +17 -0
- package/lib/decorators/common/filters/filter-out.d.ts +2 -0
- package/lib/decorators/common/filters/filter-out.js +17 -0
- package/lib/decorators/common/info-override.d.ts +2 -0
- package/lib/decorators/common/info-override.js +28 -0
- package/lib/decorators/common/media-type-examples-override.d.ts +2 -0
- package/lib/decorators/common/media-type-examples-override.js +53 -0
- package/lib/decorators/common/registry-dependencies.js +2 -2
- package/lib/decorators/common/remove-x-internal.js +2 -2
- package/lib/decorators/oas2/index.d.ts +3 -0
- package/lib/decorators/oas2/index.js +7 -1
- package/lib/decorators/oas3/index.d.ts +4 -0
- package/lib/decorators/oas3/index.js +9 -1
- package/lib/env.d.ts +3 -0
- package/lib/env.js +8 -0
- package/lib/format/codeframes.js +16 -10
- package/lib/format/format.d.ts +1 -1
- package/lib/format/format.js +64 -32
- package/lib/index.d.ts +6 -6
- package/lib/index.js +7 -2
- package/lib/js-yaml/index.js +2 -6
- package/lib/lint.d.ts +4 -2
- package/lib/lint.js +36 -11
- package/lib/logger.d.ts +10 -0
- package/lib/logger.js +31 -0
- package/lib/output.d.ts +3 -0
- package/lib/output.js +9 -0
- package/lib/redocly/index.js +10 -9
- package/lib/redocly/registry-api-types.d.ts +28 -28
- package/lib/redocly/registry-api.d.ts +3 -3
- package/lib/redocly/registry-api.js +10 -2
- package/lib/ref-utils.d.ts +1 -0
- package/lib/ref-utils.js +7 -2
- package/lib/resolve.d.ts +1 -1
- package/lib/resolve.js +33 -3
- package/lib/rules/ajv.d.ts +2 -2
- package/lib/rules/ajv.js +12 -12
- package/lib/rules/common/assertions/asserts.d.ts +29 -4
- package/lib/rules/common/assertions/asserts.js +227 -97
- package/lib/rules/common/assertions/index.d.ts +27 -2
- package/lib/rules/common/assertions/index.js +9 -37
- package/lib/rules/common/assertions/utils.d.ts +16 -8
- package/lib/rules/common/assertions/utils.js +160 -76
- package/lib/rules/common/info-license-url.d.ts +1 -1
- package/lib/rules/common/info-license-url.js +5 -10
- package/lib/rules/common/info-license.d.ts +2 -0
- package/lib/rules/common/info-license.js +17 -0
- package/lib/rules/common/no-ambiguous-paths.js +1 -1
- package/lib/rules/common/no-enum-type-mismatch.js +1 -3
- package/lib/rules/common/no-identical-paths.js +4 -4
- package/lib/rules/common/no-invalid-parameter-examples.js +3 -3
- package/lib/rules/common/no-invalid-schema-examples.js +3 -3
- package/lib/rules/common/operation-2xx-response.js +15 -9
- package/lib/rules/common/operation-4xx-response.js +15 -9
- package/lib/rules/common/operation-operationId.js +2 -2
- package/lib/rules/common/operation-tag-defined.js +1 -1
- package/lib/rules/common/path-not-include-query.js +2 -2
- package/lib/rules/common/path-params-defined.js +7 -2
- package/lib/rules/common/paths-kebab-case.js +4 -1
- package/lib/rules/common/required-string-property-missing-min-length.d.ts +2 -0
- package/lib/rules/common/required-string-property-missing-min-length.js +37 -0
- package/lib/rules/common/response-contains-header.js +2 -2
- package/lib/rules/common/scalar-property-missing-example.js +2 -1
- package/lib/rules/common/security-defined.d.ts +2 -0
- package/lib/rules/common/{operation-security-defined.js → security-defined.js} +25 -6
- package/lib/rules/common/spec-strict-refs.d.ts +2 -0
- package/lib/rules/common/spec-strict-refs.js +30 -0
- package/lib/rules/common/spec.js +41 -18
- package/lib/rules/common/tags-alphabetical.js +1 -1
- package/lib/rules/oas2/index.d.ts +3 -2
- package/lib/rules/oas2/index.js +10 -8
- package/lib/rules/oas2/remove-unused-components.js +6 -6
- package/lib/rules/oas2/request-mime-type.d.ts +1 -1
- package/lib/rules/oas2/request-mime-type.js +1 -1
- package/lib/rules/oas2/response-mime-type.d.ts +1 -1
- package/lib/rules/oas2/response-mime-type.js +1 -1
- package/lib/rules/oas3/component-name-unique.d.ts +2 -0
- package/lib/rules/oas3/component-name-unique.js +124 -0
- package/lib/rules/oas3/index.js +18 -10
- package/lib/rules/oas3/no-empty-servers.js +2 -2
- package/lib/rules/oas3/no-invalid-media-type-examples.js +2 -2
- package/lib/rules/oas3/no-server-variables-empty-enum.d.ts +2 -0
- package/lib/rules/oas3/{no-servers-empty-enum.js → no-server-variables-empty-enum.js} +5 -5
- package/lib/rules/oas3/no-unused-components.js +2 -2
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts +5 -0
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js +36 -0
- package/lib/rules/oas3/remove-unused-components.js +6 -6
- package/lib/rules/oas3/request-mime-type.d.ts +1 -1
- package/lib/rules/oas3/request-mime-type.js +1 -1
- package/lib/rules/oas3/response-mime-type.d.ts +1 -1
- package/lib/rules/oas3/response-mime-type.js +1 -1
- package/lib/rules/oas3/spec-components-invalid-map-name.d.ts +2 -0
- package/lib/rules/oas3/spec-components-invalid-map-name.js +62 -0
- package/lib/rules/other/stats.d.ts +2 -2
- package/lib/rules/other/stats.js +45 -16
- package/lib/rules/utils.d.ts +5 -2
- package/lib/rules/utils.js +54 -6
- package/lib/types/config-external-schemas.d.ts +2193 -0
- package/lib/types/config-external-schemas.js +805 -0
- package/lib/types/index.d.ts +3 -2
- package/lib/types/index.js +9 -1
- package/lib/types/oas2.js +91 -15
- package/lib/types/oas3.js +125 -46
- package/lib/types/oas3_1.js +23 -19
- package/lib/types/redocly-yaml.js +406 -60
- package/lib/utils.d.ts +15 -4
- package/lib/utils.js +72 -8
- package/lib/visitors.d.ts +20 -16
- package/lib/visitors.js +28 -3
- package/lib/walk.d.ts +11 -19
- package/lib/walk.js +74 -53
- package/package.json +5 -6
- package/__tests__/utils.ts +0 -86
- package/lib/rules/common/info-description.d.ts +0 -2
- package/lib/rules/common/info-description.js +0 -12
- package/lib/rules/common/license-url.d.ts +0 -2
- package/lib/rules/common/license-url.js +0 -12
- package/lib/rules/common/operation-security-defined.d.ts +0 -2
- package/lib/rules/oas3/no-servers-empty-enum.d.ts +0 -2
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +0 -255
- package/src/__tests__/bundle.test.ts +0 -156
- package/src/__tests__/codeframes.test.ts +0 -531
- package/src/__tests__/fixtures/extension.js +0 -24
- package/src/__tests__/fixtures/refs/definitions.yaml +0 -3
- package/src/__tests__/fixtures/refs/examples.yaml +0 -8
- package/src/__tests__/fixtures/refs/external-request-body.yaml +0 -13
- package/src/__tests__/fixtures/refs/externalref.yaml +0 -35
- package/src/__tests__/fixtures/refs/hosted.yaml +0 -35
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +0 -21
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +0 -33
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +0 -18
- package/src/__tests__/fixtures/refs/param-b.yaml +0 -1
- package/src/__tests__/fixtures/refs/param-c.yaml +0 -1
- package/src/__tests__/fixtures/refs/rename.yaml +0 -1
- package/src/__tests__/fixtures/refs/requestBody.yaml +0 -9
- package/src/__tests__/fixtures/refs/schema-a.yaml +0 -1
- package/src/__tests__/fixtures/refs/simple.yaml +0 -1
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +0 -20
- package/src/__tests__/fixtures/resolve/External.yaml +0 -10
- package/src/__tests__/fixtures/resolve/External2.yaml +0 -4
- package/src/__tests__/fixtures/resolve/description.md +0 -3
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +0 -4
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +0 -1
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +0 -13
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +0 -5
- package/src/__tests__/fixtures/resolve/openapi.yaml +0 -28
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +0 -10
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +0 -6
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +0 -1
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +0 -5
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +0 -3
- package/src/__tests__/js-yaml.test.ts +0 -71
- package/src/__tests__/lint.test.ts +0 -195
- package/src/__tests__/login.test.ts +0 -17
- package/src/__tests__/normalizeVisitors.test.ts +0 -151
- package/src/__tests__/ref-utils.test.ts +0 -120
- package/src/__tests__/resolve-http.test.ts +0 -77
- package/src/__tests__/resolve.test.ts +0 -405
- package/src/__tests__/utils.test.ts +0 -85
- package/src/__tests__/walk.test.ts +0 -1485
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +0 -35
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +0 -39
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +0 -20
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +0 -36
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +0 -32
- package/src/benchmark/benches/rebilly.yaml +0 -32267
- package/src/benchmark/benches/recommended-oas3.bench.ts +0 -22
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +0 -23
- package/src/benchmark/benchmark.js +0 -307
- package/src/benchmark/colors.js +0 -29
- package/src/benchmark/fork.js +0 -83
- package/src/benchmark/utils.ts +0 -36
- package/src/bundle.ts +0 -386
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +0 -157
- package/src/config/__tests__/config-resolvers.test.ts +0 -429
- package/src/config/__tests__/config.test.ts +0 -244
- package/src/config/__tests__/fixtures/plugin-config.yaml +0 -3
- package/src/config/__tests__/fixtures/plugin.js +0 -56
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +0 -12
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +0 -67
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +0 -8
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +0 -19
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +0 -10
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +0 -66
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +0 -4
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +0 -5
- package/src/config/__tests__/load.test.ts +0 -83
- package/src/config/__tests__/resolve-plugins.test.ts +0 -27
- package/src/config/all.ts +0 -66
- package/src/config/builtIn.ts +0 -37
- package/src/config/config-resolvers.ts +0 -359
- package/src/config/config.ts +0 -312
- package/src/config/index.ts +0 -7
- package/src/config/load.ts +0 -84
- package/src/config/minimal.ts +0 -58
- package/src/config/recommended.ts +0 -58
- package/src/config/rules.ts +0 -46
- package/src/config/types.ts +0 -168
- package/src/config/utils.ts +0 -208
- package/src/decorators/__tests__/remove-x-internal.test.ts +0 -316
- package/src/decorators/common/info-description-override.ts +0 -24
- package/src/decorators/common/operation-description-override.ts +0 -30
- package/src/decorators/common/registry-dependencies.ts +0 -25
- package/src/decorators/common/remove-x-internal.ts +0 -59
- package/src/decorators/common/tag-description-override.ts +0 -25
- package/src/decorators/oas2/index.ts +0 -14
- package/src/decorators/oas3/index.ts +0 -14
- package/src/format/codeframes.ts +0 -210
- package/src/format/format.ts +0 -339
- package/src/index.ts +0 -68
- package/src/js-yaml/index.ts +0 -18
- package/src/lint.ts +0 -125
- package/src/oas-types.ts +0 -62
- package/src/redocly/__tests__/redocly-client.test.ts +0 -140
- package/src/redocly/index.ts +0 -182
- package/src/redocly/redocly-client-types.ts +0 -10
- package/src/redocly/registry-api-types.ts +0 -32
- package/src/redocly/registry-api.ts +0 -134
- package/src/ref-utils.ts +0 -80
- package/src/resolve.ts +0 -378
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +0 -1
- package/src/rules/__tests__/fixtures/ref.yaml +0 -1
- package/src/rules/__tests__/no-unresolved-refs.test.ts +0 -168
- package/src/rules/ajv.ts +0 -103
- package/src/rules/common/__tests__/info-description.test.ts +0 -102
- package/src/rules/common/__tests__/info-license.test.ts +0 -62
- package/src/rules/common/__tests__/license-url.test.ts +0 -63
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +0 -96
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +0 -209
- package/src/rules/common/__tests__/no-identical-paths.test.ts +0 -58
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +0 -85
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +0 -91
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +0 -107
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +0 -76
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +0 -45
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +0 -167
- package/src/rules/common/__tests__/operation-security-defined.test.ts +0 -69
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +0 -72
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +0 -95
- package/src/rules/common/__tests__/path-not-include-query.test.ts +0 -64
- package/src/rules/common/__tests__/path-params-defined.test.ts +0 -133
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +0 -108
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +0 -207
- package/src/rules/common/__tests__/spec.test.ts +0 -62
- package/src/rules/common/__tests__/tag-description.test.ts +0 -65
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +0 -64
- package/src/rules/common/assertions/__tests__/asserts.test.ts +0 -231
- package/src/rules/common/assertions/__tests__/index.test.ts +0 -65
- package/src/rules/common/assertions/__tests__/utils.test.ts +0 -89
- package/src/rules/common/assertions/asserts.ts +0 -137
- package/src/rules/common/assertions/index.ts +0 -75
- package/src/rules/common/assertions/utils.ts +0 -167
- package/src/rules/common/info-contact.ts +0 -15
- package/src/rules/common/info-description.ts +0 -10
- package/src/rules/common/info-license-url.ts +0 -15
- package/src/rules/common/license-url.ts +0 -10
- package/src/rules/common/no-ambiguous-paths.ts +0 -50
- package/src/rules/common/no-enum-type-mismatch.ts +0 -49
- package/src/rules/common/no-http-verbs-in-paths.ts +0 -36
- package/src/rules/common/no-identical-paths.ts +0 -24
- package/src/rules/common/no-invalid-parameter-examples.ts +0 -36
- package/src/rules/common/no-invalid-schema-examples.ts +0 -27
- package/src/rules/common/no-path-trailing-slash.ts +0 -15
- package/src/rules/common/operation-2xx-response.ts +0 -16
- package/src/rules/common/operation-4xx-response.ts +0 -17
- package/src/rules/common/operation-description.ts +0 -13
- package/src/rules/common/operation-operationId-unique.ts +0 -21
- package/src/rules/common/operation-operationId-url-safe.ts +0 -19
- package/src/rules/common/operation-operationId.ts +0 -17
- package/src/rules/common/operation-parameters-unique.ts +0 -48
- package/src/rules/common/operation-security-defined.ts +0 -45
- package/src/rules/common/operation-singular-tag.ts +0 -17
- package/src/rules/common/operation-summary.ts +0 -13
- package/src/rules/common/operation-tag-defined.ts +0 -26
- package/src/rules/common/parameter-description.ts +0 -22
- package/src/rules/common/path-declaration-must-exist.ts +0 -15
- package/src/rules/common/path-excludes-patterns.ts +0 -23
- package/src/rules/common/path-http-verbs-order.ts +0 -30
- package/src/rules/common/path-not-include-query.ts +0 -17
- package/src/rules/common/path-params-defined.ts +0 -58
- package/src/rules/common/path-segment-plural.ts +0 -31
- package/src/rules/common/paths-kebab-case.ts +0 -16
- package/src/rules/common/response-contains-header.ts +0 -30
- package/src/rules/common/scalar-property-missing-example.ts +0 -55
- package/src/rules/common/spec.ts +0 -143
- package/src/rules/common/tag-description.ts +0 -10
- package/src/rules/common/tags-alphabetical.ts +0 -20
- package/src/rules/no-unresolved-refs.ts +0 -51
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +0 -110
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +0 -174
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +0 -155
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +0 -1
- package/src/rules/oas2/__tests__/spec/info.test.ts +0 -355
- package/src/rules/oas2/__tests__/spec/operation.test.ts +0 -123
- package/src/rules/oas2/__tests__/spec/paths.test.ts +0 -245
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +0 -31
- package/src/rules/oas2/__tests__/spec/utils.ts +0 -32
- package/src/rules/oas2/boolean-parameter-prefixes.ts +0 -26
- package/src/rules/oas2/index.ts +0 -89
- package/src/rules/oas2/remove-unused-components.ts +0 -76
- package/src/rules/oas2/request-mime-type.ts +0 -17
- package/src/rules/oas2/response-contains-property.ts +0 -36
- package/src/rules/oas2/response-mime-type.ts +0 -17
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +0 -111
- package/src/rules/oas3/__tests__/fixtures/common.yaml +0 -11
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +0 -205
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +0 -65
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +0 -392
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +0 -60
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +0 -79
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +0 -131
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +0 -273
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +0 -403
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +0 -41
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +0 -1
- package/src/rules/oas3/__tests__/spec/info.test.ts +0 -391
- package/src/rules/oas3/__tests__/spec/operation.test.ts +0 -253
- package/src/rules/oas3/__tests__/spec/paths.test.ts +0 -284
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +0 -77
- package/src/rules/oas3/__tests__/spec/servers.test.ts +0 -499
- package/src/rules/oas3/__tests__/spec/spec.test.ts +0 -288
- package/src/rules/oas3/__tests__/spec/utils.ts +0 -32
- package/src/rules/oas3/boolean-parameter-prefixes.ts +0 -28
- package/src/rules/oas3/index.ts +0 -105
- package/src/rules/oas3/no-empty-servers.ts +0 -22
- package/src/rules/oas3/no-example-value-and-externalValue.ts +0 -14
- package/src/rules/oas3/no-invalid-media-type-examples.ts +0 -41
- package/src/rules/oas3/no-server-example.com.ts +0 -14
- package/src/rules/oas3/no-server-trailing-slash.ts +0 -15
- package/src/rules/oas3/no-servers-empty-enum.ts +0 -67
- package/src/rules/oas3/no-undefined-server-variable.ts +0 -30
- package/src/rules/oas3/no-unused-components.ts +0 -75
- package/src/rules/oas3/remove-unused-components.ts +0 -84
- package/src/rules/oas3/request-mime-type.ts +0 -31
- package/src/rules/oas3/response-contains-property.ts +0 -38
- package/src/rules/oas3/response-mime-type.ts +0 -31
- package/src/rules/other/stats.ts +0 -44
- package/src/rules/utils.ts +0 -123
- package/src/types/index.ts +0 -138
- package/src/types/oas2.ts +0 -397
- package/src/types/oas3.ts +0 -515
- package/src/types/oas3_1.ts +0 -253
- package/src/types/redocly-yaml.ts +0 -647
- package/src/typings/common.ts +0 -9
- package/src/typings/openapi.ts +0 -298
- package/src/typings/swagger.ts +0 -236
- package/src/utils.ts +0 -193
- package/src/visitors.ts +0 -448
- package/src/walk.ts +0 -416
- package/tsconfig.json +0 -8
- package/tsconfig.tsbuildinfo +0 -1
package/src/types/oas3_1.ts
DELETED
|
@@ -1,253 +0,0 @@
|
|
|
1
|
-
import { NodeType, listOf, mapOf } from '.';
|
|
2
|
-
import { Oas3Types } from './oas3';
|
|
3
|
-
|
|
4
|
-
const DefinitionRoot: NodeType = {
|
|
5
|
-
properties: {
|
|
6
|
-
openapi: null,
|
|
7
|
-
info: 'Info',
|
|
8
|
-
servers: listOf('Server'),
|
|
9
|
-
security: listOf('SecurityRequirement'),
|
|
10
|
-
tags: listOf('Tag'),
|
|
11
|
-
externalDocs: 'ExternalDocs',
|
|
12
|
-
paths: 'PathMap',
|
|
13
|
-
webhooks: 'WebhooksMap',
|
|
14
|
-
components: 'Components',
|
|
15
|
-
jsonSchemaDialect: { type: 'string' },
|
|
16
|
-
},
|
|
17
|
-
required: ['openapi', 'info'],
|
|
18
|
-
requiredOneOf: ['paths', 'components', 'webhooks'],
|
|
19
|
-
};
|
|
20
|
-
|
|
21
|
-
const License: NodeType = {
|
|
22
|
-
properties: {
|
|
23
|
-
name: { type: 'string' },
|
|
24
|
-
url: { type: 'string' },
|
|
25
|
-
identifier: { type: 'string' },
|
|
26
|
-
},
|
|
27
|
-
required: ['name'],
|
|
28
|
-
};
|
|
29
|
-
|
|
30
|
-
const Info: NodeType = {
|
|
31
|
-
properties: {
|
|
32
|
-
title: { type: 'string' },
|
|
33
|
-
version: { type: 'string' },
|
|
34
|
-
description: { type: 'string' },
|
|
35
|
-
termsOfService: { type: 'string' },
|
|
36
|
-
summary: { type: 'string' },
|
|
37
|
-
contact: 'Contact',
|
|
38
|
-
license: 'License',
|
|
39
|
-
},
|
|
40
|
-
required: ['title', 'version'],
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
const Components: NodeType = {
|
|
44
|
-
properties: {
|
|
45
|
-
parameters: 'NamedParameters',
|
|
46
|
-
schemas: 'NamedSchemas',
|
|
47
|
-
responses: 'NamedResponses',
|
|
48
|
-
examples: 'NamedExamples',
|
|
49
|
-
requestBodies: 'NamedRequestBodies',
|
|
50
|
-
headers: 'NamedHeaders',
|
|
51
|
-
securitySchemes: 'NamedSecuritySchemes',
|
|
52
|
-
links: 'NamedLinks',
|
|
53
|
-
callbacks: 'NamedCallbacks',
|
|
54
|
-
pathItems: 'NamedPathItems',
|
|
55
|
-
},
|
|
56
|
-
};
|
|
57
|
-
|
|
58
|
-
const Operation: NodeType = {
|
|
59
|
-
properties: {
|
|
60
|
-
tags: {
|
|
61
|
-
type: 'array',
|
|
62
|
-
items: { type: 'string' },
|
|
63
|
-
},
|
|
64
|
-
summary: { type: 'string' },
|
|
65
|
-
description: { type: 'string' },
|
|
66
|
-
externalDocs: 'ExternalDocs',
|
|
67
|
-
operationId: { type: 'string' },
|
|
68
|
-
parameters: listOf('Parameter'),
|
|
69
|
-
security: listOf('SecurityRequirement'),
|
|
70
|
-
servers: listOf('Server'),
|
|
71
|
-
requestBody: 'RequestBody',
|
|
72
|
-
responses: 'ResponsesMap',
|
|
73
|
-
deprecated: { type: 'boolean' },
|
|
74
|
-
callbacks: mapOf('Callback'),
|
|
75
|
-
'x-codeSamples': listOf('XCodeSample'),
|
|
76
|
-
'x-code-samples': listOf('XCodeSample'), // deprecated
|
|
77
|
-
'x-hideTryItPanel': { type: 'boolean' },
|
|
78
|
-
},
|
|
79
|
-
};
|
|
80
|
-
|
|
81
|
-
const Schema: NodeType = {
|
|
82
|
-
properties: {
|
|
83
|
-
$id: { type: 'string' },
|
|
84
|
-
id: { type: 'string' },
|
|
85
|
-
$schema: { type: 'string' },
|
|
86
|
-
definitions: 'NamedSchemas',
|
|
87
|
-
$defs: 'NamedSchemas',
|
|
88
|
-
$vocabulary: { type: 'string' },
|
|
89
|
-
externalDocs: 'ExternalDocs',
|
|
90
|
-
discriminator: 'Discriminator',
|
|
91
|
-
myArbitraryKeyword: { type: 'boolean' },
|
|
92
|
-
title: { type: 'string' },
|
|
93
|
-
multipleOf: { type: 'number', minimum: 0 },
|
|
94
|
-
maximum: { type: 'number' },
|
|
95
|
-
minimum: { type: 'number' },
|
|
96
|
-
exclusiveMaximum: { type: 'number' },
|
|
97
|
-
exclusiveMinimum: { type: 'number' },
|
|
98
|
-
maxLength: { type: 'integer', minimum: 0 },
|
|
99
|
-
minLength: { type: 'integer', minimum: 0 },
|
|
100
|
-
pattern: { type: 'string' },
|
|
101
|
-
maxItems: { type: 'integer', minimum: 0 },
|
|
102
|
-
minItems: { type: 'integer', minimum: 0 },
|
|
103
|
-
uniqueItems: { type: 'boolean' },
|
|
104
|
-
maxProperties: { type: 'integer', minimum: 0 },
|
|
105
|
-
minProperties: { type: 'integer', minimum: 0 },
|
|
106
|
-
required: { type: 'array', items: { type: 'string' } },
|
|
107
|
-
enum: { type: 'array' },
|
|
108
|
-
type: (value: any) => {
|
|
109
|
-
if (Array.isArray(value)) {
|
|
110
|
-
return {
|
|
111
|
-
type: 'array',
|
|
112
|
-
items: { enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'] },
|
|
113
|
-
};
|
|
114
|
-
} else {
|
|
115
|
-
return {
|
|
116
|
-
enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
|
|
117
|
-
};
|
|
118
|
-
}
|
|
119
|
-
},
|
|
120
|
-
allOf: listOf('Schema'),
|
|
121
|
-
anyOf: listOf('Schema'),
|
|
122
|
-
oneOf: listOf('Schema'),
|
|
123
|
-
not: 'Schema',
|
|
124
|
-
if: 'Schema',
|
|
125
|
-
then: 'Schema',
|
|
126
|
-
else: 'Schema',
|
|
127
|
-
dependentSchemas: listOf('Schema'),
|
|
128
|
-
prefixItems: listOf('Schema'),
|
|
129
|
-
contains: 'Schema',
|
|
130
|
-
minContains: { type: 'integer', minimum: 0 },
|
|
131
|
-
maxContains: { type: 'integer', minimum: 0 },
|
|
132
|
-
patternProperties: { type: 'object' },
|
|
133
|
-
propertyNames: 'Schema',
|
|
134
|
-
unevaluatedItems: 'Schema',
|
|
135
|
-
unevaluatedProperties: (value: unknown) => {
|
|
136
|
-
if (typeof value === 'boolean') {
|
|
137
|
-
return { type: 'boolean' };
|
|
138
|
-
} else {
|
|
139
|
-
return 'Schema';
|
|
140
|
-
}
|
|
141
|
-
},
|
|
142
|
-
summary: { type: 'string' },
|
|
143
|
-
properties: 'SchemaProperties',
|
|
144
|
-
items: (value: any) => {
|
|
145
|
-
if (Array.isArray(value)) {
|
|
146
|
-
return listOf('Schema');
|
|
147
|
-
} else if (typeof value === 'boolean') {
|
|
148
|
-
return { type: 'boolean' };
|
|
149
|
-
} else {
|
|
150
|
-
return 'Schema';
|
|
151
|
-
}
|
|
152
|
-
},
|
|
153
|
-
additionalProperties: (value: any) => {
|
|
154
|
-
return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
|
|
155
|
-
},
|
|
156
|
-
description: { type: 'string' },
|
|
157
|
-
format: { type: 'string' },
|
|
158
|
-
contentEncoding: { type: 'string' },
|
|
159
|
-
contentMediaType: { type: 'string' },
|
|
160
|
-
default: null,
|
|
161
|
-
readOnly: { type: 'boolean' },
|
|
162
|
-
writeOnly: { type: 'boolean' },
|
|
163
|
-
xml: 'Xml',
|
|
164
|
-
examples: { type: 'array' },
|
|
165
|
-
example: { isExample: true },
|
|
166
|
-
deprecated: { type: 'boolean' },
|
|
167
|
-
const: null,
|
|
168
|
-
$comment: { type: 'string' },
|
|
169
|
-
'x-tags': { type: 'array', items: { type: 'string' } },
|
|
170
|
-
},
|
|
171
|
-
};
|
|
172
|
-
|
|
173
|
-
const SecurityScheme: NodeType = {
|
|
174
|
-
properties: {
|
|
175
|
-
type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect', 'mutualTLS'] },
|
|
176
|
-
description: { type: 'string' },
|
|
177
|
-
name: { type: 'string' },
|
|
178
|
-
in: { type: 'string', enum: ['query', 'header', 'cookie'] },
|
|
179
|
-
scheme: { type: 'string' },
|
|
180
|
-
bearerFormat: { type: 'string' },
|
|
181
|
-
flows: 'SecuritySchemeFlows',
|
|
182
|
-
openIdConnectUrl: { type: 'string' },
|
|
183
|
-
},
|
|
184
|
-
required(value) {
|
|
185
|
-
switch (value?.type) {
|
|
186
|
-
case 'apiKey':
|
|
187
|
-
return ['type', 'name', 'in'];
|
|
188
|
-
case 'http':
|
|
189
|
-
return ['type', 'scheme'];
|
|
190
|
-
case 'oauth2':
|
|
191
|
-
return ['type', 'flows'];
|
|
192
|
-
case 'openIdConnect':
|
|
193
|
-
return ['type', 'openIdConnectUrl'];
|
|
194
|
-
default:
|
|
195
|
-
return ['type'];
|
|
196
|
-
}
|
|
197
|
-
},
|
|
198
|
-
allowed(value) {
|
|
199
|
-
switch (value?.type) {
|
|
200
|
-
case 'apiKey':
|
|
201
|
-
return ['type', 'name', 'in', 'description'];
|
|
202
|
-
case 'http':
|
|
203
|
-
return ['type', 'scheme', 'bearerFormat', 'description'];
|
|
204
|
-
case 'oauth2':
|
|
205
|
-
switch (value?.flows) {
|
|
206
|
-
case 'implicit':
|
|
207
|
-
return ['type', 'flows', 'authorizationUrl', 'refreshUrl', 'description', 'scopes'];
|
|
208
|
-
case 'password':
|
|
209
|
-
case 'clientCredentials':
|
|
210
|
-
return ['type', 'flows', 'tokenUrl', 'refreshUrl', 'description', 'scopes'];
|
|
211
|
-
case 'authorizationCode':
|
|
212
|
-
return [
|
|
213
|
-
'type',
|
|
214
|
-
'flows',
|
|
215
|
-
'authorizationUrl',
|
|
216
|
-
'refreshUrl',
|
|
217
|
-
'tokenUrl',
|
|
218
|
-
'description',
|
|
219
|
-
'scopes',
|
|
220
|
-
];
|
|
221
|
-
default:
|
|
222
|
-
return [
|
|
223
|
-
'type',
|
|
224
|
-
'flows',
|
|
225
|
-
'authorizationUrl',
|
|
226
|
-
'refreshUrl',
|
|
227
|
-
'tokenUrl',
|
|
228
|
-
'description',
|
|
229
|
-
'scopes',
|
|
230
|
-
];
|
|
231
|
-
}
|
|
232
|
-
case 'openIdConnect':
|
|
233
|
-
return ['type', 'openIdConnectUrl', 'description'];
|
|
234
|
-
case 'mutualTLS':
|
|
235
|
-
return ['type', 'description'];
|
|
236
|
-
default:
|
|
237
|
-
return ['type', 'description'];
|
|
238
|
-
}
|
|
239
|
-
},
|
|
240
|
-
extensionsPrefix: 'x-',
|
|
241
|
-
};
|
|
242
|
-
|
|
243
|
-
export const Oas3_1Types: Record<string, NodeType> = {
|
|
244
|
-
...Oas3Types,
|
|
245
|
-
Info,
|
|
246
|
-
DefinitionRoot,
|
|
247
|
-
Schema,
|
|
248
|
-
License,
|
|
249
|
-
Components,
|
|
250
|
-
NamedPathItems: mapOf('PathItem'),
|
|
251
|
-
SecurityScheme,
|
|
252
|
-
Operation,
|
|
253
|
-
};
|