@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,20 @@
|
|
|
1
|
+
import { ProblemSeverity, UserContext } from '../../../walk';
|
|
2
|
+
export declare type OrderDirection = 'asc' | 'desc';
|
|
3
|
+
export declare type OrderOptions = {
|
|
4
|
+
direction: OrderDirection;
|
|
5
|
+
property: string;
|
|
6
|
+
};
|
|
7
|
+
export declare type AssertToApply = {
|
|
8
|
+
name: string;
|
|
9
|
+
assertId?: string;
|
|
10
|
+
conditions: any;
|
|
11
|
+
message?: string;
|
|
12
|
+
severity?: ProblemSeverity;
|
|
13
|
+
suggest?: string[];
|
|
14
|
+
runsOnKeys: boolean;
|
|
15
|
+
runsOnValues: boolean;
|
|
16
|
+
};
|
|
17
|
+
export declare function buildVisitorObject(subject: string, context: Record<string, any>[], subjectVisitor: any): Record<string, any>;
|
|
18
|
+
export declare function buildSubjectVisitor(properties: string | string[], asserts: AssertToApply[], context?: Record<string, any>[]): (node: any, { report, location, key, type, resolve }: UserContext) => void;
|
|
19
|
+
export declare function getIntersectionLength(keys: string[], properties: string[]): number;
|
|
20
|
+
export declare function isOrdered(value: any[], options: OrderOptions | OrderDirection): boolean;
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isOrdered = exports.getIntersectionLength = exports.buildSubjectVisitor = exports.buildVisitorObject = void 0;
|
|
4
|
+
const ref_utils_1 = require("../../../ref-utils");
|
|
5
|
+
const asserts_1 = require("./asserts");
|
|
6
|
+
function buildVisitorObject(subject, context, subjectVisitor) {
|
|
7
|
+
if (!context) {
|
|
8
|
+
return { [subject]: subjectVisitor };
|
|
9
|
+
}
|
|
10
|
+
let currentVisitorLevel = {};
|
|
11
|
+
const visitor = currentVisitorLevel;
|
|
12
|
+
for (let index = 0; index < context.length; index++) {
|
|
13
|
+
const node = context[index];
|
|
14
|
+
if (context.length === index + 1 && node.type === subject) {
|
|
15
|
+
// Visitors don't work properly for the same type nested nodes, so
|
|
16
|
+
// as a workaround for that we don't create separate visitor for the last element
|
|
17
|
+
// which is the same as subject;
|
|
18
|
+
// we will check includes/excludes it in the last visitor.
|
|
19
|
+
continue;
|
|
20
|
+
}
|
|
21
|
+
const matchParentKeys = node.matchParentKeys;
|
|
22
|
+
const excludeParentKeys = node.excludeParentKeys;
|
|
23
|
+
if (matchParentKeys && excludeParentKeys) {
|
|
24
|
+
throw new Error(`Both 'matchParentKeys' and 'excludeParentKeys' can't be under one context item`);
|
|
25
|
+
}
|
|
26
|
+
if (matchParentKeys || excludeParentKeys) {
|
|
27
|
+
currentVisitorLevel[node.type] = {
|
|
28
|
+
skip: (_value, key) => {
|
|
29
|
+
if (matchParentKeys) {
|
|
30
|
+
return !matchParentKeys.includes(key);
|
|
31
|
+
}
|
|
32
|
+
if (excludeParentKeys) {
|
|
33
|
+
return excludeParentKeys.includes(key);
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
else {
|
|
39
|
+
currentVisitorLevel[node.type] = {};
|
|
40
|
+
}
|
|
41
|
+
currentVisitorLevel = currentVisitorLevel[node.type];
|
|
42
|
+
}
|
|
43
|
+
currentVisitorLevel[subject] = subjectVisitor;
|
|
44
|
+
return visitor;
|
|
45
|
+
}
|
|
46
|
+
exports.buildVisitorObject = buildVisitorObject;
|
|
47
|
+
function buildSubjectVisitor(properties, asserts, context) {
|
|
48
|
+
return function (node, { report, location, key, type, resolve }) {
|
|
49
|
+
var _a;
|
|
50
|
+
// We need to check context's last node if it has the same type as subject node;
|
|
51
|
+
// if yes - that means we didn't create context's last node visitor,
|
|
52
|
+
// so we need to handle 'matchParentKeys' and 'excludeParentKeys' conditions here;
|
|
53
|
+
if (context) {
|
|
54
|
+
const lastContextNode = context[context.length - 1];
|
|
55
|
+
if (lastContextNode.type === type.name) {
|
|
56
|
+
const matchParentKeys = lastContextNode.matchParentKeys;
|
|
57
|
+
const excludeParentKeys = lastContextNode.excludeParentKeys;
|
|
58
|
+
if (matchParentKeys && !matchParentKeys.includes(key)) {
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
if (excludeParentKeys && excludeParentKeys.includes(key)) {
|
|
62
|
+
return;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
if (properties) {
|
|
67
|
+
properties = Array.isArray(properties) ? properties : [properties];
|
|
68
|
+
}
|
|
69
|
+
for (const assert of asserts) {
|
|
70
|
+
if (properties) {
|
|
71
|
+
for (const property of properties) {
|
|
72
|
+
// we can have resolvable scalar so need to resolve value here.
|
|
73
|
+
const value = ref_utils_1.isRef(node[property]) ? (_a = resolve(node[property])) === null || _a === void 0 ? void 0 : _a.node : node[property];
|
|
74
|
+
runAssertion(value, assert, location.child(property), report);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
else {
|
|
78
|
+
runAssertion(Object.keys(node), assert, location.key(), report);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
exports.buildSubjectVisitor = buildSubjectVisitor;
|
|
84
|
+
function getIntersectionLength(keys, properties) {
|
|
85
|
+
const props = new Set(properties);
|
|
86
|
+
let count = 0;
|
|
87
|
+
for (const key of keys) {
|
|
88
|
+
if (props.has(key)) {
|
|
89
|
+
count++;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
return count;
|
|
93
|
+
}
|
|
94
|
+
exports.getIntersectionLength = getIntersectionLength;
|
|
95
|
+
function isOrdered(value, options) {
|
|
96
|
+
const direction = options.direction || options;
|
|
97
|
+
const property = options.property;
|
|
98
|
+
for (let i = 1; i < value.length; i++) {
|
|
99
|
+
let currValue = value[i];
|
|
100
|
+
let prevVal = value[i - 1];
|
|
101
|
+
if (property) {
|
|
102
|
+
if (!value[i][property] || !value[i - 1][property]) {
|
|
103
|
+
return false; // property doesn't exist, so collection is not ordered
|
|
104
|
+
}
|
|
105
|
+
currValue = value[i][property];
|
|
106
|
+
prevVal = value[i - 1][property];
|
|
107
|
+
}
|
|
108
|
+
const result = direction === 'asc' ? currValue >= prevVal : currValue <= prevVal;
|
|
109
|
+
if (!result) {
|
|
110
|
+
return false;
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
return true;
|
|
114
|
+
}
|
|
115
|
+
exports.isOrdered = isOrdered;
|
|
116
|
+
function runAssertion(values, assert, location, report) {
|
|
117
|
+
const lintResult = asserts_1.asserts[assert.name](values, assert.conditions);
|
|
118
|
+
if (!lintResult) {
|
|
119
|
+
report({
|
|
120
|
+
message: assert.message || `The ${assert.assertId} doesn't meet required conditions`,
|
|
121
|
+
location,
|
|
122
|
+
forceSeverity: assert.severity,
|
|
123
|
+
suggest: assert.suggest,
|
|
124
|
+
ruleId: assert.assertId,
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InfoContact = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const InfoContact = () => {
|
|
6
|
+
return {
|
|
7
|
+
Info(info, { report, location }) {
|
|
8
|
+
if (!info.contact) {
|
|
9
|
+
report({
|
|
10
|
+
message: utils_1.missingRequiredField('Info', 'contact'),
|
|
11
|
+
location: location.child('contact').key(),
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.InfoContact = InfoContact;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InfoDescription = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const InfoDescription = () => {
|
|
6
|
+
return {
|
|
7
|
+
Info(info, ctx) {
|
|
8
|
+
utils_1.validateDefinedAndNonEmpty('description', info, ctx);
|
|
9
|
+
},
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
exports.InfoDescription = InfoDescription;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InfoLicense = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const InfoLicense = () => {
|
|
6
|
+
return {
|
|
7
|
+
Info(info, { report }) {
|
|
8
|
+
if (!info.license) {
|
|
9
|
+
report({
|
|
10
|
+
message: utils_1.missingRequiredField('Info', 'license'),
|
|
11
|
+
location: { reportOnKey: true }
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.InfoLicense = InfoLicense;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InfoLicenseUrl = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const InfoLicenseUrl = () => {
|
|
6
|
+
return {
|
|
7
|
+
License(license, ctx) {
|
|
8
|
+
utils_1.validateDefinedAndNonEmpty('url', license, ctx);
|
|
9
|
+
},
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
exports.InfoLicenseUrl = InfoLicenseUrl;
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoAmbiguousPaths = void 0;
|
|
4
|
+
const NoAmbiguousPaths = () => {
|
|
5
|
+
return {
|
|
6
|
+
PathMap(pathMap, { report, location }) {
|
|
7
|
+
const seenPaths = [];
|
|
8
|
+
for (const currentPath of Object.keys(pathMap)) {
|
|
9
|
+
const ambiguousPath = seenPaths.find((seenPath) => arePathsAmbiguous(seenPath, currentPath));
|
|
10
|
+
if (ambiguousPath) {
|
|
11
|
+
report({
|
|
12
|
+
message: `Paths should resolve unambiguously. Found two ambiguous paths: \`${ambiguousPath}\` and \`${currentPath}\`.`,
|
|
13
|
+
location: location.child([currentPath]).key(),
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
seenPaths.push(currentPath);
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
exports.NoAmbiguousPaths = NoAmbiguousPaths;
|
|
22
|
+
function arePathsAmbiguous(a, b) {
|
|
23
|
+
const partsA = a.split('/');
|
|
24
|
+
const partsB = b.split('/');
|
|
25
|
+
if (partsA.length !== partsB.length)
|
|
26
|
+
return false;
|
|
27
|
+
let aVars = 0;
|
|
28
|
+
let bVars = 0;
|
|
29
|
+
let ambiguous = true;
|
|
30
|
+
for (let i = 0; i < partsA.length; i++) {
|
|
31
|
+
const aIsVar = partsA[i].match(/^{.+?}$/);
|
|
32
|
+
const bIsVar = partsB[i].match(/^{.+?}$/);
|
|
33
|
+
if (aIsVar || bIsVar) {
|
|
34
|
+
if (aIsVar)
|
|
35
|
+
aVars++;
|
|
36
|
+
if (bIsVar)
|
|
37
|
+
bVars++;
|
|
38
|
+
continue;
|
|
39
|
+
}
|
|
40
|
+
else if (partsA[i] !== partsB[i]) {
|
|
41
|
+
ambiguous = false;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
return ambiguous && aVars === bVars;
|
|
45
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoEnumTypeMismatch = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const NoEnumTypeMismatch = () => {
|
|
6
|
+
return {
|
|
7
|
+
Schema(schema, { report, location }) {
|
|
8
|
+
if (schema.enum && !Array.isArray(schema.enum))
|
|
9
|
+
return;
|
|
10
|
+
if (schema.enum && schema.type && !Array.isArray(schema.type)) {
|
|
11
|
+
const typeMismatchedValues = schema.enum.filter((item) => !utils_1.matchesJsonSchemaType(item, schema.type, schema.nullable));
|
|
12
|
+
for (const mismatchedValue of typeMismatchedValues) {
|
|
13
|
+
report({
|
|
14
|
+
message: `All values of \`enum\` field must be of the same type as the \`type\` field: expected "${schema.type}" but received "${utils_1.oasTypeOf(mismatchedValue)}".`,
|
|
15
|
+
location: location.child(['enum', schema.enum.indexOf(mismatchedValue)]),
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
if (schema.enum && schema.type && Array.isArray(schema.type)) {
|
|
20
|
+
const mismatchedResults = {};
|
|
21
|
+
for (const enumValue of schema.enum) {
|
|
22
|
+
mismatchedResults[enumValue] = [];
|
|
23
|
+
for (const type of schema.type) {
|
|
24
|
+
const valid = utils_1.matchesJsonSchemaType(enumValue, type, schema.nullable);
|
|
25
|
+
if (!valid)
|
|
26
|
+
mismatchedResults[enumValue].push(type);
|
|
27
|
+
}
|
|
28
|
+
if (mismatchedResults[enumValue].length !== schema.type.length)
|
|
29
|
+
delete mismatchedResults[enumValue];
|
|
30
|
+
}
|
|
31
|
+
;
|
|
32
|
+
for (const mismatchedKey of Object.keys(mismatchedResults)) {
|
|
33
|
+
report({
|
|
34
|
+
message: `Enum value \`${mismatchedKey}\` must be of one type. Allowed types: \`${schema.type}\`.`,
|
|
35
|
+
location: location.child(['enum', schema.enum.indexOf(mismatchedKey)]),
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
;
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
exports.NoEnumTypeMismatch = NoEnumTypeMismatch;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoHttpVerbsInPaths = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const httpMethods = ['get', 'head', 'post', 'put', 'patch', 'delete', 'options', 'trace'];
|
|
6
|
+
const NoHttpVerbsInPaths = ({ splitIntoWords }) => {
|
|
7
|
+
return {
|
|
8
|
+
PathItem(_path, { key, report, location }) {
|
|
9
|
+
const pathKey = key.toString();
|
|
10
|
+
if (!pathKey.startsWith('/'))
|
|
11
|
+
return;
|
|
12
|
+
const pathSegments = pathKey.split('/');
|
|
13
|
+
for (const pathSegment of pathSegments) {
|
|
14
|
+
if (!pathSegment || utils_1.isPathParameter(pathSegment))
|
|
15
|
+
continue;
|
|
16
|
+
const isHttpMethodIncluded = (method) => {
|
|
17
|
+
return splitIntoWords
|
|
18
|
+
? utils_1.splitCamelCaseIntoWords(pathSegment).has(method)
|
|
19
|
+
: pathSegment.toLocaleLowerCase().includes(method);
|
|
20
|
+
};
|
|
21
|
+
for (const method of httpMethods) {
|
|
22
|
+
if (isHttpMethodIncluded(method)) {
|
|
23
|
+
report({
|
|
24
|
+
message: `path \`${pathKey}\` should not contain http verb ${method}`,
|
|
25
|
+
location: location.key(),
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
exports.NoHttpVerbsInPaths = NoHttpVerbsInPaths;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoIdenticalPaths = void 0;
|
|
4
|
+
const NoIdenticalPaths = () => {
|
|
5
|
+
return {
|
|
6
|
+
PathMap(pathMap, { report, location }) {
|
|
7
|
+
const pathsMap = new Map();
|
|
8
|
+
for (const pathName of Object.keys(pathMap)) {
|
|
9
|
+
const id = pathName.replace(/{.+?}/g, '{VARIABLE}');
|
|
10
|
+
const existingSamePath = pathsMap.get(id);
|
|
11
|
+
if (existingSamePath) {
|
|
12
|
+
report({
|
|
13
|
+
message: `The path already exists which differs only by path parameter name(s): \`${existingSamePath}\` and \`${pathName}\`.`,
|
|
14
|
+
location: location.child([pathName]).key(),
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
else {
|
|
18
|
+
pathsMap.set(id, pathName);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
exports.NoIdenticalPaths = NoIdenticalPaths;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const NoInvalidParameterExamples: any;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoInvalidParameterExamples = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const NoInvalidParameterExamples = (opts) => {
|
|
6
|
+
var _a;
|
|
7
|
+
const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
|
|
8
|
+
return {
|
|
9
|
+
Parameter: {
|
|
10
|
+
leave(parameter, ctx) {
|
|
11
|
+
if (parameter.example) {
|
|
12
|
+
utils_1.validateExample(parameter.example, parameter.schema, ctx.location.child('example'), ctx, disallowAdditionalProperties);
|
|
13
|
+
}
|
|
14
|
+
if (parameter.examples) {
|
|
15
|
+
for (const [key, example] of Object.entries(parameter.examples)) {
|
|
16
|
+
if ('value' in example) {
|
|
17
|
+
utils_1.validateExample(example.value, parameter.schema, ctx.location.child(['examples', key]), ctx, false);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
exports.NoInvalidParameterExamples = NoInvalidParameterExamples;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const NoInvalidSchemaExamples: any;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoInvalidSchemaExamples = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const NoInvalidSchemaExamples = (opts) => {
|
|
6
|
+
var _a;
|
|
7
|
+
const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
|
|
8
|
+
return {
|
|
9
|
+
Schema: {
|
|
10
|
+
leave(schema, ctx) {
|
|
11
|
+
if (schema.examples) {
|
|
12
|
+
for (const example of schema.examples) {
|
|
13
|
+
utils_1.validateExample(example, schema, ctx.location.child(['examples', schema.examples.indexOf(example)]), ctx, disallowAdditionalProperties);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
if (schema.example) {
|
|
17
|
+
utils_1.validateExample(schema.example, schema, ctx.location.child('example'), ctx, false);
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
},
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
exports.NoInvalidSchemaExamples = NoInvalidSchemaExamples;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoPathTrailingSlash = void 0;
|
|
4
|
+
const NoPathTrailingSlash = () => {
|
|
5
|
+
return {
|
|
6
|
+
PathItem(_path, { report, key, location }) {
|
|
7
|
+
if (key.endsWith('/') && key !== '/') {
|
|
8
|
+
report({
|
|
9
|
+
message: `\`${key}\` should not have a trailing slash.`,
|
|
10
|
+
location: location.key(),
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.NoPathTrailingSlash = NoPathTrailingSlash;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Operation2xxResponse = void 0;
|
|
4
|
+
const Operation2xxResponse = () => {
|
|
5
|
+
return {
|
|
6
|
+
ResponsesMap(responses, { report }) {
|
|
7
|
+
const codes = Object.keys(responses);
|
|
8
|
+
if (!codes.some((code) => code === 'default' || /2[Xx0-9]{2}/.test(code))) {
|
|
9
|
+
report({
|
|
10
|
+
message: 'Operation must have at least one `2xx` response.',
|
|
11
|
+
location: { reportOnKey: true },
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.Operation2xxResponse = Operation2xxResponse;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Operation4xxResponse = void 0;
|
|
4
|
+
const Operation4xxResponse = () => {
|
|
5
|
+
return {
|
|
6
|
+
ResponsesMap(responses, { report }) {
|
|
7
|
+
const codes = Object.keys(responses);
|
|
8
|
+
if (!codes.some((code) => /4[Xx0-9]{2}/.test(code))) {
|
|
9
|
+
report({
|
|
10
|
+
message: 'Operation must have at least one `4xx` response.',
|
|
11
|
+
location: { reportOnKey: true },
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.Operation4xxResponse = Operation4xxResponse;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationDescription = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const OperationDescription = () => {
|
|
6
|
+
return {
|
|
7
|
+
Operation(operation, ctx) {
|
|
8
|
+
utils_1.validateDefinedAndNonEmpty('description', operation, ctx);
|
|
9
|
+
},
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
exports.OperationDescription = OperationDescription;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationIdUnique = void 0;
|
|
4
|
+
const OperationIdUnique = () => {
|
|
5
|
+
const seenOperations = new Set();
|
|
6
|
+
return {
|
|
7
|
+
Operation(operation, { report, location }) {
|
|
8
|
+
if (!operation.operationId)
|
|
9
|
+
return;
|
|
10
|
+
if (seenOperations.has(operation.operationId)) {
|
|
11
|
+
report({
|
|
12
|
+
message: 'Every operation must have a unique `operationId`.',
|
|
13
|
+
location: location.child([operation.operationId]),
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
seenOperations.add(operation.operationId);
|
|
17
|
+
},
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
exports.OperationIdUnique = OperationIdUnique;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationIdUrlSafe = void 0;
|
|
4
|
+
const validUrlSymbols = /^[A-Za-z0-9-._~:/?#\[\]@!\$&'()*+,;=]*$/;
|
|
5
|
+
const OperationIdUrlSafe = () => {
|
|
6
|
+
return {
|
|
7
|
+
Operation(operation, { report, location }) {
|
|
8
|
+
if (operation.operationId && !validUrlSymbols.test(operation.operationId)) {
|
|
9
|
+
report({
|
|
10
|
+
message: 'Operation `operationId` should not have URL invalid characters.',
|
|
11
|
+
location: location.child(['operationId']),
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.OperationIdUrlSafe = OperationIdUrlSafe;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationOperationId = void 0;
|
|
4
|
+
const utils_1 = require("../utils");
|
|
5
|
+
const OperationOperationId = () => {
|
|
6
|
+
return {
|
|
7
|
+
DefinitionRoot: {
|
|
8
|
+
PathItem: {
|
|
9
|
+
Operation(operation, ctx) {
|
|
10
|
+
utils_1.validateDefinedAndNonEmpty('operationId', operation, ctx);
|
|
11
|
+
},
|
|
12
|
+
},
|
|
13
|
+
}
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.OperationOperationId = OperationOperationId;
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationParametersUnique = void 0;
|
|
4
|
+
const OperationParametersUnique = () => {
|
|
5
|
+
let seenPathParams;
|
|
6
|
+
let seenOperationParams;
|
|
7
|
+
return {
|
|
8
|
+
PathItem: {
|
|
9
|
+
enter() {
|
|
10
|
+
seenPathParams = new Set();
|
|
11
|
+
},
|
|
12
|
+
Parameter(parameter, { report, key, parentLocations }) {
|
|
13
|
+
const paramId = `${parameter.in}___${parameter.name}`;
|
|
14
|
+
if (seenPathParams.has(paramId)) {
|
|
15
|
+
report({
|
|
16
|
+
message: `Paths must have unique \`name\` + \`in\` parameters.\nRepeats of \`in:${parameter.in}\` + \`name:${parameter.name}\`.`,
|
|
17
|
+
location: parentLocations.PathItem.child(['parameters', key]),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
seenPathParams.add(`${parameter.in}___${parameter.name}`);
|
|
21
|
+
},
|
|
22
|
+
Operation: {
|
|
23
|
+
enter() {
|
|
24
|
+
seenOperationParams = new Set();
|
|
25
|
+
},
|
|
26
|
+
Parameter(parameter, { report, key, parentLocations }) {
|
|
27
|
+
const paramId = `${parameter.in}___${parameter.name}`;
|
|
28
|
+
if (seenOperationParams.has(paramId)) {
|
|
29
|
+
report({
|
|
30
|
+
message: `Operations must have unique \`name\` + \`in\` parameters. Repeats of \`in:${parameter.in}\` + \`name:${parameter.name}\`.`,
|
|
31
|
+
location: parentLocations.Operation.child(['parameters', key]),
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
seenOperationParams.add(paramId);
|
|
35
|
+
},
|
|
36
|
+
},
|
|
37
|
+
},
|
|
38
|
+
};
|
|
39
|
+
};
|
|
40
|
+
exports.OperationParametersUnique = OperationParametersUnique;
|