@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,47 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.reportUnresolvedRef = exports.NoUnresolvedRefs = void 0;
|
|
4
|
+
const resolve_1 = require("../resolve");
|
|
5
|
+
const NoUnresolvedRefs = () => {
|
|
6
|
+
return {
|
|
7
|
+
ref: {
|
|
8
|
+
leave(_, { report, location }, resolved) {
|
|
9
|
+
if (resolved.node !== undefined)
|
|
10
|
+
return;
|
|
11
|
+
reportUnresolvedRef(resolved, report, location);
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
DiscriminatorMapping(mapping, { report, resolve, location }) {
|
|
15
|
+
for (const mappingName of Object.keys(mapping)) {
|
|
16
|
+
const resolved = resolve({ $ref: mapping[mappingName] });
|
|
17
|
+
if (resolved.node !== undefined)
|
|
18
|
+
return;
|
|
19
|
+
reportUnresolvedRef(resolved, report, location.child(mappingName));
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
exports.NoUnresolvedRefs = NoUnresolvedRefs;
|
|
25
|
+
function reportUnresolvedRef(resolved, report, location) {
|
|
26
|
+
var _a;
|
|
27
|
+
const error = resolved.error;
|
|
28
|
+
if (error instanceof resolve_1.YamlParseError) {
|
|
29
|
+
report({
|
|
30
|
+
message: 'Failed to parse: ' + error.message,
|
|
31
|
+
location: {
|
|
32
|
+
source: error.source,
|
|
33
|
+
pointer: undefined,
|
|
34
|
+
start: {
|
|
35
|
+
col: error.col,
|
|
36
|
+
line: error.line,
|
|
37
|
+
},
|
|
38
|
+
},
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
const message = (_a = resolved.error) === null || _a === void 0 ? void 0 : _a.message;
|
|
42
|
+
report({
|
|
43
|
+
location,
|
|
44
|
+
message: `Can't resolve $ref${message ? ': ' + message : ''}`,
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
exports.reportUnresolvedRef = reportUnresolvedRef;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.BooleanParameterPrefixes = void 0;
|
|
4
|
+
const BooleanParameterPrefixes = (options) => {
|
|
5
|
+
const prefixes = options.prefixes || ['is', 'has'];
|
|
6
|
+
const regexp = new RegExp(`^(${prefixes.join('|')})[A-Z-_]`);
|
|
7
|
+
const wrappedPrefixes = prefixes.map((p) => `\`${p}\``);
|
|
8
|
+
const prefixesString = wrappedPrefixes.length === 1
|
|
9
|
+
? wrappedPrefixes[0]
|
|
10
|
+
: wrappedPrefixes.slice(0, -1).join(', ') + ' or ' + wrappedPrefixes[prefixes.length - 1];
|
|
11
|
+
return {
|
|
12
|
+
Parameter(param, { report, location }) {
|
|
13
|
+
if (param.type === 'boolean' && !regexp.test(param.name)) {
|
|
14
|
+
report({
|
|
15
|
+
message: `Boolean parameter \`${param.name}\` should have ${prefixesString} prefix.`,
|
|
16
|
+
location: location.child('name'),
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
exports.BooleanParameterPrefixes = BooleanParameterPrefixes;
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { Oas2Rule } from '../../visitors';
|
|
2
|
+
export declare const rules: {
|
|
3
|
+
spec: Oas2Rule;
|
|
4
|
+
'no-invalid-schema-examples': any;
|
|
5
|
+
'no-invalid-parameter-examples': any;
|
|
6
|
+
'info-description': Oas2Rule;
|
|
7
|
+
'info-contact': Oas2Rule;
|
|
8
|
+
'info-license': Oas2Rule;
|
|
9
|
+
'info-license-url': Oas2Rule;
|
|
10
|
+
'tag-description': Oas2Rule;
|
|
11
|
+
'tags-alphabetical': Oas2Rule;
|
|
12
|
+
'paths-kebab-case': Oas2Rule;
|
|
13
|
+
'no-enum-type-mismatch': Oas2Rule;
|
|
14
|
+
'boolean-parameter-prefixes': Oas2Rule;
|
|
15
|
+
'no-path-trailing-slash': Oas2Rule;
|
|
16
|
+
'operation-2xx-response': Oas2Rule;
|
|
17
|
+
'operation-4xx-response': Oas2Rule;
|
|
18
|
+
assertions: Oas2Rule;
|
|
19
|
+
'operation-operationId-unique': Oas2Rule;
|
|
20
|
+
'operation-parameters-unique': Oas2Rule;
|
|
21
|
+
'path-parameters-defined': Oas2Rule;
|
|
22
|
+
'operation-tag-defined': Oas2Rule;
|
|
23
|
+
'path-declaration-must-exist': Oas2Rule;
|
|
24
|
+
'operation-operationId-url-safe': Oas2Rule;
|
|
25
|
+
'operation-operationId': Oas2Rule;
|
|
26
|
+
'operation-summary': Oas2Rule;
|
|
27
|
+
'operation-description': Oas2Rule;
|
|
28
|
+
'path-not-include-query': Oas2Rule;
|
|
29
|
+
'path-params-defined': Oas2Rule;
|
|
30
|
+
'parameter-description': Oas2Rule;
|
|
31
|
+
'operation-singular-tag': Oas2Rule;
|
|
32
|
+
'operation-security-defined': Oas2Rule;
|
|
33
|
+
'no-unresolved-refs': Oas2Rule;
|
|
34
|
+
'no-identical-paths': Oas2Rule;
|
|
35
|
+
'no-ambiguous-paths': Oas2Rule;
|
|
36
|
+
'path-http-verbs-order': Oas2Rule;
|
|
37
|
+
'no-http-verbs-in-paths': Oas2Rule;
|
|
38
|
+
'path-excludes-patterns': Oas2Rule;
|
|
39
|
+
'request-mime-type': Oas2Rule;
|
|
40
|
+
'response-mime-type': Oas2Rule;
|
|
41
|
+
'path-segment-plural': Oas2Rule;
|
|
42
|
+
'response-contains-header': Oas2Rule;
|
|
43
|
+
'response-contains-property': Oas2Rule;
|
|
44
|
+
'scalar-property-missing-example': import("../../visitors").Oas3Rule | Oas2Rule;
|
|
45
|
+
};
|
|
46
|
+
export declare const preprocessors: {};
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.preprocessors = exports.rules = void 0;
|
|
4
|
+
const spec_1 = require("../common/spec");
|
|
5
|
+
const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
|
|
6
|
+
const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
|
|
7
|
+
const info_description_1 = require("../common/info-description");
|
|
8
|
+
const info_contact_1 = require("../common/info-contact");
|
|
9
|
+
const info_license_url_1 = require("../common/info-license-url");
|
|
10
|
+
const license_url_1 = require("../common/license-url");
|
|
11
|
+
const boolean_parameter_prefixes_1 = require("./boolean-parameter-prefixes");
|
|
12
|
+
const tag_description_1 = require("../common/tag-description");
|
|
13
|
+
const tags_alphabetical_1 = require("../common/tags-alphabetical");
|
|
14
|
+
const paths_kebab_case_1 = require("../common/paths-kebab-case");
|
|
15
|
+
const no_enum_type_mismatch_1 = require("../common/no-enum-type-mismatch");
|
|
16
|
+
const no_path_trailing_slash_1 = require("../common/no-path-trailing-slash");
|
|
17
|
+
const operation_2xx_response_1 = require("../common/operation-2xx-response");
|
|
18
|
+
const operation_4xx_response_1 = require("../common/operation-4xx-response");
|
|
19
|
+
const assertions_1 = require("../common/assertions");
|
|
20
|
+
const operation_operationId_unique_1 = require("../common/operation-operationId-unique");
|
|
21
|
+
const operation_parameters_unique_1 = require("../common/operation-parameters-unique");
|
|
22
|
+
const path_params_defined_1 = require("../common/path-params-defined");
|
|
23
|
+
const operation_tag_defined_1 = require("../common/operation-tag-defined");
|
|
24
|
+
const path_declaration_must_exist_1 = require("../common/path-declaration-must-exist");
|
|
25
|
+
const operation_operationId_url_safe_1 = require("../common/operation-operationId-url-safe");
|
|
26
|
+
const operation_description_1 = require("../common/operation-description");
|
|
27
|
+
const path_not_include_query_1 = require("../common/path-not-include-query");
|
|
28
|
+
const parameter_description_1 = require("../common/parameter-description");
|
|
29
|
+
const operation_singular_tag_1 = require("../common/operation-singular-tag");
|
|
30
|
+
const operation_security_defined_1 = require("../common/operation-security-defined");
|
|
31
|
+
const no_unresolved_refs_1 = require("../no-unresolved-refs");
|
|
32
|
+
const path_http_verbs_order_1 = require("../common/path-http-verbs-order");
|
|
33
|
+
const no_identical_paths_1 = require("../common/no-identical-paths");
|
|
34
|
+
const operation_operationId_1 = require("../common/operation-operationId");
|
|
35
|
+
const operation_summary_1 = require("../common/operation-summary");
|
|
36
|
+
const no_ambiguous_paths_1 = require("../common/no-ambiguous-paths");
|
|
37
|
+
const no_http_verbs_in_paths_1 = require("../common/no-http-verbs-in-paths");
|
|
38
|
+
const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
|
|
39
|
+
const request_mime_type_1 = require("./request-mime-type");
|
|
40
|
+
const response_mime_type_1 = require("./response-mime-type");
|
|
41
|
+
const path_segment_plural_1 = require("../common/path-segment-plural");
|
|
42
|
+
const response_contains_header_1 = require("../common/response-contains-header");
|
|
43
|
+
const response_contains_property_1 = require("./response-contains-property");
|
|
44
|
+
const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
|
|
45
|
+
exports.rules = {
|
|
46
|
+
spec: spec_1.OasSpec,
|
|
47
|
+
'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
|
|
48
|
+
'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
|
|
49
|
+
'info-description': info_description_1.InfoDescription,
|
|
50
|
+
'info-contact': info_contact_1.InfoContact,
|
|
51
|
+
'info-license': info_license_url_1.InfoLicense,
|
|
52
|
+
'info-license-url': license_url_1.InfoLicenseUrl,
|
|
53
|
+
'tag-description': tag_description_1.TagDescription,
|
|
54
|
+
'tags-alphabetical': tags_alphabetical_1.TagsAlphabetical,
|
|
55
|
+
'paths-kebab-case': paths_kebab_case_1.PathsKebabCase,
|
|
56
|
+
'no-enum-type-mismatch': no_enum_type_mismatch_1.NoEnumTypeMismatch,
|
|
57
|
+
'boolean-parameter-prefixes': boolean_parameter_prefixes_1.BooleanParameterPrefixes,
|
|
58
|
+
'no-path-trailing-slash': no_path_trailing_slash_1.NoPathTrailingSlash,
|
|
59
|
+
'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
|
|
60
|
+
'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
|
|
61
|
+
'assertions': assertions_1.Assertions,
|
|
62
|
+
'operation-operationId-unique': operation_operationId_unique_1.OperationIdUnique,
|
|
63
|
+
'operation-parameters-unique': operation_parameters_unique_1.OperationParametersUnique,
|
|
64
|
+
'path-parameters-defined': path_params_defined_1.PathParamsDefined,
|
|
65
|
+
'operation-tag-defined': operation_tag_defined_1.OperationTagDefined,
|
|
66
|
+
'path-declaration-must-exist': path_declaration_must_exist_1.PathDeclarationMustExist,
|
|
67
|
+
'operation-operationId-url-safe': operation_operationId_url_safe_1.OperationIdUrlSafe,
|
|
68
|
+
'operation-operationId': operation_operationId_1.OperationOperationId,
|
|
69
|
+
'operation-summary': operation_summary_1.OperationSummary,
|
|
70
|
+
'operation-description': operation_description_1.OperationDescription,
|
|
71
|
+
'path-not-include-query': path_not_include_query_1.PathNotIncludeQuery,
|
|
72
|
+
'path-params-defined': path_params_defined_1.PathParamsDefined,
|
|
73
|
+
'parameter-description': parameter_description_1.ParameterDescription,
|
|
74
|
+
'operation-singular-tag': operation_singular_tag_1.OperationSingularTag,
|
|
75
|
+
'operation-security-defined': operation_security_defined_1.OperationSecurityDefined,
|
|
76
|
+
'no-unresolved-refs': no_unresolved_refs_1.NoUnresolvedRefs,
|
|
77
|
+
'no-identical-paths': no_identical_paths_1.NoIdenticalPaths,
|
|
78
|
+
'no-ambiguous-paths': no_ambiguous_paths_1.NoAmbiguousPaths,
|
|
79
|
+
'path-http-verbs-order': path_http_verbs_order_1.PathHttpVerbsOrder,
|
|
80
|
+
'no-http-verbs-in-paths': no_http_verbs_in_paths_1.NoHttpVerbsInPaths,
|
|
81
|
+
'path-excludes-patterns': path_excludes_patterns_1.PathExcludesPatterns,
|
|
82
|
+
'request-mime-type': request_mime_type_1.RequestMimeType,
|
|
83
|
+
'response-mime-type': response_mime_type_1.ResponseMimeType,
|
|
84
|
+
'path-segment-plural': path_segment_plural_1.PathSegmentPlural,
|
|
85
|
+
'response-contains-header': response_contains_header_1.ResponseContainsHeader,
|
|
86
|
+
'response-contains-property': response_contains_property_1.ResponseContainsProperty,
|
|
87
|
+
'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
|
|
88
|
+
};
|
|
89
|
+
exports.preprocessors = {};
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RemoveUnusedComponents = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const RemoveUnusedComponents = () => {
|
|
6
|
+
let components = new Map();
|
|
7
|
+
function registerComponent(location, componentType, name) {
|
|
8
|
+
var _a;
|
|
9
|
+
components.set(location.absolutePointer, {
|
|
10
|
+
used: ((_a = components.get(location.absolutePointer)) === null || _a === void 0 ? void 0 : _a.used) || false,
|
|
11
|
+
componentType,
|
|
12
|
+
name,
|
|
13
|
+
});
|
|
14
|
+
}
|
|
15
|
+
return {
|
|
16
|
+
ref: {
|
|
17
|
+
leave(ref, { type, resolve, key }) {
|
|
18
|
+
if (['Schema', 'Parameter', 'Response', 'SecurityScheme'].includes(type.name)) {
|
|
19
|
+
const resolvedRef = resolve(ref);
|
|
20
|
+
if (!resolvedRef.location)
|
|
21
|
+
return;
|
|
22
|
+
components.set(resolvedRef.location.absolutePointer, {
|
|
23
|
+
used: true,
|
|
24
|
+
name: key.toString(),
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
},
|
|
29
|
+
DefinitionRoot: {
|
|
30
|
+
leave(root, ctx) {
|
|
31
|
+
const data = ctx.getVisitorData();
|
|
32
|
+
data.removedCount = 0;
|
|
33
|
+
let rootComponents = new Set();
|
|
34
|
+
components.forEach(usageInfo => {
|
|
35
|
+
const { used, name, componentType } = usageInfo;
|
|
36
|
+
if (!used && componentType) {
|
|
37
|
+
rootComponents.add(componentType);
|
|
38
|
+
delete root[componentType][name];
|
|
39
|
+
data.removedCount++;
|
|
40
|
+
}
|
|
41
|
+
});
|
|
42
|
+
for (const component of rootComponents) {
|
|
43
|
+
if (utils_1.isEmptyObject(root[component])) {
|
|
44
|
+
delete root[component];
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
},
|
|
49
|
+
NamedSchemas: {
|
|
50
|
+
Schema(schema, { location, key }) {
|
|
51
|
+
if (!schema.allOf) {
|
|
52
|
+
registerComponent(location, 'definitions', key.toString());
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
},
|
|
56
|
+
NamedParameters: {
|
|
57
|
+
Parameter(_parameter, { location, key }) {
|
|
58
|
+
registerComponent(location, 'parameters', key.toString());
|
|
59
|
+
},
|
|
60
|
+
},
|
|
61
|
+
NamedResponses: {
|
|
62
|
+
Response(_response, { location, key }) {
|
|
63
|
+
registerComponent(location, 'responses', key.toString());
|
|
64
|
+
},
|
|
65
|
+
},
|
|
66
|
+
NamedSecuritySchemes: {
|
|
67
|
+
SecurityScheme(_securityScheme, { location, key }) {
|
|
68
|
+
registerComponent(location, 'securityDefinitions', key.toString());
|
|
69
|
+
},
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
exports.RemoveUnusedComponents = RemoveUnusedComponents;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RequestMimeType = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const RequestMimeType = ({ allowedValues }) => {
|
|
6
|
+
return {
|
|
7
|
+
DefinitionRoot(root, ctx) {
|
|
8
|
+
utils_1.validateMimeType({ type: 'consumes', value: root }, ctx, allowedValues);
|
|
9
|
+
},
|
|
10
|
+
Operation: {
|
|
11
|
+
leave(operation, ctx) {
|
|
12
|
+
utils_1.validateMimeType({ type: 'consumes', value: operation }, ctx, allowedValues);
|
|
13
|
+
},
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.RequestMimeType = RequestMimeType;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ResponseContainsProperty = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const ResponseContainsProperty = (options) => {
|
|
6
|
+
const names = options.names || {};
|
|
7
|
+
let key;
|
|
8
|
+
return {
|
|
9
|
+
Operation: {
|
|
10
|
+
Response: {
|
|
11
|
+
skip: (_response, key) => {
|
|
12
|
+
return `${key}` === '204';
|
|
13
|
+
},
|
|
14
|
+
enter: (_response, ctx) => {
|
|
15
|
+
key = ctx.key;
|
|
16
|
+
},
|
|
17
|
+
Schema(schema, { report, location }) {
|
|
18
|
+
var _a;
|
|
19
|
+
if (schema.type !== 'object')
|
|
20
|
+
return;
|
|
21
|
+
const expectedProperties = names[key] ||
|
|
22
|
+
names[utils_1.getMatchingStatusCodeRange(key)] ||
|
|
23
|
+
names[utils_1.getMatchingStatusCodeRange(key).toLowerCase()] ||
|
|
24
|
+
[];
|
|
25
|
+
for (const expectedProperty of expectedProperties) {
|
|
26
|
+
if (!((_a = schema.properties) === null || _a === void 0 ? void 0 : _a[expectedProperty])) {
|
|
27
|
+
report({
|
|
28
|
+
message: `Response object must contain a top-level "${expectedProperty}" property.`,
|
|
29
|
+
location: location.child('properties').key(),
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
exports.ResponseContainsProperty = ResponseContainsProperty;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ResponseMimeType = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const ResponseMimeType = ({ allowedValues }) => {
|
|
6
|
+
return {
|
|
7
|
+
DefinitionRoot(root, ctx) {
|
|
8
|
+
utils_1.validateMimeType({ type: 'produces', value: root }, ctx, allowedValues);
|
|
9
|
+
},
|
|
10
|
+
Operation: {
|
|
11
|
+
leave(operation, ctx) {
|
|
12
|
+
utils_1.validateMimeType({ type: 'produces', value: operation }, ctx, allowedValues);
|
|
13
|
+
},
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.ResponseMimeType = ResponseMimeType;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.BooleanParameterPrefixes = void 0;
|
|
4
|
+
const BooleanParameterPrefixes = (options) => {
|
|
5
|
+
const prefixes = options.prefixes || ['is', 'has'];
|
|
6
|
+
const regexp = new RegExp(`^(${prefixes.join('|')})[A-Z-_]`);
|
|
7
|
+
const wrappedPrefixes = prefixes.map((p) => `\`${p}\``);
|
|
8
|
+
const prefixesString = wrappedPrefixes.length === 1
|
|
9
|
+
? wrappedPrefixes[0]
|
|
10
|
+
: wrappedPrefixes.slice(0, -1).join(', ') + ' or ' + wrappedPrefixes[prefixes.length - 1];
|
|
11
|
+
return {
|
|
12
|
+
Parameter: {
|
|
13
|
+
Schema(schema, { report, parentLocations }, parents) {
|
|
14
|
+
if (schema.type === 'boolean' && !regexp.test(parents.Parameter.name)) {
|
|
15
|
+
report({
|
|
16
|
+
message: `Boolean parameter \`${parents.Parameter.name}\` should have ${prefixesString} prefix.`,
|
|
17
|
+
location: parentLocations.Parameter.child(['name']),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
},
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
exports.BooleanParameterPrefixes = BooleanParameterPrefixes;
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.preprocessors = exports.rules = void 0;
|
|
4
|
+
const spec_1 = require("../common/spec");
|
|
5
|
+
const operation_2xx_response_1 = require("../common/operation-2xx-response");
|
|
6
|
+
const operation_4xx_response_1 = require("../common/operation-4xx-response");
|
|
7
|
+
const assertions_1 = require("../common/assertions");
|
|
8
|
+
const operation_operationId_unique_1 = require("../common/operation-operationId-unique");
|
|
9
|
+
const operation_parameters_unique_1 = require("../common/operation-parameters-unique");
|
|
10
|
+
const path_params_defined_1 = require("../common/path-params-defined");
|
|
11
|
+
const operation_tag_defined_1 = require("../common/operation-tag-defined");
|
|
12
|
+
const no_example_value_and_externalValue_1 = require("./no-example-value-and-externalValue");
|
|
13
|
+
const no_enum_type_mismatch_1 = require("../common/no-enum-type-mismatch");
|
|
14
|
+
const no_path_trailing_slash_1 = require("../common/no-path-trailing-slash");
|
|
15
|
+
const path_declaration_must_exist_1 = require("../common/path-declaration-must-exist");
|
|
16
|
+
const operation_operationId_url_safe_1 = require("../common/operation-operationId-url-safe");
|
|
17
|
+
const tags_alphabetical_1 = require("../common/tags-alphabetical");
|
|
18
|
+
const no_server_example_com_1 = require("./no-server-example.com");
|
|
19
|
+
const no_server_trailing_slash_1 = require("./no-server-trailing-slash");
|
|
20
|
+
const info_description_1 = require("../common/info-description");
|
|
21
|
+
const tag_description_1 = require("../common/tag-description");
|
|
22
|
+
const info_contact_1 = require("../common/info-contact");
|
|
23
|
+
const info_license_url_1 = require("../common/info-license-url");
|
|
24
|
+
const operation_description_1 = require("../common/operation-description");
|
|
25
|
+
const no_unused_components_1 = require("./no-unused-components");
|
|
26
|
+
const path_not_include_query_1 = require("../common/path-not-include-query");
|
|
27
|
+
const parameter_description_1 = require("../common/parameter-description");
|
|
28
|
+
const operation_singular_tag_1 = require("../common/operation-singular-tag");
|
|
29
|
+
const license_url_1 = require("../common/license-url");
|
|
30
|
+
const operation_security_defined_1 = require("../common/operation-security-defined");
|
|
31
|
+
const no_unresolved_refs_1 = require("../no-unresolved-refs");
|
|
32
|
+
const boolean_parameter_prefixes_1 = require("./boolean-parameter-prefixes");
|
|
33
|
+
const paths_kebab_case_1 = require("../common/paths-kebab-case");
|
|
34
|
+
const path_http_verbs_order_1 = require("../common/path-http-verbs-order");
|
|
35
|
+
const no_empty_servers_1 = require("./no-empty-servers");
|
|
36
|
+
const no_invalid_media_type_examples_1 = require("./no-invalid-media-type-examples");
|
|
37
|
+
const no_identical_paths_1 = require("../common/no-identical-paths");
|
|
38
|
+
const no_undefined_server_variable_1 = require("./no-undefined-server-variable");
|
|
39
|
+
const operation_operationId_1 = require("../common/operation-operationId");
|
|
40
|
+
const operation_summary_1 = require("../common/operation-summary");
|
|
41
|
+
const no_ambiguous_paths_1 = require("../common/no-ambiguous-paths");
|
|
42
|
+
const no_servers_empty_enum_1 = require("./no-servers-empty-enum");
|
|
43
|
+
const no_http_verbs_in_paths_1 = require("../common/no-http-verbs-in-paths");
|
|
44
|
+
const request_mime_type_1 = require("./request-mime-type");
|
|
45
|
+
const response_mime_type_1 = require("./response-mime-type");
|
|
46
|
+
const path_segment_plural_1 = require("../common/path-segment-plural");
|
|
47
|
+
const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
|
|
48
|
+
const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
|
|
49
|
+
const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
|
|
50
|
+
const response_contains_header_1 = require("../common/response-contains-header");
|
|
51
|
+
const response_contains_property_1 = require("./response-contains-property");
|
|
52
|
+
const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
|
|
53
|
+
exports.rules = {
|
|
54
|
+
spec: spec_1.OasSpec,
|
|
55
|
+
'info-description': info_description_1.InfoDescription,
|
|
56
|
+
'info-contact': info_contact_1.InfoContact,
|
|
57
|
+
'info-license': info_license_url_1.InfoLicense,
|
|
58
|
+
'info-license-url': license_url_1.InfoLicenseUrl,
|
|
59
|
+
'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
|
|
60
|
+
'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
|
|
61
|
+
'assertions': assertions_1.Assertions,
|
|
62
|
+
'operation-operationId-unique': operation_operationId_unique_1.OperationIdUnique,
|
|
63
|
+
'operation-parameters-unique': operation_parameters_unique_1.OperationParametersUnique,
|
|
64
|
+
'path-parameters-defined': path_params_defined_1.PathParamsDefined,
|
|
65
|
+
'operation-tag-defined': operation_tag_defined_1.OperationTagDefined,
|
|
66
|
+
'no-example-value-and-externalValue': no_example_value_and_externalValue_1.NoExampleValueAndExternalValue,
|
|
67
|
+
'no-enum-type-mismatch': no_enum_type_mismatch_1.NoEnumTypeMismatch,
|
|
68
|
+
'no-path-trailing-slash': no_path_trailing_slash_1.NoPathTrailingSlash,
|
|
69
|
+
'no-empty-servers': no_empty_servers_1.NoEmptyServers,
|
|
70
|
+
'path-declaration-must-exist': path_declaration_must_exist_1.PathDeclarationMustExist,
|
|
71
|
+
'operation-operationId-url-safe': operation_operationId_url_safe_1.OperationIdUrlSafe,
|
|
72
|
+
'operation-operationId': operation_operationId_1.OperationOperationId,
|
|
73
|
+
'operation-summary': operation_summary_1.OperationSummary,
|
|
74
|
+
'tags-alphabetical': tags_alphabetical_1.TagsAlphabetical,
|
|
75
|
+
'no-server-example.com': no_server_example_com_1.NoServerExample,
|
|
76
|
+
'no-server-trailing-slash': no_server_trailing_slash_1.NoServerTrailingSlash,
|
|
77
|
+
'tag-description': tag_description_1.TagDescription,
|
|
78
|
+
'operation-description': operation_description_1.OperationDescription,
|
|
79
|
+
'no-unused-components': no_unused_components_1.NoUnusedComponents,
|
|
80
|
+
'path-not-include-query': path_not_include_query_1.PathNotIncludeQuery,
|
|
81
|
+
'path-params-defined': path_params_defined_1.PathParamsDefined,
|
|
82
|
+
'parameter-description': parameter_description_1.ParameterDescription,
|
|
83
|
+
'operation-singular-tag': operation_singular_tag_1.OperationSingularTag,
|
|
84
|
+
'operation-security-defined': operation_security_defined_1.OperationSecurityDefined,
|
|
85
|
+
'no-unresolved-refs': no_unresolved_refs_1.NoUnresolvedRefs,
|
|
86
|
+
'paths-kebab-case': paths_kebab_case_1.PathsKebabCase,
|
|
87
|
+
'boolean-parameter-prefixes': boolean_parameter_prefixes_1.BooleanParameterPrefixes,
|
|
88
|
+
'path-http-verbs-order': path_http_verbs_order_1.PathHttpVerbsOrder,
|
|
89
|
+
'no-invalid-media-type-examples': no_invalid_media_type_examples_1.ValidContentExamples,
|
|
90
|
+
'no-identical-paths': no_identical_paths_1.NoIdenticalPaths,
|
|
91
|
+
'no-ambiguous-paths': no_ambiguous_paths_1.NoAmbiguousPaths,
|
|
92
|
+
'no-undefined-server-variable': no_undefined_server_variable_1.NoUndefinedServerVariable,
|
|
93
|
+
'no-servers-empty-enum': no_servers_empty_enum_1.NoEmptyEnumServers,
|
|
94
|
+
'no-http-verbs-in-paths': no_http_verbs_in_paths_1.NoHttpVerbsInPaths,
|
|
95
|
+
'path-excludes-patterns': path_excludes_patterns_1.PathExcludesPatterns,
|
|
96
|
+
'request-mime-type': request_mime_type_1.RequestMimeType,
|
|
97
|
+
'response-mime-type': response_mime_type_1.ResponseMimeType,
|
|
98
|
+
'path-segment-plural': path_segment_plural_1.PathSegmentPlural,
|
|
99
|
+
'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
|
|
100
|
+
'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
|
|
101
|
+
'response-contains-header': response_contains_header_1.ResponseContainsHeader,
|
|
102
|
+
'response-contains-property': response_contains_property_1.ResponseContainsProperty,
|
|
103
|
+
'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
|
|
104
|
+
};
|
|
105
|
+
exports.preprocessors = {};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoEmptyServers = void 0;
|
|
4
|
+
const NoEmptyServers = () => {
|
|
5
|
+
return {
|
|
6
|
+
DefinitionRoot(root, { report, location }) {
|
|
7
|
+
if (!root.hasOwnProperty('servers')) {
|
|
8
|
+
report({
|
|
9
|
+
message: 'Servers must be present.',
|
|
10
|
+
location: location.child(['openapi']).key()
|
|
11
|
+
});
|
|
12
|
+
return;
|
|
13
|
+
}
|
|
14
|
+
if (!Array.isArray(root.servers) || root.servers.length === 0) {
|
|
15
|
+
report({
|
|
16
|
+
message: 'Servers must be a non-empty array.',
|
|
17
|
+
location: location.child(['servers']).key(),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
exports.NoEmptyServers = NoEmptyServers;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoExampleValueAndExternalValue = void 0;
|
|
4
|
+
const NoExampleValueAndExternalValue = () => {
|
|
5
|
+
return {
|
|
6
|
+
Example(example, { report, location }) {
|
|
7
|
+
if (example.value && example.externalValue) {
|
|
8
|
+
report({
|
|
9
|
+
message: 'Example object can have either `value` or `externalValue` fields.',
|
|
10
|
+
location: location.child(['value']).key(),
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.NoExampleValueAndExternalValue = NoExampleValueAndExternalValue;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ValidContentExamples = void 0;
|
|
4
|
+
const ref_utils_1 = require("../../ref-utils");
|
|
5
|
+
const utils_1 = require("../utils");
|
|
6
|
+
const ValidContentExamples = (opts) => {
|
|
7
|
+
var _a;
|
|
8
|
+
const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
|
|
9
|
+
return {
|
|
10
|
+
MediaType: {
|
|
11
|
+
leave(mediaType, ctx) {
|
|
12
|
+
const { location, resolve } = ctx;
|
|
13
|
+
if (!mediaType.schema)
|
|
14
|
+
return;
|
|
15
|
+
if (mediaType.example) {
|
|
16
|
+
resolveAndValidateExample(mediaType.example, location.child('example'));
|
|
17
|
+
}
|
|
18
|
+
else if (mediaType.examples) {
|
|
19
|
+
for (const exampleName of Object.keys(mediaType.examples)) {
|
|
20
|
+
resolveAndValidateExample(mediaType.examples[exampleName], location.child(['examples', exampleName, 'value']), true);
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
function resolveAndValidateExample(example, location, isMultiple) {
|
|
24
|
+
if (ref_utils_1.isRef(example)) {
|
|
25
|
+
const resolved = resolve(example);
|
|
26
|
+
if (!resolved.location)
|
|
27
|
+
return;
|
|
28
|
+
location = isMultiple ? resolved.location.child('value') : resolved.location;
|
|
29
|
+
example = resolved.node;
|
|
30
|
+
}
|
|
31
|
+
utils_1.validateExample(isMultiple ? example.value : example, mediaType.schema, location, ctx, disallowAdditionalProperties);
|
|
32
|
+
}
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
exports.ValidContentExamples = ValidContentExamples;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.NoServerExample = void 0;
|
|
4
|
+
const NoServerExample = () => {
|
|
5
|
+
return {
|
|
6
|
+
Server(server, { report, location }) {
|
|
7
|
+
if (['example.com', 'localhost'].indexOf(server.url) !== -1) {
|
|
8
|
+
report({
|
|
9
|
+
message: 'Server `url` should not point at example.com.',
|
|
10
|
+
location: location.child(['url']),
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
};
|
|
16
|
+
exports.NoServerExample = NoServerExample;
|