@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,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationSecurityDefined = void 0;
|
|
4
|
+
const OperationSecurityDefined = () => {
|
|
5
|
+
let referencedSchemes = new Map();
|
|
6
|
+
return {
|
|
7
|
+
DefinitionRoot: {
|
|
8
|
+
leave(_, { report }) {
|
|
9
|
+
for (const [name, scheme] of referencedSchemes.entries()) {
|
|
10
|
+
if (scheme.defined)
|
|
11
|
+
continue;
|
|
12
|
+
for (const reportedFromLocation of scheme.from) {
|
|
13
|
+
report({
|
|
14
|
+
message: `There is no \`${name}\` security scheme defined.`,
|
|
15
|
+
location: reportedFromLocation.key(),
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
},
|
|
21
|
+
SecurityScheme(_securityScheme, { key }) {
|
|
22
|
+
referencedSchemes.set(key.toString(), { defined: true, from: [] });
|
|
23
|
+
},
|
|
24
|
+
SecurityRequirement(requirements, { location }) {
|
|
25
|
+
for (const requirement of Object.keys(requirements)) {
|
|
26
|
+
const authScheme = referencedSchemes.get(requirement);
|
|
27
|
+
const requirementLocation = location.child([requirement]);
|
|
28
|
+
if (!authScheme) {
|
|
29
|
+
referencedSchemes.set(requirement, { from: [requirementLocation] });
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
authScheme.from.push(requirementLocation);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
exports.OperationSecurityDefined = OperationSecurityDefined;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationSingularTag = void 0;
|
|
4
|
+
const OperationSingularTag = () => {
|
|
5
|
+
return {
|
|
6
|
+
Operation(operation, { report, location }) {
|
|
7
|
+
if (operation.tags && operation.tags.length > 1) {
|
|
8
|
+
report({
|
|
9
|
+
message: 'Operation `tags` object should have only one tag.',
|
|
10
|
+
location: location.child(['tags']).key(),
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.OperationSingularTag = OperationSingularTag;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationSummary = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const OperationSummary = () => {
|
|
6
|
+
return {
|
|
7
|
+
Operation(operation, ctx) {
|
|
8
|
+
utils_1.validateDefinedAndNonEmpty('summary', operation, ctx);
|
|
9
|
+
},
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
exports.OperationSummary = OperationSummary;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationTagDefined = void 0;
|
|
4
|
+
const OperationTagDefined = () => {
|
|
5
|
+
let definedTags;
|
|
6
|
+
return {
|
|
7
|
+
DefinitionRoot(root) {
|
|
8
|
+
var _a;
|
|
9
|
+
definedTags = new Set(((_a = root.tags) !== null && _a !== void 0 ? _a : []).map((t) => t.name));
|
|
10
|
+
},
|
|
11
|
+
Operation(operation, { report, location }) {
|
|
12
|
+
if (operation.tags) {
|
|
13
|
+
for (let i = 0; i < operation.tags.length; i++) {
|
|
14
|
+
if (!definedTags.has(operation.tags[i])) {
|
|
15
|
+
report({
|
|
16
|
+
message: `Operation tags should be defined in global tags.`,
|
|
17
|
+
location: location.child(['tags', i]),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
exports.OperationTagDefined = OperationTagDefined;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ParameterDescription = void 0;
|
|
4
|
+
const ParameterDescription = () => {
|
|
5
|
+
return {
|
|
6
|
+
Parameter(parameter, { report, location }) {
|
|
7
|
+
if (parameter.description === undefined) {
|
|
8
|
+
report({
|
|
9
|
+
message: 'Parameter object description must be present.',
|
|
10
|
+
location: { reportOnKey: true },
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
else if (!parameter.description) {
|
|
14
|
+
report({
|
|
15
|
+
message: 'Parameter object description must be non-empty string.',
|
|
16
|
+
location: location.child(['description']),
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
exports.ParameterDescription = ParameterDescription;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathDeclarationMustExist = void 0;
|
|
4
|
+
const PathDeclarationMustExist = () => {
|
|
5
|
+
return {
|
|
6
|
+
PathItem(_path, { report, key }) {
|
|
7
|
+
if (key.indexOf('{}') !== -1) {
|
|
8
|
+
report({
|
|
9
|
+
message: 'Path parameter declarations must be non-empty. `{}` is invalid.',
|
|
10
|
+
location: { reportOnKey: true },
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.PathDeclarationMustExist = PathDeclarationMustExist;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathExcludesPatterns = void 0;
|
|
4
|
+
const PathExcludesPatterns = ({ patterns }) => {
|
|
5
|
+
return {
|
|
6
|
+
PathItem(_path, { report, key, location }) {
|
|
7
|
+
if (!patterns)
|
|
8
|
+
throw new Error(`Parameter "patterns" is not provided for "path-excludes-patterns" rule`);
|
|
9
|
+
const pathKey = key.toString();
|
|
10
|
+
if (pathKey.startsWith('/')) {
|
|
11
|
+
const matches = patterns.filter((pattern) => pathKey.match(pattern));
|
|
12
|
+
for (const match of matches) {
|
|
13
|
+
report({
|
|
14
|
+
message: `path \`${pathKey}\` should not match regex pattern: \`${match}\``,
|
|
15
|
+
location: location.key(),
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
exports.PathExcludesPatterns = PathExcludesPatterns;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathHttpVerbsOrder = void 0;
|
|
4
|
+
const defaultOrder = ['get', 'head', 'post', 'put', 'patch', 'delete', 'options', 'trace'];
|
|
5
|
+
const PathHttpVerbsOrder = (opts) => {
|
|
6
|
+
const order = (opts && opts.order) || defaultOrder;
|
|
7
|
+
if (!Array.isArray(order)) {
|
|
8
|
+
throw new Error('path-http-verbs-order `order` option must be an array');
|
|
9
|
+
}
|
|
10
|
+
return {
|
|
11
|
+
PathItem(path, { report, location }) {
|
|
12
|
+
const httpVerbs = Object.keys(path).filter((k) => order.includes(k));
|
|
13
|
+
for (let i = 0; i < httpVerbs.length - 1; i++) {
|
|
14
|
+
const aIdx = order.indexOf(httpVerbs[i]);
|
|
15
|
+
const bIdx = order.indexOf(httpVerbs[i + 1]);
|
|
16
|
+
if (bIdx < aIdx) {
|
|
17
|
+
report({
|
|
18
|
+
message: 'Operation http verbs must be ordered.',
|
|
19
|
+
location: Object.assign({ reportOnKey: true }, location.child(httpVerbs[i + 1])),
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
exports.PathHttpVerbsOrder = PathHttpVerbsOrder;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathNotIncludeQuery = void 0;
|
|
4
|
+
const PathNotIncludeQuery = () => {
|
|
5
|
+
return {
|
|
6
|
+
PathMap: {
|
|
7
|
+
PathItem(_operation, { report, key }) {
|
|
8
|
+
if (key.toString().includes('?')) {
|
|
9
|
+
report({
|
|
10
|
+
message: `Don't put query string items in the path, they belong in parameters with \`in: query\`.`,
|
|
11
|
+
location: { reportOnKey: true },
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
}
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
exports.PathNotIncludeQuery = PathNotIncludeQuery;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathParamsDefined = void 0;
|
|
4
|
+
const pathRegex = /\{([a-zA-Z0-9_.-]+)\}+/g;
|
|
5
|
+
const PathParamsDefined = () => {
|
|
6
|
+
let pathTemplateParams;
|
|
7
|
+
let definedPathParams;
|
|
8
|
+
let currentPath;
|
|
9
|
+
return {
|
|
10
|
+
PathItem: {
|
|
11
|
+
enter(_, { key }) {
|
|
12
|
+
definedPathParams = new Set();
|
|
13
|
+
currentPath = key;
|
|
14
|
+
pathTemplateParams = new Set(Array.from(key.toString().matchAll(pathRegex)).map((m) => m[1]));
|
|
15
|
+
},
|
|
16
|
+
Parameter(parameter, { report, location }) {
|
|
17
|
+
if (parameter.in === 'path' && parameter.name) {
|
|
18
|
+
definedPathParams.add(parameter.name);
|
|
19
|
+
if (!pathTemplateParams.has(parameter.name)) {
|
|
20
|
+
report({
|
|
21
|
+
message: `Path parameter \`${parameter.name}\` is not used in the path \`${currentPath}\`.`,
|
|
22
|
+
location: location.child(['name']),
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
},
|
|
27
|
+
Operation: {
|
|
28
|
+
leave(_op, { report, location }) {
|
|
29
|
+
for (const templateParam of Array.from(pathTemplateParams.keys())) {
|
|
30
|
+
if (!definedPathParams.has(templateParam)) {
|
|
31
|
+
report({
|
|
32
|
+
message: `The operation does not define the path parameter \`{${templateParam}}\` expected by path \`${currentPath}\`.`,
|
|
33
|
+
location: location.child(['parameters']).key(), // report on operation
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
Parameter(parameter, { report, location }) {
|
|
39
|
+
if (parameter.in === 'path' && parameter.name) {
|
|
40
|
+
definedPathParams.add(parameter.name);
|
|
41
|
+
if (!pathTemplateParams.has(parameter.name)) {
|
|
42
|
+
report({
|
|
43
|
+
message: `Path parameter \`${parameter.name}\` is not used in the path \`${currentPath}\`.`,
|
|
44
|
+
location: location.child(['name']),
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
},
|
|
50
|
+
},
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
exports.PathParamsDefined = PathParamsDefined;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathSegmentPlural = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const PathSegmentPlural = (opts) => {
|
|
6
|
+
const { ignoreLastPathSegment, exceptions } = opts;
|
|
7
|
+
return {
|
|
8
|
+
PathItem: {
|
|
9
|
+
leave(_path, { report, key, location }) {
|
|
10
|
+
const pathKey = key.toString();
|
|
11
|
+
if (pathKey.startsWith('/')) {
|
|
12
|
+
const pathSegments = pathKey.split('/');
|
|
13
|
+
pathSegments.shift();
|
|
14
|
+
if (ignoreLastPathSegment && pathSegments.length > 1) {
|
|
15
|
+
pathSegments.pop();
|
|
16
|
+
}
|
|
17
|
+
for (const pathSegment of pathSegments) {
|
|
18
|
+
if (exceptions && exceptions.includes(pathSegment))
|
|
19
|
+
continue;
|
|
20
|
+
if (!utils_1.isPathParameter(pathSegment) && utils_1.isSingular(pathSegment)) {
|
|
21
|
+
report({
|
|
22
|
+
message: `path segment \`${pathSegment}\` should be plural.`,
|
|
23
|
+
location: location.key(),
|
|
24
|
+
});
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
},
|
|
30
|
+
};
|
|
31
|
+
};
|
|
32
|
+
exports.PathSegmentPlural = PathSegmentPlural;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PathsKebabCase = void 0;
|
|
4
|
+
const PathsKebabCase = () => {
|
|
5
|
+
return {
|
|
6
|
+
PathItem(_path, { report, key }) {
|
|
7
|
+
const segments = key.substr(1).split('/').filter(s => s !== ''); // filter out empty segments
|
|
8
|
+
if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
|
|
9
|
+
report({
|
|
10
|
+
message: `\`${key}\` does not use kebab-case.`,
|
|
11
|
+
location: { reportOnKey: true },
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.PathsKebabCase = PathsKebabCase;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ResponseContainsHeader = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const ResponseContainsHeader = (options) => {
|
|
6
|
+
const names = options.names || {};
|
|
7
|
+
return {
|
|
8
|
+
Operation: {
|
|
9
|
+
Response: {
|
|
10
|
+
enter: (response, { report, location, key }) => {
|
|
11
|
+
var _a;
|
|
12
|
+
const expectedHeaders = names[key] ||
|
|
13
|
+
names[utils_1.getMatchingStatusCodeRange(key)] ||
|
|
14
|
+
names[utils_1.getMatchingStatusCodeRange(key).toLowerCase()] ||
|
|
15
|
+
[];
|
|
16
|
+
for (const expectedHeader of expectedHeaders) {
|
|
17
|
+
if (!((_a = response.headers) === null || _a === void 0 ? void 0 : _a[expectedHeader])) {
|
|
18
|
+
report({
|
|
19
|
+
message: `Response object must contain a "${expectedHeader}" header.`,
|
|
20
|
+
location: location.child('headers').key(),
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
},
|
|
25
|
+
},
|
|
26
|
+
},
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
exports.ResponseContainsHeader = ResponseContainsHeader;
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ScalarPropertyMissingExample = void 0;
|
|
4
|
+
const oas_types_1 = require("../../oas-types");
|
|
5
|
+
const SCALAR_TYPES = ['string', 'integer', 'number', 'boolean', 'null'];
|
|
6
|
+
const ScalarPropertyMissingExample = () => {
|
|
7
|
+
return {
|
|
8
|
+
SchemaProperties(properties, { report, location, oasVersion, resolve }) {
|
|
9
|
+
for (const propName of Object.keys(properties)) {
|
|
10
|
+
const propSchema = resolve(properties[propName]).node;
|
|
11
|
+
if (!propSchema || !isScalarSchema(propSchema)) {
|
|
12
|
+
continue;
|
|
13
|
+
}
|
|
14
|
+
if (propSchema.example === undefined &&
|
|
15
|
+
propSchema.examples === undefined) {
|
|
16
|
+
report({
|
|
17
|
+
message: `Scalar property should have "example"${oasVersion === oas_types_1.OasVersion.Version3_1 ? ' or "examples"' : ''} defined.`,
|
|
18
|
+
location: location.child(propName).key(),
|
|
19
|
+
});
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
exports.ScalarPropertyMissingExample = ScalarPropertyMissingExample;
|
|
26
|
+
function isScalarSchema(schema) {
|
|
27
|
+
if (!schema.type) {
|
|
28
|
+
return false;
|
|
29
|
+
}
|
|
30
|
+
if (schema.allOf || schema.anyOf || schema.oneOf) {
|
|
31
|
+
// Skip allOf/oneOf/anyOf as it's complicated to validate it right now.
|
|
32
|
+
// We need core support for checking contrstrains through those keywords.
|
|
33
|
+
return false;
|
|
34
|
+
}
|
|
35
|
+
if (schema.format === 'binary') {
|
|
36
|
+
return false;
|
|
37
|
+
}
|
|
38
|
+
if (Array.isArray(schema.type)) {
|
|
39
|
+
return schema.type.every((t) => SCALAR_TYPES.includes(t));
|
|
40
|
+
}
|
|
41
|
+
return SCALAR_TYPES.includes(schema.type);
|
|
42
|
+
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OasSpec = void 0;
|
|
4
|
+
const types_1 = require("../../types");
|
|
5
|
+
const utils_1 = require("../utils");
|
|
6
|
+
const ref_utils_1 = require("../../ref-utils");
|
|
7
|
+
const utils_2 = require("../../utils");
|
|
8
|
+
const OasSpec = () => {
|
|
9
|
+
return {
|
|
10
|
+
any(node, { report, type, location, key, resolve, ignoreNextVisitorsOnNode }) {
|
|
11
|
+
var _a, _b, _c, _d;
|
|
12
|
+
const nodeType = utils_1.oasTypeOf(node);
|
|
13
|
+
if (type.items) {
|
|
14
|
+
if (nodeType !== 'array') {
|
|
15
|
+
report({
|
|
16
|
+
message: `Expected type \`${type.name}\` (array) but got \`${nodeType}\``,
|
|
17
|
+
});
|
|
18
|
+
ignoreNextVisitorsOnNode();
|
|
19
|
+
}
|
|
20
|
+
return;
|
|
21
|
+
}
|
|
22
|
+
else if (nodeType !== 'object') {
|
|
23
|
+
report({
|
|
24
|
+
message: `Expected type \`${type.name}\` (object) but got \`${nodeType}\``,
|
|
25
|
+
});
|
|
26
|
+
ignoreNextVisitorsOnNode();
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
const required = typeof type.required === 'function' ? type.required(node, key) : type.required;
|
|
30
|
+
for (let propName of required || []) {
|
|
31
|
+
if (!node.hasOwnProperty(propName)) {
|
|
32
|
+
report({
|
|
33
|
+
message: `The field \`${propName}\` must be present on this level.`,
|
|
34
|
+
location: [{ reportOnKey: true }],
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
const allowed = (_a = type.allowed) === null || _a === void 0 ? void 0 : _a.call(type, node);
|
|
39
|
+
if (allowed && utils_2.isPlainObject(node)) {
|
|
40
|
+
for (const propName in node) {
|
|
41
|
+
if (allowed.includes(propName) ||
|
|
42
|
+
(type.extensionsPrefix && propName.startsWith(type.extensionsPrefix)) ||
|
|
43
|
+
!Object.keys(type.properties).includes(propName)) {
|
|
44
|
+
continue;
|
|
45
|
+
}
|
|
46
|
+
report({
|
|
47
|
+
message: `The field \`${propName}\` is not allowed here.`,
|
|
48
|
+
location: location.child([propName]).key()
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
const requiredOneOf = type.requiredOneOf || null;
|
|
53
|
+
if (requiredOneOf) {
|
|
54
|
+
let hasProperty = false;
|
|
55
|
+
for (let propName of requiredOneOf || []) {
|
|
56
|
+
if (node.hasOwnProperty(propName)) {
|
|
57
|
+
hasProperty = true;
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
if (!hasProperty)
|
|
61
|
+
report({
|
|
62
|
+
message: `Must contain at least one of the following fields: ${(_b = type.requiredOneOf) === null || _b === void 0 ? void 0 : _b.join(', ')}.`,
|
|
63
|
+
location: [{ reportOnKey: true }],
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
for (const propName of Object.keys(node)) {
|
|
67
|
+
const propLocation = location.child([propName]);
|
|
68
|
+
let propValue = node[propName];
|
|
69
|
+
let propType = type.properties[propName];
|
|
70
|
+
if (propType === undefined)
|
|
71
|
+
propType = type.additionalProperties;
|
|
72
|
+
if (typeof propType === 'function')
|
|
73
|
+
propType = propType(propValue, propName);
|
|
74
|
+
if (types_1.isNamedType(propType)) {
|
|
75
|
+
continue; // do nothing for named schema, it is executed with the next any call
|
|
76
|
+
}
|
|
77
|
+
const propSchema = propType;
|
|
78
|
+
const propValueType = utils_1.oasTypeOf(propValue);
|
|
79
|
+
if (propSchema === undefined) {
|
|
80
|
+
if (propName.startsWith('x-'))
|
|
81
|
+
continue;
|
|
82
|
+
report({
|
|
83
|
+
message: `Property \`${propName}\` is not expected here.`,
|
|
84
|
+
suggest: utils_1.getSuggest(propName, Object.keys(type.properties)),
|
|
85
|
+
location: propLocation.key(),
|
|
86
|
+
});
|
|
87
|
+
continue;
|
|
88
|
+
}
|
|
89
|
+
if (propSchema === null) {
|
|
90
|
+
continue; // just defined, no validation
|
|
91
|
+
}
|
|
92
|
+
if (propSchema.resolvable !== false && ref_utils_1.isRef(propValue)) {
|
|
93
|
+
propValue = resolve(propValue).node;
|
|
94
|
+
}
|
|
95
|
+
if (propSchema.enum) {
|
|
96
|
+
if (!propSchema.enum.includes(propValue)) {
|
|
97
|
+
report({
|
|
98
|
+
location: propLocation,
|
|
99
|
+
message: `\`${propName}\` can be one of the following only: ${propSchema.enum
|
|
100
|
+
.map((i) => `"${i}"`)
|
|
101
|
+
.join(', ')}.`,
|
|
102
|
+
suggest: utils_1.getSuggest(propValue, propSchema.enum),
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
else if (propSchema.type && !utils_1.matchesJsonSchemaType(propValue, propSchema.type, false)) {
|
|
107
|
+
report({
|
|
108
|
+
message: `Expected type \`${propSchema.type}\` but got \`${propValueType}\`.`,
|
|
109
|
+
location: propLocation,
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
else if (propValueType === 'array' && ((_c = propSchema.items) === null || _c === void 0 ? void 0 : _c.type)) {
|
|
113
|
+
const itemsType = (_d = propSchema.items) === null || _d === void 0 ? void 0 : _d.type;
|
|
114
|
+
for (let i = 0; i < propValue.length; i++) {
|
|
115
|
+
const item = propValue[i];
|
|
116
|
+
if (!utils_1.matchesJsonSchemaType(item, itemsType, false)) {
|
|
117
|
+
report({
|
|
118
|
+
message: `Expected type \`${itemsType}\` but got \`${utils_1.oasTypeOf(item)}\`.`,
|
|
119
|
+
location: propLocation.child([i]),
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
if (typeof propSchema.minimum === 'number') {
|
|
125
|
+
if (propSchema.minimum > node[propName]) {
|
|
126
|
+
report({
|
|
127
|
+
message: `The value of the ${propName} field must be greater than or equal to ${propSchema.minimum}`,
|
|
128
|
+
location: location.child([propName]),
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
},
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
exports.OasSpec = OasSpec;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TagDescription = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const TagDescription = () => {
|
|
6
|
+
return {
|
|
7
|
+
Tag(tag, ctx) {
|
|
8
|
+
utils_1.validateDefinedAndNonEmpty('description', tag, ctx);
|
|
9
|
+
},
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
exports.TagDescription = TagDescription;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TagsAlphabetical = void 0;
|
|
4
|
+
const TagsAlphabetical = () => {
|
|
5
|
+
return {
|
|
6
|
+
DefinitionRoot(root, { report, location }) {
|
|
7
|
+
if (!root.tags)
|
|
8
|
+
return;
|
|
9
|
+
for (let i = 0; i < root.tags.length - 1; i++) {
|
|
10
|
+
if (root.tags[i].name > root.tags[i + 1].name) {
|
|
11
|
+
report({
|
|
12
|
+
message: 'The `tags` array should be in alphabetical order.',
|
|
13
|
+
location: location.child(['tags', i]),
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
exports.TagsAlphabetical = TagsAlphabetical;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { Oas3Rule } from '../visitors';
|
|
2
|
+
import { ResolveResult, Problem } from '../walk';
|
|
3
|
+
import { Location } from '../ref-utils';
|
|
4
|
+
export declare const NoUnresolvedRefs: Oas3Rule;
|
|
5
|
+
export declare function reportUnresolvedRef(resolved: ResolveResult<any>, report: (m: Problem) => void, location: Location): void;
|