@redocly/openapi-core 1.0.0-beta.100
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 +25 -0
- package/__tests__/utils.ts +86 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +34 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +40 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +21 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +34 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.d.ts +3 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +32 -0
- package/lib/benchmark/benches/recommended-oas3.bench.d.ts +3 -0
- package/lib/benchmark/benches/recommended-oas3.bench.js +21 -0
- package/lib/benchmark/benches/resolve-with-no-external.bench.d.ts +3 -0
- package/lib/benchmark/benches/resolve-with-no-external.bench.js +22 -0
- package/lib/benchmark/utils.d.ts +6 -0
- package/lib/benchmark/utils.js +31 -0
- package/lib/bundle.d.ts +47 -0
- package/lib/bundle.js +291 -0
- package/lib/config/all.d.ts +3 -0
- package/lib/config/all.js +65 -0
- package/lib/config/builtIn.d.ts +3 -0
- package/lib/config/builtIn.js +36 -0
- package/lib/config/config-resolvers.d.ts +16 -0
- package/lib/config/config-resolvers.js +242 -0
- package/lib/config/config.d.ts +64 -0
- package/lib/config/config.js +244 -0
- package/lib/config/index.d.ts +7 -0
- package/lib/config/index.js +19 -0
- package/lib/config/load.d.ts +6 -0
- package/lib/config/load.js +93 -0
- package/lib/config/minimal.d.ts +3 -0
- package/lib/config/minimal.js +58 -0
- package/lib/config/recommended.d.ts +3 -0
- package/lib/config/recommended.js +58 -0
- package/lib/config/rules.d.ts +7 -0
- package/lib/config/rules.js +34 -0
- package/lib/config/types.d.ts +113 -0
- package/lib/config/types.js +2 -0
- package/lib/config/utils.d.ts +13 -0
- package/lib/config/utils.js +160 -0
- package/lib/decorators/common/info-description-override.d.ts +2 -0
- package/lib/decorators/common/info-description-override.js +24 -0
- package/lib/decorators/common/operation-description-override.d.ts +2 -0
- package/lib/decorators/common/operation-description-override.js +29 -0
- package/lib/decorators/common/registry-dependencies.d.ts +2 -0
- package/lib/decorators/common/registry-dependencies.js +24 -0
- package/lib/decorators/common/remove-x-internal.d.ts +2 -0
- package/lib/decorators/common/remove-x-internal.js +58 -0
- package/lib/decorators/common/tag-description-override.d.ts +2 -0
- package/lib/decorators/common/tag-description-override.js +25 -0
- package/lib/decorators/oas2/index.d.ts +8 -0
- package/lib/decorators/oas2/index.js +15 -0
- package/lib/decorators/oas3/index.d.ts +8 -0
- package/lib/decorators/oas3/index.js +15 -0
- package/lib/format/codeframes.d.ts +22 -0
- package/lib/format/codeframes.js +177 -0
- package/lib/format/format.d.ts +20 -0
- package/lib/format/format.js +236 -0
- package/lib/index.d.ts +22 -0
- package/lib/index.js +69 -0
- package/lib/js-yaml/index.d.ts +3 -0
- package/lib/js-yaml/index.js +19 -0
- package/lib/lint.d.ts +23 -0
- package/lib/lint.js +99 -0
- package/lib/oas-types.d.ts +19 -0
- package/lib/oas-types.js +45 -0
- package/lib/redocly/index.d.ts +30 -0
- package/lib/redocly/index.js +153 -0
- package/lib/redocly/redocly-client-types.d.ts +8 -0
- package/lib/redocly/redocly-client-types.js +2 -0
- package/lib/redocly/registry-api-types.d.ts +29 -0
- package/lib/redocly/registry-api-types.js +2 -0
- package/lib/redocly/registry-api.d.ts +17 -0
- package/lib/redocly/registry-api.js +106 -0
- package/lib/ref-utils.d.ts +25 -0
- package/lib/ref-utils.js +75 -0
- package/lib/resolve.d.ts +66 -0
- package/lib/resolve.js +311 -0
- package/lib/rules/ajv.d.ts +10 -0
- package/lib/rules/ajv.js +80 -0
- package/lib/rules/common/assertions/asserts.d.ts +5 -0
- package/lib/rules/common/assertions/asserts.js +143 -0
- package/lib/rules/common/assertions/index.d.ts +2 -0
- package/lib/rules/common/assertions/index.js +52 -0
- package/lib/rules/common/assertions/utils.d.ts +20 -0
- package/lib/rules/common/assertions/utils.js +127 -0
- package/lib/rules/common/info-contact.d.ts +2 -0
- package/lib/rules/common/info-contact.js +17 -0
- package/lib/rules/common/info-description.d.ts +2 -0
- package/lib/rules/common/info-description.js +12 -0
- package/lib/rules/common/info-license-url.d.ts +2 -0
- package/lib/rules/common/info-license-url.js +17 -0
- package/lib/rules/common/license-url.d.ts +2 -0
- package/lib/rules/common/license-url.js +12 -0
- package/lib/rules/common/no-ambiguous-paths.d.ts +2 -0
- package/lib/rules/common/no-ambiguous-paths.js +45 -0
- package/lib/rules/common/no-enum-type-mismatch.d.ts +2 -0
- package/lib/rules/common/no-enum-type-mismatch.js +43 -0
- package/lib/rules/common/no-http-verbs-in-paths.d.ts +2 -0
- package/lib/rules/common/no-http-verbs-in-paths.js +33 -0
- package/lib/rules/common/no-identical-paths.d.ts +2 -0
- package/lib/rules/common/no-identical-paths.js +24 -0
- package/lib/rules/common/no-invalid-parameter-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-parameter-examples.js +25 -0
- package/lib/rules/common/no-invalid-schema-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-schema-examples.js +23 -0
- package/lib/rules/common/no-path-trailing-slash.d.ts +2 -0
- package/lib/rules/common/no-path-trailing-slash.js +16 -0
- package/lib/rules/common/operation-2xx-response.d.ts +2 -0
- package/lib/rules/common/operation-2xx-response.js +17 -0
- package/lib/rules/common/operation-4xx-response.d.ts +2 -0
- package/lib/rules/common/operation-4xx-response.js +17 -0
- package/lib/rules/common/operation-description.d.ts +2 -0
- package/lib/rules/common/operation-description.js +12 -0
- package/lib/rules/common/operation-operationId-unique.d.ts +2 -0
- package/lib/rules/common/operation-operationId-unique.js +20 -0
- package/lib/rules/common/operation-operationId-url-safe.d.ts +2 -0
- package/lib/rules/common/operation-operationId-url-safe.js +17 -0
- package/lib/rules/common/operation-operationId.d.ts +2 -0
- package/lib/rules/common/operation-operationId.js +16 -0
- package/lib/rules/common/operation-parameters-unique.d.ts +2 -0
- package/lib/rules/common/operation-parameters-unique.js +40 -0
- package/lib/rules/common/operation-security-defined.d.ts +2 -0
- package/lib/rules/common/operation-security-defined.js +38 -0
- package/lib/rules/common/operation-singular-tag.d.ts +2 -0
- package/lib/rules/common/operation-singular-tag.js +16 -0
- package/lib/rules/common/operation-summary.d.ts +2 -0
- package/lib/rules/common/operation-summary.js +12 -0
- package/lib/rules/common/operation-tag-defined.d.ts +2 -0
- package/lib/rules/common/operation-tag-defined.js +25 -0
- package/lib/rules/common/parameter-description.d.ts +2 -0
- package/lib/rules/common/parameter-description.js +22 -0
- package/lib/rules/common/path-declaration-must-exist.d.ts +2 -0
- package/lib/rules/common/path-declaration-must-exist.js +16 -0
- package/lib/rules/common/path-excludes-patterns.d.ts +2 -0
- package/lib/rules/common/path-excludes-patterns.js +22 -0
- package/lib/rules/common/path-http-verbs-order.d.ts +2 -0
- package/lib/rules/common/path-http-verbs-order.js +26 -0
- package/lib/rules/common/path-not-include-query.d.ts +2 -0
- package/lib/rules/common/path-not-include-query.js +18 -0
- package/lib/rules/common/path-params-defined.d.ts +2 -0
- package/lib/rules/common/path-params-defined.js +53 -0
- package/lib/rules/common/path-segment-plural.d.ts +2 -0
- package/lib/rules/common/path-segment-plural.js +32 -0
- package/lib/rules/common/paths-kebab-case.d.ts +2 -0
- package/lib/rules/common/paths-kebab-case.js +17 -0
- package/lib/rules/common/response-contains-header.d.ts +2 -0
- package/lib/rules/common/response-contains-header.js +29 -0
- package/lib/rules/common/scalar-property-missing-example.d.ts +2 -0
- package/lib/rules/common/scalar-property-missing-example.js +42 -0
- package/lib/rules/common/spec.d.ts +2 -0
- package/lib/rules/common/spec.js +136 -0
- package/lib/rules/common/tag-description.d.ts +2 -0
- package/lib/rules/common/tag-description.js +12 -0
- package/lib/rules/common/tags-alphabetical.d.ts +2 -0
- package/lib/rules/common/tags-alphabetical.js +20 -0
- package/lib/rules/no-unresolved-refs.d.ts +5 -0
- package/lib/rules/no-unresolved-refs.js +47 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.d.ts +5 -0
- package/lib/rules/oas2/boolean-parameter-prefixes.js +22 -0
- package/lib/rules/oas2/index.d.ts +46 -0
- package/lib/rules/oas2/index.js +89 -0
- package/lib/rules/oas2/remove-unused-components.d.ts +2 -0
- package/lib/rules/oas2/remove-unused-components.js +73 -0
- package/lib/rules/oas2/request-mime-type.d.ts +2 -0
- package/lib/rules/oas2/request-mime-type.js +17 -0
- package/lib/rules/oas2/response-contains-property.d.ts +2 -0
- package/lib/rules/oas2/response-contains-property.js +38 -0
- package/lib/rules/oas2/response-mime-type.d.ts +2 -0
- package/lib/rules/oas2/response-mime-type.js +17 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.d.ts +5 -0
- package/lib/rules/oas3/boolean-parameter-prefixes.js +24 -0
- package/lib/rules/oas3/index.d.ts +3 -0
- package/lib/rules/oas3/index.js +105 -0
- package/lib/rules/oas3/no-empty-servers.d.ts +2 -0
- package/lib/rules/oas3/no-empty-servers.js +23 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.d.ts +2 -0
- package/lib/rules/oas3/no-example-value-and-externalValue.js +16 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.d.ts +2 -0
- package/lib/rules/oas3/no-invalid-media-type-examples.js +37 -0
- package/lib/rules/oas3/no-server-example.com.d.ts +2 -0
- package/lib/rules/oas3/no-server-example.com.js +16 -0
- package/lib/rules/oas3/no-server-trailing-slash.d.ts +2 -0
- package/lib/rules/oas3/no-server-trailing-slash.js +18 -0
- package/lib/rules/oas3/no-servers-empty-enum.d.ts +2 -0
- package/lib/rules/oas3/no-servers-empty-enum.js +67 -0
- package/lib/rules/oas3/no-undefined-server-variable.d.ts +2 -0
- package/lib/rules/oas3/no-undefined-server-variable.js +32 -0
- package/lib/rules/oas3/no-unused-components.d.ts +2 -0
- package/lib/rules/oas3/no-unused-components.js +74 -0
- package/lib/rules/oas3/remove-unused-components.d.ts +2 -0
- package/lib/rules/oas3/remove-unused-components.js +83 -0
- package/lib/rules/oas3/request-mime-type.d.ts +2 -0
- package/lib/rules/oas3/request-mime-type.js +31 -0
- package/lib/rules/oas3/response-contains-property.d.ts +2 -0
- package/lib/rules/oas3/response-contains-property.js +40 -0
- package/lib/rules/oas3/response-mime-type.d.ts +2 -0
- package/lib/rules/oas3/response-mime-type.js +31 -0
- package/lib/rules/other/stats.d.ts +41 -0
- package/lib/rules/other/stats.js +44 -0
- package/lib/rules/utils.d.ts +17 -0
- package/lib/rules/utils.js +107 -0
- package/lib/types/index.d.ts +56 -0
- package/lib/types/index.js +77 -0
- package/lib/types/oas2.d.ts +2 -0
- package/lib/types/oas2.js +380 -0
- package/lib/types/oas3.d.ts +2 -0
- package/lib/types/oas3.js +479 -0
- package/lib/types/oas3_1.d.ts +2 -0
- package/lib/types/oas3_1.js +247 -0
- package/lib/types/redocly-yaml.d.ts +2 -0
- package/lib/types/redocly-yaml.js +533 -0
- package/lib/typings/common.d.ts +8 -0
- package/lib/typings/common.js +2 -0
- package/lib/typings/openapi.d.ts +299 -0
- package/lib/typings/openapi.js +2 -0
- package/lib/typings/swagger.d.ts +217 -0
- package/lib/typings/swagger.js +2 -0
- package/lib/utils.d.ts +41 -0
- package/lib/utils.js +177 -0
- package/lib/visitors.d.ts +175 -0
- package/lib/visitors.js +140 -0
- package/lib/walk.d.ts +87 -0
- package/lib/walk.js +253 -0
- package/package.json +56 -0
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +255 -0
- package/src/__tests__/bundle.test.ts +156 -0
- package/src/__tests__/codeframes.test.ts +531 -0
- package/src/__tests__/fixtures/extension.js +24 -0
- package/src/__tests__/fixtures/refs/definitions.yaml +3 -0
- package/src/__tests__/fixtures/refs/examples.yaml +8 -0
- package/src/__tests__/fixtures/refs/external-request-body.yaml +13 -0
- package/src/__tests__/fixtures/refs/externalref.yaml +35 -0
- package/src/__tests__/fixtures/refs/hosted.yaml +35 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +21 -0
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +33 -0
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +18 -0
- package/src/__tests__/fixtures/refs/param-b.yaml +1 -0
- package/src/__tests__/fixtures/refs/param-c.yaml +1 -0
- package/src/__tests__/fixtures/refs/rename.yaml +1 -0
- package/src/__tests__/fixtures/refs/requestBody.yaml +9 -0
- package/src/__tests__/fixtures/refs/schema-a.yaml +1 -0
- package/src/__tests__/fixtures/refs/simple.yaml +1 -0
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +20 -0
- package/src/__tests__/fixtures/resolve/External.yaml +10 -0
- package/src/__tests__/fixtures/resolve/External2.yaml +4 -0
- package/src/__tests__/fixtures/resolve/description.md +3 -0
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +4 -0
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +1 -0
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +13 -0
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +5 -0
- package/src/__tests__/fixtures/resolve/openapi.yaml +28 -0
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +10 -0
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +6 -0
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +1 -0
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +5 -0
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +3 -0
- package/src/__tests__/js-yaml.test.ts +71 -0
- package/src/__tests__/lint.test.ts +232 -0
- package/src/__tests__/login.test.ts +17 -0
- package/src/__tests__/normalizeVisitors.test.ts +151 -0
- package/src/__tests__/ref-utils.test.ts +120 -0
- package/src/__tests__/resolve-http.test.ts +77 -0
- package/src/__tests__/resolve.test.ts +405 -0
- package/src/__tests__/utils.test.ts +85 -0
- package/src/__tests__/walk.test.ts +1485 -0
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +35 -0
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +39 -0
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +20 -0
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +36 -0
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +32 -0
- package/src/benchmark/benches/rebilly.yaml +32267 -0
- package/src/benchmark/benches/recommended-oas3.bench.ts +22 -0
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +23 -0
- package/src/benchmark/benchmark.js +307 -0
- package/src/benchmark/colors.js +29 -0
- package/src/benchmark/fork.js +83 -0
- package/src/benchmark/utils.ts +36 -0
- package/src/bundle.ts +386 -0
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +157 -0
- package/src/config/__tests__/config-resolvers.test.ts +429 -0
- package/src/config/__tests__/config.test.ts +244 -0
- package/src/config/__tests__/fixtures/plugin-config.yaml +3 -0
- package/src/config/__tests__/fixtures/plugin.js +56 -0
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +12 -0
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +67 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +8 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +19 -0
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +10 -0
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +66 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +4 -0
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +5 -0
- package/src/config/__tests__/load.test.ts +83 -0
- package/src/config/__tests__/resolve-plugins.test.ts +27 -0
- package/src/config/all.ts +66 -0
- package/src/config/builtIn.ts +37 -0
- package/src/config/config-resolvers.ts +359 -0
- package/src/config/config.ts +312 -0
- package/src/config/index.ts +7 -0
- package/src/config/load.ts +84 -0
- package/src/config/minimal.ts +58 -0
- package/src/config/recommended.ts +58 -0
- package/src/config/rules.ts +46 -0
- package/src/config/types.ts +168 -0
- package/src/config/utils.ts +208 -0
- package/src/decorators/__tests__/remove-x-internal.test.ts +316 -0
- package/src/decorators/common/info-description-override.ts +24 -0
- package/src/decorators/common/operation-description-override.ts +30 -0
- package/src/decorators/common/registry-dependencies.ts +25 -0
- package/src/decorators/common/remove-x-internal.ts +59 -0
- package/src/decorators/common/tag-description-override.ts +25 -0
- package/src/decorators/oas2/index.ts +14 -0
- package/src/decorators/oas3/index.ts +14 -0
- package/src/format/codeframes.ts +210 -0
- package/src/format/format.ts +339 -0
- package/src/index.ts +68 -0
- package/src/js-yaml/index.ts +18 -0
- package/src/lint.ts +125 -0
- package/src/oas-types.ts +62 -0
- package/src/redocly/__tests__/redocly-client.test.ts +140 -0
- package/src/redocly/index.ts +182 -0
- package/src/redocly/redocly-client-types.ts +10 -0
- package/src/redocly/registry-api-types.ts +32 -0
- package/src/redocly/registry-api.ts +134 -0
- package/src/ref-utils.ts +80 -0
- package/src/resolve.ts +378 -0
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +1 -0
- package/src/rules/__tests__/fixtures/ref.yaml +1 -0
- package/src/rules/__tests__/no-unresolved-refs.test.ts +168 -0
- package/src/rules/ajv.ts +103 -0
- package/src/rules/common/__tests__/info-description.test.ts +102 -0
- package/src/rules/common/__tests__/info-license.test.ts +62 -0
- package/src/rules/common/__tests__/license-url.test.ts +63 -0
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +96 -0
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +209 -0
- package/src/rules/common/__tests__/no-identical-paths.test.ts +58 -0
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +85 -0
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +91 -0
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +107 -0
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +76 -0
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +45 -0
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +167 -0
- package/src/rules/common/__tests__/operation-security-defined.test.ts +69 -0
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +72 -0
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +95 -0
- package/src/rules/common/__tests__/path-not-include-query.test.ts +64 -0
- package/src/rules/common/__tests__/path-params-defined.test.ts +133 -0
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +108 -0
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +264 -0
- package/src/rules/common/__tests__/spec.test.ts +62 -0
- package/src/rules/common/__tests__/tag-description.test.ts +65 -0
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +64 -0
- package/src/rules/common/assertions/__tests__/asserts.test.ts +231 -0
- package/src/rules/common/assertions/__tests__/index.test.ts +65 -0
- package/src/rules/common/assertions/__tests__/utils.test.ts +89 -0
- package/src/rules/common/assertions/asserts.ts +137 -0
- package/src/rules/common/assertions/index.ts +75 -0
- package/src/rules/common/assertions/utils.ts +167 -0
- package/src/rules/common/info-contact.ts +15 -0
- package/src/rules/common/info-description.ts +10 -0
- package/src/rules/common/info-license-url.ts +15 -0
- package/src/rules/common/license-url.ts +10 -0
- package/src/rules/common/no-ambiguous-paths.ts +50 -0
- package/src/rules/common/no-enum-type-mismatch.ts +49 -0
- package/src/rules/common/no-http-verbs-in-paths.ts +36 -0
- package/src/rules/common/no-identical-paths.ts +24 -0
- package/src/rules/common/no-invalid-parameter-examples.ts +36 -0
- package/src/rules/common/no-invalid-schema-examples.ts +27 -0
- package/src/rules/common/no-path-trailing-slash.ts +15 -0
- package/src/rules/common/operation-2xx-response.ts +16 -0
- package/src/rules/common/operation-4xx-response.ts +17 -0
- package/src/rules/common/operation-description.ts +13 -0
- package/src/rules/common/operation-operationId-unique.ts +21 -0
- package/src/rules/common/operation-operationId-url-safe.ts +19 -0
- package/src/rules/common/operation-operationId.ts +17 -0
- package/src/rules/common/operation-parameters-unique.ts +48 -0
- package/src/rules/common/operation-security-defined.ts +45 -0
- package/src/rules/common/operation-singular-tag.ts +17 -0
- package/src/rules/common/operation-summary.ts +13 -0
- package/src/rules/common/operation-tag-defined.ts +26 -0
- package/src/rules/common/parameter-description.ts +22 -0
- package/src/rules/common/path-declaration-must-exist.ts +15 -0
- package/src/rules/common/path-excludes-patterns.ts +23 -0
- package/src/rules/common/path-http-verbs-order.ts +30 -0
- package/src/rules/common/path-not-include-query.ts +17 -0
- package/src/rules/common/path-params-defined.ts +58 -0
- package/src/rules/common/path-segment-plural.ts +31 -0
- package/src/rules/common/paths-kebab-case.ts +16 -0
- package/src/rules/common/response-contains-header.ts +30 -0
- package/src/rules/common/scalar-property-missing-example.ts +58 -0
- package/src/rules/common/spec.ts +143 -0
- package/src/rules/common/tag-description.ts +10 -0
- package/src/rules/common/tags-alphabetical.ts +20 -0
- package/src/rules/no-unresolved-refs.ts +51 -0
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +110 -0
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +174 -0
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +155 -0
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas2/__tests__/spec/info.test.ts +355 -0
- package/src/rules/oas2/__tests__/spec/operation.test.ts +123 -0
- package/src/rules/oas2/__tests__/spec/paths.test.ts +245 -0
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +31 -0
- package/src/rules/oas2/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas2/boolean-parameter-prefixes.ts +26 -0
- package/src/rules/oas2/index.ts +89 -0
- package/src/rules/oas2/remove-unused-components.ts +76 -0
- package/src/rules/oas2/request-mime-type.ts +17 -0
- package/src/rules/oas2/response-contains-property.ts +36 -0
- package/src/rules/oas2/response-mime-type.ts +17 -0
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +111 -0
- package/src/rules/oas3/__tests__/fixtures/common.yaml +11 -0
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +205 -0
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +65 -0
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +392 -0
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +60 -0
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +79 -0
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +131 -0
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +273 -0
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +403 -0
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +41 -0
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +1 -0
- package/src/rules/oas3/__tests__/spec/info.test.ts +391 -0
- package/src/rules/oas3/__tests__/spec/operation.test.ts +253 -0
- package/src/rules/oas3/__tests__/spec/paths.test.ts +284 -0
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +77 -0
- package/src/rules/oas3/__tests__/spec/servers.test.ts +499 -0
- package/src/rules/oas3/__tests__/spec/spec.test.ts +288 -0
- package/src/rules/oas3/__tests__/spec/utils.ts +32 -0
- package/src/rules/oas3/boolean-parameter-prefixes.ts +28 -0
- package/src/rules/oas3/index.ts +105 -0
- package/src/rules/oas3/no-empty-servers.ts +22 -0
- package/src/rules/oas3/no-example-value-and-externalValue.ts +14 -0
- package/src/rules/oas3/no-invalid-media-type-examples.ts +41 -0
- package/src/rules/oas3/no-server-example.com.ts +14 -0
- package/src/rules/oas3/no-server-trailing-slash.ts +15 -0
- package/src/rules/oas3/no-servers-empty-enum.ts +67 -0
- package/src/rules/oas3/no-undefined-server-variable.ts +30 -0
- package/src/rules/oas3/no-unused-components.ts +75 -0
- package/src/rules/oas3/remove-unused-components.ts +84 -0
- package/src/rules/oas3/request-mime-type.ts +31 -0
- package/src/rules/oas3/response-contains-property.ts +38 -0
- package/src/rules/oas3/response-mime-type.ts +31 -0
- package/src/rules/other/stats.ts +44 -0
- package/src/rules/utils.ts +123 -0
- package/src/types/index.ts +138 -0
- package/src/types/oas2.ts +397 -0
- package/src/types/oas3.ts +510 -0
- package/src/types/oas3_1.ts +253 -0
- package/src/types/redocly-yaml.ts +647 -0
- package/src/typings/common.ts +9 -0
- package/src/typings/openapi.ts +298 -0
- package/src/typings/swagger.ts +236 -0
- package/src/utils.ts +193 -0
- package/src/visitors.ts +448 -0
- package/src/walk.ts +416 -0
- package/tsconfig.json +8 -0
- package/tsconfig.tsbuildinfo +1 -0
|
@@ -0,0 +1,264 @@
|
|
|
1
|
+
import { outdent } from 'outdent';
|
|
2
|
+
import { lintDocument } from '../../../lint';
|
|
3
|
+
import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
|
|
4
|
+
import { BaseResolver } from '../../../resolve';
|
|
5
|
+
|
|
6
|
+
describe('Oas3 scalar-property-missing-example', () => {
|
|
7
|
+
it('should report on a scalar property missing example', async () => {
|
|
8
|
+
const document = parseYamlToDocument(
|
|
9
|
+
outdent`
|
|
10
|
+
openapi: 3.0.0
|
|
11
|
+
components:
|
|
12
|
+
schemas:
|
|
13
|
+
User:
|
|
14
|
+
type: object
|
|
15
|
+
properties:
|
|
16
|
+
email:
|
|
17
|
+
description: User email address
|
|
18
|
+
type: string
|
|
19
|
+
format: email
|
|
20
|
+
`,
|
|
21
|
+
'foobar.yaml',
|
|
22
|
+
);
|
|
23
|
+
|
|
24
|
+
const results = await lintDocument({
|
|
25
|
+
externalRefResolver: new BaseResolver(),
|
|
26
|
+
document,
|
|
27
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
|
|
31
|
+
Array [
|
|
32
|
+
Object {
|
|
33
|
+
"location": Array [
|
|
34
|
+
Object {
|
|
35
|
+
"pointer": "#/components/schemas/User/properties/email",
|
|
36
|
+
"reportOnKey": true,
|
|
37
|
+
"source": "foobar.yaml",
|
|
38
|
+
},
|
|
39
|
+
],
|
|
40
|
+
"message": "Scalar property should have \\"example\\" defined.",
|
|
41
|
+
"ruleId": "scalar-property-missing-example",
|
|
42
|
+
"severity": "error",
|
|
43
|
+
"suggest": Array [],
|
|
44
|
+
},
|
|
45
|
+
]
|
|
46
|
+
`);
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
describe('Oas3.1 scalar-property-missing-example', () => {
|
|
51
|
+
it('should report on a scalar property missing example', async () => {
|
|
52
|
+
const document = parseYamlToDocument(
|
|
53
|
+
outdent`
|
|
54
|
+
openapi: 3.1.0
|
|
55
|
+
components:
|
|
56
|
+
schemas:
|
|
57
|
+
User:
|
|
58
|
+
type: object
|
|
59
|
+
properties:
|
|
60
|
+
email:
|
|
61
|
+
description: User email address
|
|
62
|
+
type: string
|
|
63
|
+
format: email
|
|
64
|
+
`,
|
|
65
|
+
'foobar.yaml',
|
|
66
|
+
);
|
|
67
|
+
|
|
68
|
+
const results = await lintDocument({
|
|
69
|
+
externalRefResolver: new BaseResolver(),
|
|
70
|
+
document,
|
|
71
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
|
|
75
|
+
Array [
|
|
76
|
+
Object {
|
|
77
|
+
"location": Array [
|
|
78
|
+
Object {
|
|
79
|
+
"pointer": "#/components/schemas/User/properties/email",
|
|
80
|
+
"reportOnKey": true,
|
|
81
|
+
"source": "foobar.yaml",
|
|
82
|
+
},
|
|
83
|
+
],
|
|
84
|
+
"message": "Scalar property should have \\"example\\" or \\"examples\\" defined.",
|
|
85
|
+
"ruleId": "scalar-property-missing-example",
|
|
86
|
+
"severity": "error",
|
|
87
|
+
"suggest": Array [],
|
|
88
|
+
},
|
|
89
|
+
]
|
|
90
|
+
`);
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it('should not report on a scalar property with an example', async () => {
|
|
94
|
+
const document = parseYamlToDocument(
|
|
95
|
+
outdent`
|
|
96
|
+
openapi: 3.1.0
|
|
97
|
+
components:
|
|
98
|
+
schemas:
|
|
99
|
+
User:
|
|
100
|
+
type: object
|
|
101
|
+
properties:
|
|
102
|
+
email:
|
|
103
|
+
description: User email address
|
|
104
|
+
type: string
|
|
105
|
+
format: email
|
|
106
|
+
example: john.smith@example.com
|
|
107
|
+
`,
|
|
108
|
+
'foobar.yaml',
|
|
109
|
+
);
|
|
110
|
+
|
|
111
|
+
const results = await lintDocument({
|
|
112
|
+
externalRefResolver: new BaseResolver(),
|
|
113
|
+
document,
|
|
114
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
it('should not report on a scalar property with an examples', async () => {
|
|
121
|
+
const document = parseYamlToDocument(
|
|
122
|
+
outdent`
|
|
123
|
+
openapi: 3.1.0
|
|
124
|
+
components:
|
|
125
|
+
schemas:
|
|
126
|
+
User:
|
|
127
|
+
type: object
|
|
128
|
+
properties:
|
|
129
|
+
email:
|
|
130
|
+
description: User email address
|
|
131
|
+
type: string
|
|
132
|
+
format: email
|
|
133
|
+
examples:
|
|
134
|
+
- john.smith@example.com
|
|
135
|
+
- other@example.com
|
|
136
|
+
`,
|
|
137
|
+
'foobar.yaml',
|
|
138
|
+
);
|
|
139
|
+
|
|
140
|
+
const results = await lintDocument({
|
|
141
|
+
externalRefResolver: new BaseResolver(),
|
|
142
|
+
document,
|
|
143
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
147
|
+
});
|
|
148
|
+
|
|
149
|
+
it('should not report on a non-scalar property missing an example', async () => {
|
|
150
|
+
const document = parseYamlToDocument(
|
|
151
|
+
outdent`
|
|
152
|
+
openapi: 3.1.0
|
|
153
|
+
components:
|
|
154
|
+
schemas:
|
|
155
|
+
Pet:
|
|
156
|
+
type: object
|
|
157
|
+
required:
|
|
158
|
+
- photoUrls
|
|
159
|
+
properties:
|
|
160
|
+
photoUrls:
|
|
161
|
+
description: The list of URL to a cute photos featuring pet
|
|
162
|
+
type: array
|
|
163
|
+
maxItems: 20
|
|
164
|
+
xml:
|
|
165
|
+
name: photoUrl
|
|
166
|
+
wrapped: true
|
|
167
|
+
items:
|
|
168
|
+
type: string
|
|
169
|
+
format: url
|
|
170
|
+
`,
|
|
171
|
+
'foobar.yaml',
|
|
172
|
+
);
|
|
173
|
+
|
|
174
|
+
const results = await lintDocument({
|
|
175
|
+
externalRefResolver: new BaseResolver(),
|
|
176
|
+
document,
|
|
177
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
it('should not report on a scalar property of binary format missing an example', async () => {
|
|
184
|
+
const document = parseYamlToDocument(
|
|
185
|
+
outdent`
|
|
186
|
+
openapi: 3.1.0
|
|
187
|
+
components:
|
|
188
|
+
schemas:
|
|
189
|
+
User:
|
|
190
|
+
type: object
|
|
191
|
+
properties:
|
|
192
|
+
responses:
|
|
193
|
+
type: string
|
|
194
|
+
format: binary
|
|
195
|
+
`,
|
|
196
|
+
'foobar.yaml',
|
|
197
|
+
);
|
|
198
|
+
|
|
199
|
+
const results = await lintDocument({
|
|
200
|
+
externalRefResolver: new BaseResolver(),
|
|
201
|
+
document,
|
|
202
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
203
|
+
});
|
|
204
|
+
|
|
205
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
it('should not report on a scalar property of falsy values', async () => {
|
|
209
|
+
const document = parseYamlToDocument(
|
|
210
|
+
outdent`
|
|
211
|
+
openapi: 3.0.0
|
|
212
|
+
components:
|
|
213
|
+
schemas:
|
|
214
|
+
User:
|
|
215
|
+
type: object
|
|
216
|
+
properties:
|
|
217
|
+
testBool:
|
|
218
|
+
type: boolean
|
|
219
|
+
example: false
|
|
220
|
+
testString:
|
|
221
|
+
type: string
|
|
222
|
+
example: ""
|
|
223
|
+
testNumber:
|
|
224
|
+
type: number
|
|
225
|
+
example: 0
|
|
226
|
+
`,
|
|
227
|
+
'foobar.yaml',
|
|
228
|
+
);
|
|
229
|
+
|
|
230
|
+
const results = await lintDocument({
|
|
231
|
+
externalRefResolver: new BaseResolver(),
|
|
232
|
+
document,
|
|
233
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
234
|
+
});
|
|
235
|
+
|
|
236
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
237
|
+
});
|
|
238
|
+
|
|
239
|
+
it('should not report on a nullable scalar property values', async () => {
|
|
240
|
+
const document = parseYamlToDocument(
|
|
241
|
+
outdent`
|
|
242
|
+
openapi: 3.0.0
|
|
243
|
+
components:
|
|
244
|
+
schemas:
|
|
245
|
+
User:
|
|
246
|
+
type: object
|
|
247
|
+
properties:
|
|
248
|
+
testBool:
|
|
249
|
+
type: string
|
|
250
|
+
nullable: true
|
|
251
|
+
example: null
|
|
252
|
+
`,
|
|
253
|
+
'foobar.yaml',
|
|
254
|
+
);
|
|
255
|
+
|
|
256
|
+
const results = await lintDocument({
|
|
257
|
+
externalRefResolver: new BaseResolver(),
|
|
258
|
+
document,
|
|
259
|
+
config: await makeConfig({ 'scalar-property-missing-example': 'error' }),
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
263
|
+
});
|
|
264
|
+
});
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { outdent } from 'outdent';
|
|
2
|
+
import { lintDocument } from '../../../lint';
|
|
3
|
+
import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
|
|
4
|
+
import { BaseResolver } from '../../../resolve';
|
|
5
|
+
|
|
6
|
+
describe('Oas3 spec', () => {
|
|
7
|
+
it('should report missing schema property', async () => {
|
|
8
|
+
const document = parseYamlToDocument(
|
|
9
|
+
outdent`
|
|
10
|
+
openapi: 3.0.0
|
|
11
|
+
paths:
|
|
12
|
+
'/test':
|
|
13
|
+
get:
|
|
14
|
+
summary: Gets a specific pet
|
|
15
|
+
parameters:
|
|
16
|
+
- name: petId
|
|
17
|
+
in: path
|
|
18
|
+
responses:
|
|
19
|
+
200:
|
|
20
|
+
description: Ok
|
|
21
|
+
`,
|
|
22
|
+
'foobar.yaml',
|
|
23
|
+
);
|
|
24
|
+
|
|
25
|
+
const results = await lintDocument({
|
|
26
|
+
externalRefResolver: new BaseResolver(),
|
|
27
|
+
document,
|
|
28
|
+
config: await makeConfig({ 'spec': 'error' }),
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
|
|
32
|
+
Array [
|
|
33
|
+
Object {
|
|
34
|
+
"location": Array [
|
|
35
|
+
Object {
|
|
36
|
+
"pointer": "#/",
|
|
37
|
+
"reportOnKey": true,
|
|
38
|
+
"source": "foobar.yaml",
|
|
39
|
+
},
|
|
40
|
+
],
|
|
41
|
+
"message": "The field \`info\` must be present on this level.",
|
|
42
|
+
"ruleId": "spec",
|
|
43
|
+
"severity": "error",
|
|
44
|
+
"suggest": Array [],
|
|
45
|
+
},
|
|
46
|
+
Object {
|
|
47
|
+
"location": Array [
|
|
48
|
+
Object {
|
|
49
|
+
"pointer": "#/paths/~1test/get/parameters/0",
|
|
50
|
+
"reportOnKey": true,
|
|
51
|
+
"source": "foobar.yaml",
|
|
52
|
+
},
|
|
53
|
+
],
|
|
54
|
+
"message": "Must contain at least one of the following fields: schema, content.",
|
|
55
|
+
"ruleId": "spec",
|
|
56
|
+
"severity": "error",
|
|
57
|
+
"suggest": Array [],
|
|
58
|
+
},
|
|
59
|
+
]
|
|
60
|
+
`);
|
|
61
|
+
});
|
|
62
|
+
});
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { outdent } from 'outdent';
|
|
2
|
+
import { lintDocument } from '../../../lint';
|
|
3
|
+
import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
|
|
4
|
+
import { BaseResolver } from '../../../resolve';
|
|
5
|
+
|
|
6
|
+
describe('Oas3 tag-description', () => {
|
|
7
|
+
it('should report on tags with no description', async () => {
|
|
8
|
+
const document = parseYamlToDocument(
|
|
9
|
+
outdent`
|
|
10
|
+
openapi: 3.0.0
|
|
11
|
+
tags:
|
|
12
|
+
- name: firstTag
|
|
13
|
+
- name: secondTag
|
|
14
|
+
description: some description goes here
|
|
15
|
+
`,
|
|
16
|
+
'foobar.yaml',
|
|
17
|
+
);
|
|
18
|
+
|
|
19
|
+
const results = await lintDocument({
|
|
20
|
+
externalRefResolver: new BaseResolver(),
|
|
21
|
+
document,
|
|
22
|
+
config: await makeConfig({ 'tag-description': 'error' }),
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
|
|
26
|
+
Array [
|
|
27
|
+
Object {
|
|
28
|
+
"location": Array [
|
|
29
|
+
Object {
|
|
30
|
+
"pointer": "#/tags/0/description",
|
|
31
|
+
"reportOnKey": true,
|
|
32
|
+
"source": "foobar.yaml",
|
|
33
|
+
},
|
|
34
|
+
],
|
|
35
|
+
"message": "Tag object should contain \`description\` field.",
|
|
36
|
+
"ruleId": "tag-description",
|
|
37
|
+
"severity": "error",
|
|
38
|
+
"suggest": Array [],
|
|
39
|
+
},
|
|
40
|
+
]
|
|
41
|
+
`);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('should not report on tags with description', async () => {
|
|
45
|
+
const document = parseYamlToDocument(
|
|
46
|
+
outdent`
|
|
47
|
+
openapi: 3.0.0
|
|
48
|
+
tags:
|
|
49
|
+
- name: firstTag
|
|
50
|
+
description: bla
|
|
51
|
+
- name: secondTag
|
|
52
|
+
description: some description goes here
|
|
53
|
+
`,
|
|
54
|
+
'foobar.yaml',
|
|
55
|
+
);
|
|
56
|
+
|
|
57
|
+
const results = await lintDocument({
|
|
58
|
+
externalRefResolver: new BaseResolver(),
|
|
59
|
+
document,
|
|
60
|
+
config: await makeConfig({ 'tag-description': 'error' }),
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
64
|
+
});
|
|
65
|
+
});
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { outdent } from 'outdent';
|
|
2
|
+
import { lintDocument } from '../../../lint';
|
|
3
|
+
import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
|
|
4
|
+
import { BaseResolver } from '../../../resolve';
|
|
5
|
+
|
|
6
|
+
describe('Oas3 tags-alphabetical', () => {
|
|
7
|
+
it('should report on tags object if not sorted alphabetically', async () => {
|
|
8
|
+
const document = parseYamlToDocument(
|
|
9
|
+
outdent`
|
|
10
|
+
openapi: 3.0.0
|
|
11
|
+
paths: {}
|
|
12
|
+
tags:
|
|
13
|
+
- name: b
|
|
14
|
+
- name: a
|
|
15
|
+
`,
|
|
16
|
+
'foobar.yaml',
|
|
17
|
+
);
|
|
18
|
+
|
|
19
|
+
const results = await lintDocument({
|
|
20
|
+
externalRefResolver: new BaseResolver(),
|
|
21
|
+
document,
|
|
22
|
+
config: await makeConfig({ 'tags-alphabetical': 'error' }),
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
|
|
26
|
+
Array [
|
|
27
|
+
Object {
|
|
28
|
+
"location": Array [
|
|
29
|
+
Object {
|
|
30
|
+
"pointer": "#/tags/0",
|
|
31
|
+
"reportOnKey": false,
|
|
32
|
+
"source": "foobar.yaml",
|
|
33
|
+
},
|
|
34
|
+
],
|
|
35
|
+
"message": "The \`tags\` array should be in alphabetical order.",
|
|
36
|
+
"ruleId": "tags-alphabetical",
|
|
37
|
+
"severity": "error",
|
|
38
|
+
"suggest": Array [],
|
|
39
|
+
},
|
|
40
|
+
]
|
|
41
|
+
`);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('should not report on tags object if sorted alphabetically', async () => {
|
|
45
|
+
const document = parseYamlToDocument(
|
|
46
|
+
outdent`
|
|
47
|
+
openapi: 3.0.0
|
|
48
|
+
paths: {}
|
|
49
|
+
tags:
|
|
50
|
+
- name: a
|
|
51
|
+
- name: b
|
|
52
|
+
`,
|
|
53
|
+
'foobar.yaml',
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
const results = await lintDocument({
|
|
57
|
+
externalRefResolver: new BaseResolver(),
|
|
58
|
+
document,
|
|
59
|
+
config: await makeConfig({ 'tags-alphabetical': 'error' }),
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
|
|
63
|
+
});
|
|
64
|
+
});
|
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
import { asserts } from '../asserts';
|
|
2
|
+
|
|
3
|
+
describe('oas3 assertions', () => {
|
|
4
|
+
describe('generic rules', () => {
|
|
5
|
+
const fakeNode = {
|
|
6
|
+
foo: '',
|
|
7
|
+
bar: '',
|
|
8
|
+
baz: '',
|
|
9
|
+
};
|
|
10
|
+
|
|
11
|
+
describe('pattern', () => {
|
|
12
|
+
it('value should match regex pattern', () => {
|
|
13
|
+
expect(asserts.pattern('test string', '/test/')).toBeTruthy();
|
|
14
|
+
expect(asserts.pattern('test string', '/test me/')).toBeFalsy();
|
|
15
|
+
expect(asserts.pattern(['test string', 'test me'], '/test/')).toBeTruthy();
|
|
16
|
+
expect(asserts.pattern(['test string', 'test me'], '/test me/')).toBeFalsy();
|
|
17
|
+
});
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
describe('enum', () => {
|
|
21
|
+
it('value should be among predefined keys', () => {
|
|
22
|
+
expect(asserts.enum('test', ['test', 'example'])).toBeTruthy();
|
|
23
|
+
expect(asserts.enum(['test'], ['test', 'example'])).toBeTruthy();
|
|
24
|
+
expect(asserts.enum(['test', 'example'], ['test', 'example'])).toBeTruthy();
|
|
25
|
+
expect(asserts.enum(['test', 'example', 'foo'], ['test', 'example'])).toBeFalsy();
|
|
26
|
+
expect(asserts.enum('test', ['foo', 'example'])).toBeFalsy();
|
|
27
|
+
expect(asserts.enum(['test', 'foo'], ['test', 'example'])).toBeFalsy();
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
describe('defined', () => {
|
|
32
|
+
it('value should be defined', () => {
|
|
33
|
+
expect(asserts.defined('test', true)).toBeTruthy();
|
|
34
|
+
expect(asserts.defined(undefined, true)).toBeFalsy();
|
|
35
|
+
});
|
|
36
|
+
it('value should be undefined', () => {
|
|
37
|
+
expect(asserts.defined(undefined, false)).toBeTruthy();
|
|
38
|
+
expect(asserts.defined('test', false)).toBeFalsy();
|
|
39
|
+
});
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
describe('undefined', () => {
|
|
43
|
+
it('value should be undefined', () => {
|
|
44
|
+
expect(asserts.undefined(undefined, true)).toBeTruthy();
|
|
45
|
+
expect(asserts.undefined('test', true)).toBeFalsy();
|
|
46
|
+
});
|
|
47
|
+
it('value should be defined', () => {
|
|
48
|
+
expect(asserts.undefined('test', false)).toBeTruthy();
|
|
49
|
+
expect(asserts.undefined(undefined, false)).toBeFalsy();
|
|
50
|
+
});
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
describe('required', () => {
|
|
54
|
+
it('values should be required', () => {
|
|
55
|
+
expect(asserts.required(['one', 'two', 'three'], ['one', 'two'])).toBeTruthy();
|
|
56
|
+
expect(asserts.required(['one', 'two'], ['one', 'two', 'three'])).toBeFalsy();
|
|
57
|
+
});
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
describe('nonEmpty', () => {
|
|
61
|
+
it('value should not be empty', () => {
|
|
62
|
+
expect(asserts.nonEmpty('test', true)).toBeTruthy();
|
|
63
|
+
expect(asserts.nonEmpty('', true)).toBeFalsy();
|
|
64
|
+
expect(asserts.nonEmpty(null, true)).toBeFalsy();
|
|
65
|
+
expect(asserts.nonEmpty(undefined, true)).toBeFalsy();
|
|
66
|
+
});
|
|
67
|
+
it('value should be empty', () => {
|
|
68
|
+
expect(asserts.nonEmpty('', false)).toBeTruthy();
|
|
69
|
+
expect(asserts.nonEmpty(null, false)).toBeTruthy();
|
|
70
|
+
expect(asserts.nonEmpty(undefined, false)).toBeTruthy();
|
|
71
|
+
expect(asserts.nonEmpty('test', false)).toBeFalsy();
|
|
72
|
+
});
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
describe('minLength', () => {
|
|
76
|
+
it('value should have less or equal than 5 symbols length', () => {
|
|
77
|
+
expect(asserts.minLength('test', 5)).toBeFalsy();
|
|
78
|
+
expect(asserts.minLength([1, 2, 3, 4], 5)).toBeFalsy();
|
|
79
|
+
expect(asserts.minLength([1, 2, 3, 4, 5], 5)).toBeTruthy();
|
|
80
|
+
expect(asserts.minLength([1, 2, 3, 4, 5, 6], 5)).toBeTruthy();
|
|
81
|
+
expect(asserts.minLength('example', 5)).toBeTruthy();
|
|
82
|
+
expect(asserts.minLength([], 5)).toBeFalsy();
|
|
83
|
+
expect(asserts.minLength('', 5)).toBeFalsy();
|
|
84
|
+
});
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
describe('maxLength', () => {
|
|
88
|
+
it('value should have more or equal than 5 symbols length', () => {
|
|
89
|
+
expect(asserts.maxLength('test', 5)).toBeTruthy();
|
|
90
|
+
expect(asserts.maxLength([1, 2, 3, 4], 5)).toBeTruthy();
|
|
91
|
+
expect(asserts.maxLength([1, 2, 3, 4, 5], 5)).toBeTruthy();
|
|
92
|
+
expect(asserts.maxLength([1, 2, 3, 4, 5, 6], 5)).toBeFalsy();
|
|
93
|
+
expect(asserts.maxLength('example', 5)).toBeFalsy();
|
|
94
|
+
expect(asserts.maxLength([], 5)).toBeTruthy();
|
|
95
|
+
expect(asserts.maxLength('', 5)).toBeTruthy();
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
describe('casing', () => {
|
|
100
|
+
it('value should be camelCase', () => {
|
|
101
|
+
expect(asserts.casing(['testExample', 'fooBar'], 'camelCase')).toBeTruthy();
|
|
102
|
+
expect(asserts.casing(['testExample', 'FooBar'], 'camelCase')).toBeFalsy();
|
|
103
|
+
expect(asserts.casing('testExample', 'camelCase')).toBeTruthy();
|
|
104
|
+
expect(asserts.casing('TestExample', 'camelCase')).toBeFalsy();
|
|
105
|
+
expect(asserts.casing('test-example', 'camelCase')).toBeFalsy();
|
|
106
|
+
expect(asserts.casing('test_example', 'camelCase')).toBeFalsy();
|
|
107
|
+
});
|
|
108
|
+
it('value should be PascalCase', () => {
|
|
109
|
+
expect(asserts.casing('TestExample', 'PascalCase')).toBeTruthy();
|
|
110
|
+
expect(asserts.casing(['TestExample', 'FooBar'], 'PascalCase')).toBeTruthy();
|
|
111
|
+
expect(asserts.casing(['TestExample', 'fooBar'], 'PascalCase')).toBeFalsy();
|
|
112
|
+
expect(asserts.casing('testExample', 'PascalCase')).toBeFalsy();
|
|
113
|
+
expect(asserts.casing('test-example', 'PascalCase')).toBeFalsy();
|
|
114
|
+
expect(asserts.casing('test_example', 'PascalCase')).toBeFalsy();
|
|
115
|
+
});
|
|
116
|
+
it('value should be kebab-case', () => {
|
|
117
|
+
expect(asserts.casing('test-example', 'kebab-case')).toBeTruthy();
|
|
118
|
+
expect(asserts.casing(['test-example', 'foo-bar'], 'kebab-case')).toBeTruthy();
|
|
119
|
+
expect(asserts.casing(['test-example', 'foo_bar'], 'kebab-case')).toBeFalsy();
|
|
120
|
+
expect(asserts.casing('testExample', 'kebab-case')).toBeFalsy();
|
|
121
|
+
expect(asserts.casing('TestExample', 'kebab-case')).toBeFalsy();
|
|
122
|
+
expect(asserts.casing('test_example', 'kebab-case')).toBeFalsy();
|
|
123
|
+
});
|
|
124
|
+
it('value should be snake_case', () => {
|
|
125
|
+
expect(asserts.casing('test_example', 'snake_case')).toBeTruthy();
|
|
126
|
+
expect(asserts.casing(['test_example', 'foo_bar'], 'snake_case')).toBeTruthy();
|
|
127
|
+
expect(asserts.casing(['test_example', 'foo-bar'], 'snake_case')).toBeFalsy();
|
|
128
|
+
expect(asserts.casing('testExample', 'snake_case')).toBeFalsy();
|
|
129
|
+
expect(asserts.casing('TestExample', 'snake_case')).toBeFalsy();
|
|
130
|
+
expect(asserts.casing('test-example', 'snake_case')).toBeFalsy();
|
|
131
|
+
});
|
|
132
|
+
it('value should be MACRO_CASE', () => {
|
|
133
|
+
expect(asserts.casing('TEST_EXAMPLE', 'MACRO_CASE')).toBeTruthy();
|
|
134
|
+
expect(asserts.casing(['TEST_EXAMPLE', 'FOO_BAR'], 'MACRO_CASE')).toBeTruthy();
|
|
135
|
+
expect(asserts.casing(['TEST_EXAMPLE', 'FOO-BAR'], 'MACRO_CASE')).toBeFalsy();
|
|
136
|
+
expect(asserts.casing('TEST_EXAMPLE_', 'MACRO_CASE')).toBeFalsy();
|
|
137
|
+
expect(asserts.casing('_TEST_EXAMPLE', 'MACRO_CASE')).toBeFalsy();
|
|
138
|
+
expect(asserts.casing('TEST__EXAMPLE', 'MACRO_CASE')).toBeFalsy();
|
|
139
|
+
expect(asserts.casing('TEST-EXAMPLE', 'MACRO_CASE')).toBeFalsy();
|
|
140
|
+
expect(asserts.casing('testExample', 'MACRO_CASE')).toBeFalsy();
|
|
141
|
+
expect(asserts.casing('TestExample', 'MACRO_CASE')).toBeFalsy();
|
|
142
|
+
expect(asserts.casing('test-example', 'MACRO_CASE')).toBeFalsy();
|
|
143
|
+
});
|
|
144
|
+
it('value should be COBOL-CASE', () => {
|
|
145
|
+
expect(asserts.casing('TEST-EXAMPLE', 'COBOL-CASE')).toBeTruthy();
|
|
146
|
+
expect(asserts.casing(['TEST-EXAMPLE', 'FOO-BAR'], 'COBOL-CASE')).toBeTruthy();
|
|
147
|
+
expect(asserts.casing(['TEST-EXAMPLE', 'FOO_BAR'], 'COBOL-CASE')).toBeFalsy();
|
|
148
|
+
expect(asserts.casing('TEST-EXAMPLE-', 'COBOL-CASE')).toBeFalsy();
|
|
149
|
+
expect(asserts.casing('0TEST-EXAMPLE', 'COBOL-CASE')).toBeFalsy();
|
|
150
|
+
expect(asserts.casing('-TEST-EXAMPLE', 'COBOL-CASE')).toBeFalsy();
|
|
151
|
+
expect(asserts.casing('TEST--EXAMPLE', 'COBOL-CASE')).toBeFalsy();
|
|
152
|
+
expect(asserts.casing('TEST_EXAMPLE', 'COBOL-CASE')).toBeFalsy();
|
|
153
|
+
expect(asserts.casing('testExample', 'COBOL-CASE')).toBeFalsy();
|
|
154
|
+
expect(asserts.casing('TestExample', 'COBOL-CASE')).toBeFalsy();
|
|
155
|
+
expect(asserts.casing('test-example', 'COBOL-CASE')).toBeFalsy();
|
|
156
|
+
});
|
|
157
|
+
it('value should be flatcase', () => {
|
|
158
|
+
expect(asserts.casing('testexample', 'flatcase')).toBeTruthy();
|
|
159
|
+
expect(asserts.casing(['testexample', 'foobar'], 'flatcase')).toBeTruthy();
|
|
160
|
+
expect(asserts.casing(['testexample', 'foo_bar'], 'flatcase')).toBeFalsy();
|
|
161
|
+
expect(asserts.casing('testexample_', 'flatcase')).toBeFalsy();
|
|
162
|
+
expect(asserts.casing('0testexample', 'flatcase')).toBeFalsy();
|
|
163
|
+
expect(asserts.casing('testExample', 'flatcase')).toBeFalsy();
|
|
164
|
+
expect(asserts.casing('TestExample', 'flatcase')).toBeFalsy();
|
|
165
|
+
expect(asserts.casing('test-example', 'flatcase')).toBeFalsy();
|
|
166
|
+
});
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
describe.skip('sortOrder', () => {
|
|
170
|
+
it('value should be ordered in ASC direction', () => {
|
|
171
|
+
expect(asserts.sortOrder(['example', 'foo', 'test'], 'asc')).toBeTruthy();
|
|
172
|
+
expect(asserts.sortOrder(['example', 'foo', 'test'], { direction: 'asc' })).toBeTruthy();
|
|
173
|
+
expect(asserts.sortOrder(['example'], 'asc')).toBeTruthy();
|
|
174
|
+
expect(asserts.sortOrder(['example', 'test', 'foo'], 'asc')).toBeFalsy();
|
|
175
|
+
expect(asserts.sortOrder(['example', 'foo', 'test'], 'desc')).toBeFalsy();
|
|
176
|
+
expect(
|
|
177
|
+
asserts.sortOrder([{ name: 'bar' }, { name: 'baz' }, { name: 'foo' }], {
|
|
178
|
+
direction: 'asc',
|
|
179
|
+
property: 'name',
|
|
180
|
+
}),
|
|
181
|
+
).toBeTruthy();
|
|
182
|
+
expect(
|
|
183
|
+
asserts.sortOrder([{ name: 'bar' }, { name: 'baz' }, { name: 'foo' }], {
|
|
184
|
+
direction: 'desc',
|
|
185
|
+
property: 'name',
|
|
186
|
+
}),
|
|
187
|
+
).toBeFalsy();
|
|
188
|
+
});
|
|
189
|
+
it('value should be ordered in DESC direction', () => {
|
|
190
|
+
expect(asserts.sortOrder(['test', 'foo', 'example'], 'desc')).toBeTruthy();
|
|
191
|
+
expect(asserts.sortOrder(['test', 'foo', 'example'], { direction: 'desc' })).toBeTruthy();
|
|
192
|
+
expect(asserts.sortOrder(['example'], 'desc')).toBeTruthy();
|
|
193
|
+
expect(asserts.sortOrder(['example', 'test', 'foo'], 'desc')).toBeFalsy();
|
|
194
|
+
expect(asserts.sortOrder(['test', 'foo', 'example'], 'asc')).toBeFalsy();
|
|
195
|
+
expect(
|
|
196
|
+
asserts.sortOrder([{ name: 'foo' }, { name: 'baz' }, { name: 'bar' }], {
|
|
197
|
+
direction: 'desc',
|
|
198
|
+
property: 'name',
|
|
199
|
+
}),
|
|
200
|
+
).toBeTruthy();
|
|
201
|
+
expect(
|
|
202
|
+
asserts.sortOrder([{ name: 'foo' }, { name: 'baz' }, { name: 'bar' }], {
|
|
203
|
+
direction: 'asc',
|
|
204
|
+
property: 'name',
|
|
205
|
+
}),
|
|
206
|
+
).toBeFalsy();
|
|
207
|
+
});
|
|
208
|
+
});
|
|
209
|
+
|
|
210
|
+
describe('mutuallyExclusive', () => {
|
|
211
|
+
it('node should not have more than one property from predefined list', () => {
|
|
212
|
+
expect(asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'test'])).toBeTruthy();
|
|
213
|
+
expect(asserts.mutuallyExclusive(Object.keys(fakeNode), [])).toBeTruthy();
|
|
214
|
+
expect(asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'bar'])).toBeFalsy();
|
|
215
|
+
expect(
|
|
216
|
+
asserts.mutuallyExclusive(Object.keys(fakeNode), ['foo', 'bar', 'test']),
|
|
217
|
+
).toBeFalsy();
|
|
218
|
+
});
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
describe('mutuallyRequired', () => {
|
|
222
|
+
it('node should have all the properties from predefined list', () => {
|
|
223
|
+
expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar'])).toBeTruthy();
|
|
224
|
+
expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar', 'baz'])).toBeTruthy();
|
|
225
|
+
expect(asserts.mutuallyRequired(Object.keys(fakeNode), [])).toBeTruthy();
|
|
226
|
+
expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'test'])).toBeFalsy();
|
|
227
|
+
expect(asserts.mutuallyRequired(Object.keys(fakeNode), ['foo', 'bar', 'test'])).toBeFalsy();
|
|
228
|
+
});
|
|
229
|
+
});
|
|
230
|
+
});
|
|
231
|
+
});
|