@redocly/openapi-core 0.0.0-snapshot.1737554067
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 +268 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.d.ts +4 -0
- package/lib/benchmark/benches/lint-with-many-rules.bench.js +38 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.d.ts +4 -0
- package/lib/benchmark/benches/lint-with-nested-rule.bench.js +44 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.d.ts +4 -0
- package/lib/benchmark/benches/lint-with-no-rules.bench.js +25 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.d.ts +4 -0
- package/lib/benchmark/benches/lint-with-top-level-rule-report.bench.js +37 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.d.ts +4 -0
- package/lib/benchmark/benches/lint-with-top-level-rule.bench.js +36 -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 +34 -0
- package/lib/bundle.d.ts +50 -0
- package/lib/bundle.js +385 -0
- package/lib/config/all.d.ts +3 -0
- package/lib/config/all.js +227 -0
- package/lib/config/builtIn.d.ts +3 -0
- package/lib/config/builtIn.js +53 -0
- package/lib/config/config-resolvers.d.ts +30 -0
- package/lib/config/config-resolvers.js +447 -0
- package/lib/config/config.d.ts +53 -0
- package/lib/config/config.js +320 -0
- package/lib/config/index.d.ts +7 -0
- package/lib/config/index.js +23 -0
- package/lib/config/load.d.ts +38 -0
- package/lib/config/load.js +140 -0
- package/lib/config/minimal.d.ts +3 -0
- package/lib/config/minimal.js +203 -0
- package/lib/config/recommended-strict.d.ts +3 -0
- package/lib/config/recommended-strict.js +203 -0
- package/lib/config/recommended.d.ts +3 -0
- package/lib/config/recommended.js +203 -0
- package/lib/config/rules.d.ts +10 -0
- package/lib/config/rules.js +37 -0
- package/lib/config/spec.d.ts +3 -0
- package/lib/config/spec.js +29 -0
- package/lib/config/types.d.ts +189 -0
- package/lib/config/types.js +2 -0
- package/lib/config/utils.d.ts +19 -0
- package/lib/config/utils.js +308 -0
- package/lib/decorators/arazzo/index.d.ts +1 -0
- package/lib/decorators/arazzo/index.js +4 -0
- package/lib/decorators/async2/index.d.ts +1 -0
- package/lib/decorators/async2/index.js +4 -0
- package/lib/decorators/async3/index.d.ts +1 -0
- package/lib/decorators/async3/index.js +4 -0
- package/lib/decorators/common/filters/filter-helper.d.ts +3 -0
- package/lib/decorators/common/filters/filter-helper.js +66 -0
- package/lib/decorators/common/filters/filter-in.d.ts +2 -0
- package/lib/decorators/common/filters/filter-in.js +17 -0
- package/lib/decorators/common/filters/filter-out.d.ts +2 -0
- package/lib/decorators/common/filters/filter-out.js +17 -0
- package/lib/decorators/common/info-description-override.d.ts +2 -0
- package/lib/decorators/common/info-description-override.js +24 -0
- package/lib/decorators/common/info-override.d.ts +2 -0
- package/lib/decorators/common/info-override.js +17 -0
- package/lib/decorators/common/media-type-examples-override.d.ts +2 -0
- package/lib/decorators/common/media-type-examples-override.js +59 -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 +69 -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 +11 -0
- package/lib/decorators/oas2/index.js +21 -0
- package/lib/decorators/oas2/remove-unused-components.d.ts +2 -0
- package/lib/decorators/oas2/remove-unused-components.js +89 -0
- package/lib/decorators/oas3/index.d.ts +12 -0
- package/lib/decorators/oas3/index.js +23 -0
- package/lib/decorators/oas3/remove-unused-components.d.ts +2 -0
- package/lib/decorators/oas3/remove-unused-components.js +100 -0
- package/lib/env.d.ts +2 -0
- package/lib/env.js +7 -0
- package/lib/format/codeframes.d.ts +22 -0
- package/lib/format/codeframes.js +185 -0
- package/lib/format/format.d.ts +20 -0
- package/lib/format/format.js +365 -0
- package/lib/index.d.ts +26 -0
- package/lib/index.js +98 -0
- package/lib/js-yaml/index.d.ts +3 -0
- package/lib/js-yaml/index.js +15 -0
- package/lib/lint.d.ts +32 -0
- package/lib/lint.js +118 -0
- package/lib/logger.d.ts +10 -0
- package/lib/logger.js +31 -0
- package/lib/oas-types.d.ts +36 -0
- package/lib/oas-types.js +92 -0
- package/lib/output.d.ts +3 -0
- package/lib/output.js +9 -0
- package/lib/redocly/domains.d.ts +14 -0
- package/lib/redocly/domains.js +41 -0
- package/lib/redocly/index.d.ts +30 -0
- package/lib/redocly/index.js +131 -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 +96 -0
- package/lib/ref-utils.d.ts +27 -0
- package/lib/ref-utils.js +85 -0
- package/lib/resolve.d.ts +66 -0
- package/lib/resolve.js +342 -0
- package/lib/rules/ajv.d.ts +10 -0
- package/lib/rules/ajv.js +82 -0
- package/lib/rules/arazzo/criteria-unique.d.ts +2 -0
- package/lib/rules/arazzo/criteria-unique.js +71 -0
- package/lib/rules/arazzo/index.d.ts +3 -0
- package/lib/rules/arazzo/index.js +36 -0
- package/lib/rules/arazzo/parameters-unique.d.ts +2 -0
- package/lib/rules/arazzo/parameters-unique.js +32 -0
- package/lib/rules/arazzo/requestBody-replacements-unique.d.ts +2 -0
- package/lib/rules/arazzo/requestBody-replacements-unique.js +28 -0
- package/lib/rules/arazzo/sourceDescription-type.d.ts +2 -0
- package/lib/rules/arazzo/sourceDescription-type.js +22 -0
- package/lib/rules/arazzo/sourceDescriptions-name-unique.d.ts +2 -0
- package/lib/rules/arazzo/sourceDescriptions-name-unique.js +24 -0
- package/lib/rules/arazzo/sourceDescriptions-not-empty.d.ts +2 -0
- package/lib/rules/arazzo/sourceDescriptions-not-empty.js +18 -0
- package/lib/rules/arazzo/step-onFailure-unique.d.ts +2 -0
- package/lib/rules/arazzo/step-onFailure-unique.js +32 -0
- package/lib/rules/arazzo/step-onSuccess-unique.d.ts +2 -0
- package/lib/rules/arazzo/step-onSuccess-unique.js +32 -0
- package/lib/rules/arazzo/stepId-unique.d.ts +2 -0
- package/lib/rules/arazzo/stepId-unique.js +26 -0
- package/lib/rules/arazzo/workflow-dependsOn.d.ts +2 -0
- package/lib/rules/arazzo/workflow-dependsOn.js +56 -0
- package/lib/rules/arazzo/workflowId-unique.d.ts +2 -0
- package/lib/rules/arazzo/workflowId-unique.js +22 -0
- package/lib/rules/async2/channels-kebab-case.d.ts +2 -0
- package/lib/rules/async2/channels-kebab-case.js +19 -0
- package/lib/rules/async2/index.d.ts +3 -0
- package/lib/rules/async2/index.js +27 -0
- package/lib/rules/async2/no-channel-trailing-slash.d.ts +2 -0
- package/lib/rules/async2/no-channel-trailing-slash.js +16 -0
- package/lib/rules/async3/channels-kebab-case.d.ts +2 -0
- package/lib/rules/async3/channels-kebab-case.js +19 -0
- package/lib/rules/async3/index.d.ts +3 -0
- package/lib/rules/async3/index.js +27 -0
- package/lib/rules/async3/no-channel-trailing-slash.d.ts +2 -0
- package/lib/rules/async3/no-channel-trailing-slash.js +16 -0
- package/lib/rules/common/assertions/asserts.d.ts +30 -0
- package/lib/rules/common/assertions/asserts.js +281 -0
- package/lib/rules/common/assertions/index.d.ts +27 -0
- package/lib/rules/common/assertions/index.js +24 -0
- package/lib/rules/common/assertions/utils.d.ts +28 -0
- package/lib/rules/common/assertions/utils.js +226 -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-license-strict.d.ts +2 -0
- package/lib/rules/common/info-license-strict.js +26 -0
- package/lib/rules/common/info-license-url.d.ts +2 -0
- package/lib/rules/common/info-license-url.js +12 -0
- package/lib/rules/common/info-license.d.ts +2 -0
- package/lib/rules/common/info-license.js +17 -0
- package/lib/rules/common/no-ambiguous-paths.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 +41 -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 +24 -0
- package/lib/rules/common/no-invalid-schema-examples.d.ts +1 -0
- package/lib/rules/common/no-invalid-schema-examples.js +22 -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/no-required-schema-properties-undefined.d.ts +2 -0
- package/lib/rules/common/no-required-schema-properties-undefined.js +36 -0
- package/lib/rules/common/operation-2xx-response.d.ts +2 -0
- package/lib/rules/common/operation-2xx-response.js +23 -0
- package/lib/rules/common/operation-4xx-response.d.ts +2 -0
- package/lib/rules/common/operation-4xx-response.js +23 -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 +18 -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-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 +24 -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 +58 -0
- package/lib/rules/common/path-segment-plural.d.ts +2 -0
- package/lib/rules/common/path-segment-plural.js +33 -0
- package/lib/rules/common/paths-kebab-case.d.ts +2 -0
- package/lib/rules/common/paths-kebab-case.js +20 -0
- package/lib/rules/common/required-string-property-missing-min-length.d.ts +2 -0
- package/lib/rules/common/required-string-property-missing-min-length.js +37 -0
- package/lib/rules/common/response-contains-header.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/security-defined.d.ts +2 -0
- package/lib/rules/common/security-defined.js +65 -0
- package/lib/rules/common/spec-strict-refs.d.ts +2 -0
- package/lib/rules/common/spec-strict-refs.js +30 -0
- package/lib/rules/common/struct.d.ts +2 -0
- package/lib/rules/common/struct.js +158 -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 +23 -0
- package/lib/rules/no-unresolved-refs.d.ts +5 -0
- package/lib/rules/no-unresolved-refs.js +46 -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 +3 -0
- package/lib/rules/oas2/index.js +98 -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 +37 -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/array-parameter-serialization.d.ts +5 -0
- package/lib/rules/oas3/array-parameter-serialization.js +29 -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/component-name-unique.d.ts +2 -0
- package/lib/rules/oas3/component-name-unique.js +133 -0
- package/lib/rules/oas3/index.d.ts +3 -0
- package/lib/rules/oas3/index.js +122 -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 +39 -0
- package/lib/rules/oas3/no-server-example.com.d.ts +2 -0
- package/lib/rules/oas3/no-server-example.com.js +18 -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-server-variables-empty-enum.d.ts +2 -0
- package/lib/rules/oas3/no-server-variables-empty-enum.js +66 -0
- package/lib/rules/oas3/no-undefined-server-variable.d.ts +2 -0
- package/lib/rules/oas3/no-undefined-server-variable.js +31 -0
- package/lib/rules/oas3/no-unused-components.d.ts +2 -0
- package/lib/rules/oas3/no-unused-components.js +73 -0
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts +5 -0
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js +36 -0
- package/lib/rules/oas3/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 +39 -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/oas3/spec-components-invalid-map-name.d.ts +2 -0
- package/lib/rules/oas3/spec-components-invalid-map-name.js +62 -0
- package/lib/rules/other/stats.d.ts +41 -0
- package/lib/rules/other/stats.js +75 -0
- package/lib/rules/spot/no-criteria-xpath.d.ts +2 -0
- package/lib/rules/spot/no-criteria-xpath.js +21 -0
- package/lib/rules/spot/spot-supported-versions.d.ts +2 -0
- package/lib/rules/spot/spot-supported-versions.js +21 -0
- package/lib/rules/utils.d.ts +22 -0
- package/lib/rules/utils.js +183 -0
- package/lib/types/arazzo.d.ts +2 -0
- package/lib/types/arazzo.js +311 -0
- package/lib/types/asyncapi2.d.ts +17 -0
- package/lib/types/asyncapi2.js +1008 -0
- package/lib/types/asyncapi3.d.ts +2 -0
- package/lib/types/asyncapi3.js +347 -0
- package/lib/types/index.d.ts +57 -0
- package/lib/types/index.js +94 -0
- package/lib/types/json-schema-adapter.d.ts +3 -0
- package/lib/types/json-schema-adapter.js +159 -0
- package/lib/types/oas2.d.ts +3 -0
- package/lib/types/oas2.js +456 -0
- package/lib/types/oas3.d.ts +7 -0
- package/lib/types/oas3.js +554 -0
- package/lib/types/oas3_1.d.ts +6 -0
- package/lib/types/oas3_1.js +285 -0
- package/lib/types/redocly-yaml.d.ts +26 -0
- package/lib/types/redocly-yaml.js +1126 -0
- package/lib/typings/arazzo.d.ts +131 -0
- package/lib/typings/arazzo.js +5 -0
- package/lib/typings/asyncapi.d.ts +21 -0
- package/lib/typings/asyncapi.js +2 -0
- package/lib/typings/asyncapi3.d.ts +53 -0
- package/lib/typings/asyncapi3.js +2 -0
- package/lib/typings/common.d.ts +8 -0
- package/lib/typings/common.js +2 -0
- package/lib/typings/openapi.d.ts +355 -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 +70 -0
- package/lib/utils.js +301 -0
- package/lib/visitors.d.ts +229 -0
- package/lib/visitors.js +176 -0
- package/lib/walk.d.ts +78 -0
- package/lib/walk.js +290 -0
- package/package.json +59 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.FilterOut = void 0;
|
|
4
|
+
const filter_helper_1 = require("./filter-helper");
|
|
5
|
+
const DEFAULT_STRATEGY = 'any';
|
|
6
|
+
const FilterOut = ({ property, value, matchStrategy }) => {
|
|
7
|
+
const strategy = matchStrategy || DEFAULT_STRATEGY;
|
|
8
|
+
const filterOutCriteria = (item) => (0, filter_helper_1.checkIfMatchByStrategy)(item?.[property], value, strategy);
|
|
9
|
+
return {
|
|
10
|
+
any: {
|
|
11
|
+
enter: (node, ctx) => {
|
|
12
|
+
(0, filter_helper_1.filter)(node, ctx, filterOutCriteria);
|
|
13
|
+
},
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.FilterOut = FilterOut;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InfoDescriptionOverride = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const InfoDescriptionOverride = ({ filePath }) => {
|
|
6
|
+
return {
|
|
7
|
+
Info: {
|
|
8
|
+
leave(info, { report, location }) {
|
|
9
|
+
if (!filePath)
|
|
10
|
+
throw new Error(`Parameter "filePath" is not provided for "info-description-override" rule`);
|
|
11
|
+
try {
|
|
12
|
+
info.description = (0, utils_1.readFileAsStringSync)(filePath);
|
|
13
|
+
}
|
|
14
|
+
catch (e) {
|
|
15
|
+
report({
|
|
16
|
+
message: `Failed to read markdown override file for "info.description".\n${e.message}`,
|
|
17
|
+
location: location.child('description'),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
},
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
exports.InfoDescriptionOverride = InfoDescriptionOverride;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.InfoOverride = void 0;
|
|
4
|
+
const InfoOverride = (newInfo) => {
|
|
5
|
+
return {
|
|
6
|
+
Info: {
|
|
7
|
+
leave(info) {
|
|
8
|
+
if (typeof newInfo !== 'object' || Array.isArray(newInfo) || newInfo === null) {
|
|
9
|
+
throw new Error(`"info-override" decorator should be called with an object`);
|
|
10
|
+
}
|
|
11
|
+
const { severity: _, ...rest } = newInfo;
|
|
12
|
+
Object.assign(info, rest);
|
|
13
|
+
},
|
|
14
|
+
},
|
|
15
|
+
};
|
|
16
|
+
};
|
|
17
|
+
exports.InfoOverride = InfoOverride;
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MediaTypeExamplesOverride = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const ref_utils_1 = require("../../ref-utils");
|
|
6
|
+
const MediaTypeExamplesOverride = ({ operationIds }) => {
|
|
7
|
+
return {
|
|
8
|
+
Operation: {
|
|
9
|
+
enter(operation, ctx) {
|
|
10
|
+
const operationId = operation.operationId;
|
|
11
|
+
if (!operationId) {
|
|
12
|
+
return;
|
|
13
|
+
}
|
|
14
|
+
const properties = operationIds[operationId];
|
|
15
|
+
if (!properties) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
if (properties.responses && operation.responses) {
|
|
19
|
+
for (const responseCode of Object.keys(properties.responses)) {
|
|
20
|
+
const resolvedResponse = checkAndResolveRef(operation.responses[responseCode], ctx.resolve);
|
|
21
|
+
if (!resolvedResponse) {
|
|
22
|
+
continue;
|
|
23
|
+
}
|
|
24
|
+
resolvedResponse.content = resolvedResponse.content ? resolvedResponse.content : {};
|
|
25
|
+
Object.keys(properties.responses[responseCode]).forEach((mimeType) => {
|
|
26
|
+
resolvedResponse.content[mimeType] = {
|
|
27
|
+
...resolvedResponse.content[mimeType],
|
|
28
|
+
examples: (0, utils_1.yamlAndJsonSyncReader)(properties.responses[responseCode][mimeType]),
|
|
29
|
+
};
|
|
30
|
+
});
|
|
31
|
+
operation.responses[responseCode] = resolvedResponse;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
if (properties.request && operation.requestBody) {
|
|
35
|
+
const resolvedRequest = checkAndResolveRef(operation.requestBody, ctx.resolve);
|
|
36
|
+
if (!resolvedRequest) {
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
resolvedRequest.content = resolvedRequest.content ? resolvedRequest.content : {};
|
|
40
|
+
Object.keys(properties.request).forEach((mimeType) => {
|
|
41
|
+
resolvedRequest.content[mimeType] = {
|
|
42
|
+
...resolvedRequest.content[mimeType],
|
|
43
|
+
examples: (0, utils_1.yamlAndJsonSyncReader)(properties.request[mimeType]),
|
|
44
|
+
};
|
|
45
|
+
});
|
|
46
|
+
operation.requestBody = resolvedRequest;
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
},
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
exports.MediaTypeExamplesOverride = MediaTypeExamplesOverride;
|
|
53
|
+
function checkAndResolveRef(node, resolver) {
|
|
54
|
+
if (!(0, ref_utils_1.isRef)(node)) {
|
|
55
|
+
return node;
|
|
56
|
+
}
|
|
57
|
+
const resolved = resolver(node);
|
|
58
|
+
return resolved.error ? undefined : JSON.parse(JSON.stringify(resolved.node));
|
|
59
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OperationDescriptionOverride = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const OperationDescriptionOverride = ({ operationIds }) => {
|
|
6
|
+
return {
|
|
7
|
+
Operation: {
|
|
8
|
+
leave(operation, { report, location }) {
|
|
9
|
+
if (!operation.operationId)
|
|
10
|
+
return;
|
|
11
|
+
if (!operationIds)
|
|
12
|
+
throw new Error(`Parameter "operationIds" is not provided for "operation-description-override" rule`);
|
|
13
|
+
const operationId = operation.operationId;
|
|
14
|
+
if (operationIds[operationId]) {
|
|
15
|
+
try {
|
|
16
|
+
operation.description = (0, utils_1.readFileAsStringSync)(operationIds[operationId]);
|
|
17
|
+
}
|
|
18
|
+
catch (e) {
|
|
19
|
+
report({
|
|
20
|
+
message: `Failed to read markdown override file for operation "${operationId}".\n${e.message}`,
|
|
21
|
+
location: location.child('operationId').key(),
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
},
|
|
26
|
+
},
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
exports.OperationDescriptionOverride = OperationDescriptionOverride;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RegistryDependencies = void 0;
|
|
4
|
+
const domains_1 = require("../../redocly/domains");
|
|
5
|
+
const RegistryDependencies = () => {
|
|
6
|
+
const registryDependencies = new Set();
|
|
7
|
+
return {
|
|
8
|
+
Root: {
|
|
9
|
+
leave(_, ctx) {
|
|
10
|
+
const data = ctx.getVisitorData();
|
|
11
|
+
data.links = Array.from(registryDependencies);
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
ref(node) {
|
|
15
|
+
if (node.$ref) {
|
|
16
|
+
const link = node.$ref.split('#/')[0];
|
|
17
|
+
if ((0, domains_1.isRedoclyRegistryURL)(link)) {
|
|
18
|
+
registryDependencies.add(link);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
exports.RegistryDependencies = RegistryDependencies;
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RemoveXInternal = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const ref_utils_1 = require("../../ref-utils");
|
|
6
|
+
const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
|
|
7
|
+
const RemoveXInternal = ({ internalFlagProperty = DEFAULT_INTERNAL_PROPERTY_NAME, }) => {
|
|
8
|
+
function removeInternal(node, ctx, originalMapping) {
|
|
9
|
+
const { parent, key } = ctx;
|
|
10
|
+
let didDelete = false;
|
|
11
|
+
if (Array.isArray(node)) {
|
|
12
|
+
for (let i = 0; i < node.length; i++) {
|
|
13
|
+
if ((0, ref_utils_1.isRef)(node[i])) {
|
|
14
|
+
const resolved = ctx.resolve(node[i]);
|
|
15
|
+
if (resolved.node?.[internalFlagProperty]) {
|
|
16
|
+
// First, remove the reference in the discriminator mapping, if it exists:
|
|
17
|
+
if ((0, utils_1.isPlainObject)(parent.discriminator?.mapping)) {
|
|
18
|
+
for (const mapping in parent.discriminator.mapping) {
|
|
19
|
+
if (originalMapping?.[mapping] === node[i].$ref) {
|
|
20
|
+
delete parent.discriminator.mapping[mapping];
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
node.splice(i, 1);
|
|
25
|
+
didDelete = true;
|
|
26
|
+
i--;
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
if (node[i]?.[internalFlagProperty]) {
|
|
30
|
+
node.splice(i, 1);
|
|
31
|
+
didDelete = true;
|
|
32
|
+
i--;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
else if ((0, utils_1.isPlainObject)(node)) {
|
|
37
|
+
for (const key of Object.keys(node)) {
|
|
38
|
+
if ((0, ref_utils_1.isRef)(node[key])) {
|
|
39
|
+
const resolved = ctx.resolve(node[key]);
|
|
40
|
+
if ((0, utils_1.isPlainObject)(resolved.node) && resolved.node?.[internalFlagProperty]) {
|
|
41
|
+
delete node[key];
|
|
42
|
+
didDelete = true;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
if ((0, utils_1.isPlainObject)(node[key]) && node[key]?.[internalFlagProperty]) {
|
|
46
|
+
delete node[key];
|
|
47
|
+
didDelete = true;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
if (didDelete && ((0, utils_1.isEmptyObject)(node) || (0, utils_1.isEmptyArray)(node))) {
|
|
52
|
+
delete parent[key];
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
let originalMapping = {};
|
|
56
|
+
return {
|
|
57
|
+
DiscriminatorMapping: {
|
|
58
|
+
enter: (mapping) => {
|
|
59
|
+
originalMapping = JSON.parse(JSON.stringify(mapping));
|
|
60
|
+
},
|
|
61
|
+
},
|
|
62
|
+
any: {
|
|
63
|
+
enter: (node, ctx) => {
|
|
64
|
+
removeInternal(node, ctx, originalMapping);
|
|
65
|
+
},
|
|
66
|
+
},
|
|
67
|
+
};
|
|
68
|
+
};
|
|
69
|
+
exports.RemoveXInternal = RemoveXInternal;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TagDescriptionOverride = void 0;
|
|
4
|
+
const utils_1 = require("../../utils");
|
|
5
|
+
const TagDescriptionOverride = ({ tagNames }) => {
|
|
6
|
+
return {
|
|
7
|
+
Tag: {
|
|
8
|
+
leave(tag, { report }) {
|
|
9
|
+
if (!tagNames)
|
|
10
|
+
throw new Error(`Parameter "tagNames" is not provided for "tag-description-override" rule`);
|
|
11
|
+
if (tagNames[tag.name]) {
|
|
12
|
+
try {
|
|
13
|
+
tag.description = (0, utils_1.readFileAsStringSync)(tagNames[tag.name]);
|
|
14
|
+
}
|
|
15
|
+
catch (e) {
|
|
16
|
+
report({
|
|
17
|
+
message: `Failed to read markdown override file for tag "${tag.name}".\n${e.message}`,
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
};
|
|
25
|
+
exports.TagDescriptionOverride = TagDescriptionOverride;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { Oas2Decorator } from '../../visitors';
|
|
2
|
+
export declare const decorators: {
|
|
3
|
+
'registry-dependencies': Oas2Decorator;
|
|
4
|
+
'operation-description-override': Oas2Decorator;
|
|
5
|
+
'tag-description-override': Oas2Decorator;
|
|
6
|
+
'info-description-override': Oas2Decorator;
|
|
7
|
+
'info-override': Oas2Decorator;
|
|
8
|
+
'remove-x-internal': Oas2Decorator;
|
|
9
|
+
'filter-in': Oas2Decorator;
|
|
10
|
+
'filter-out': Oas2Decorator;
|
|
11
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.decorators = void 0;
|
|
4
|
+
const registry_dependencies_1 = require("../common/registry-dependencies");
|
|
5
|
+
const operation_description_override_1 = require("../common/operation-description-override");
|
|
6
|
+
const tag_description_override_1 = require("../common/tag-description-override");
|
|
7
|
+
const info_description_override_1 = require("../common/info-description-override");
|
|
8
|
+
const info_override_1 = require("../common/info-override");
|
|
9
|
+
const remove_x_internal_1 = require("../common/remove-x-internal");
|
|
10
|
+
const filter_in_1 = require("../common/filters/filter-in");
|
|
11
|
+
const filter_out_1 = require("../common/filters/filter-out");
|
|
12
|
+
exports.decorators = {
|
|
13
|
+
'registry-dependencies': registry_dependencies_1.RegistryDependencies,
|
|
14
|
+
'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
|
|
15
|
+
'tag-description-override': tag_description_override_1.TagDescriptionOverride,
|
|
16
|
+
'info-description-override': info_description_override_1.InfoDescriptionOverride,
|
|
17
|
+
'info-override': info_override_1.InfoOverride,
|
|
18
|
+
'remove-x-internal': remove_x_internal_1.RemoveXInternal,
|
|
19
|
+
'filter-in': filter_in_1.FilterIn,
|
|
20
|
+
'filter-out': filter_out_1.FilterOut,
|
|
21
|
+
};
|
|
@@ -0,0 +1,89 @@
|
|
|
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
|
+
const components = new Map();
|
|
7
|
+
function registerComponent(location, componentType, name) {
|
|
8
|
+
components.set(location.absolutePointer, {
|
|
9
|
+
usedIn: components.get(location.absolutePointer)?.usedIn ?? [],
|
|
10
|
+
componentType,
|
|
11
|
+
name,
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
function removeUnusedComponents(root, removedPaths) {
|
|
15
|
+
const removedLengthStart = removedPaths.length;
|
|
16
|
+
for (const [path, { usedIn, name, componentType }] of components) {
|
|
17
|
+
const used = usedIn.some((location) => !removedPaths.some((removed) =>
|
|
18
|
+
// Check if the current location's absolute pointer starts with the 'removed' path
|
|
19
|
+
// and either its length matches exactly with 'removed' or the character after the 'removed' path is a '/'
|
|
20
|
+
location.absolutePointer.startsWith(removed) &&
|
|
21
|
+
(location.absolutePointer.length === removed.length ||
|
|
22
|
+
location.absolutePointer[removed.length] === '/')));
|
|
23
|
+
if (!used && componentType) {
|
|
24
|
+
removedPaths.push(path);
|
|
25
|
+
delete root[componentType][name];
|
|
26
|
+
components.delete(path);
|
|
27
|
+
if ((0, utils_1.isEmptyObject)(root[componentType])) {
|
|
28
|
+
delete root[componentType];
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
return removedPaths.length > removedLengthStart
|
|
33
|
+
? removeUnusedComponents(root, removedPaths)
|
|
34
|
+
: removedPaths.length;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
ref: {
|
|
38
|
+
leave(ref, { location, type, resolve, key }) {
|
|
39
|
+
if (['Schema', 'Parameter', 'Response', 'SecurityScheme'].includes(type.name)) {
|
|
40
|
+
const resolvedRef = resolve(ref);
|
|
41
|
+
if (!resolvedRef.location)
|
|
42
|
+
return;
|
|
43
|
+
const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
|
|
44
|
+
const componentLevelLocalPointer = localPointer.split('/').slice(0, 3).join('/');
|
|
45
|
+
const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
|
|
46
|
+
const registered = components.get(pointer);
|
|
47
|
+
if (registered) {
|
|
48
|
+
registered.usedIn.push(location);
|
|
49
|
+
}
|
|
50
|
+
else {
|
|
51
|
+
components.set(pointer, {
|
|
52
|
+
usedIn: [location],
|
|
53
|
+
name: key.toString(),
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
Root: {
|
|
60
|
+
leave(root, ctx) {
|
|
61
|
+
const data = ctx.getVisitorData();
|
|
62
|
+
data.removedCount = removeUnusedComponents(root, []);
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
NamedSchemas: {
|
|
66
|
+
Schema(schema, { location, key }) {
|
|
67
|
+
if (!schema.allOf) {
|
|
68
|
+
registerComponent(location, 'definitions', key.toString());
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
},
|
|
72
|
+
NamedParameters: {
|
|
73
|
+
Parameter(_parameter, { location, key }) {
|
|
74
|
+
registerComponent(location, 'parameters', key.toString());
|
|
75
|
+
},
|
|
76
|
+
},
|
|
77
|
+
NamedResponses: {
|
|
78
|
+
Response(_response, { location, key }) {
|
|
79
|
+
registerComponent(location, 'responses', key.toString());
|
|
80
|
+
},
|
|
81
|
+
},
|
|
82
|
+
NamedSecuritySchemes: {
|
|
83
|
+
SecurityScheme(_securityScheme, { location, key }) {
|
|
84
|
+
registerComponent(location, 'securityDefinitions', key.toString());
|
|
85
|
+
},
|
|
86
|
+
},
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
exports.RemoveUnusedComponents = RemoveUnusedComponents;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Oas3Decorator } from '../../visitors';
|
|
2
|
+
export declare const decorators: {
|
|
3
|
+
'registry-dependencies': Oas3Decorator;
|
|
4
|
+
'operation-description-override': Oas3Decorator;
|
|
5
|
+
'tag-description-override': Oas3Decorator;
|
|
6
|
+
'info-description-override': Oas3Decorator;
|
|
7
|
+
'info-override': Oas3Decorator;
|
|
8
|
+
'remove-x-internal': Oas3Decorator;
|
|
9
|
+
'filter-in': Oas3Decorator;
|
|
10
|
+
'filter-out': Oas3Decorator;
|
|
11
|
+
'media-type-examples-override': Oas3Decorator;
|
|
12
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.decorators = void 0;
|
|
4
|
+
const registry_dependencies_1 = require("../common/registry-dependencies");
|
|
5
|
+
const operation_description_override_1 = require("../common/operation-description-override");
|
|
6
|
+
const tag_description_override_1 = require("../common/tag-description-override");
|
|
7
|
+
const info_description_override_1 = require("../common/info-description-override");
|
|
8
|
+
const info_override_1 = require("../common/info-override");
|
|
9
|
+
const remove_x_internal_1 = require("../common/remove-x-internal");
|
|
10
|
+
const filter_in_1 = require("../common/filters/filter-in");
|
|
11
|
+
const filter_out_1 = require("../common/filters/filter-out");
|
|
12
|
+
const media_type_examples_override_1 = require("../common/media-type-examples-override");
|
|
13
|
+
exports.decorators = {
|
|
14
|
+
'registry-dependencies': registry_dependencies_1.RegistryDependencies,
|
|
15
|
+
'operation-description-override': operation_description_override_1.OperationDescriptionOverride,
|
|
16
|
+
'tag-description-override': tag_description_override_1.TagDescriptionOverride,
|
|
17
|
+
'info-description-override': info_description_override_1.InfoDescriptionOverride,
|
|
18
|
+
'info-override': info_override_1.InfoOverride,
|
|
19
|
+
'remove-x-internal': remove_x_internal_1.RemoveXInternal,
|
|
20
|
+
'filter-in': filter_in_1.FilterIn,
|
|
21
|
+
'filter-out': filter_out_1.FilterOut,
|
|
22
|
+
'media-type-examples-override': media_type_examples_override_1.MediaTypeExamplesOverride,
|
|
23
|
+
};
|
|
@@ -0,0 +1,100 @@
|
|
|
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
|
+
const components = new Map();
|
|
7
|
+
function registerComponent(location, componentType, name) {
|
|
8
|
+
components.set(location.absolutePointer, {
|
|
9
|
+
usedIn: components.get(location.absolutePointer)?.usedIn ?? [],
|
|
10
|
+
componentType,
|
|
11
|
+
name,
|
|
12
|
+
});
|
|
13
|
+
}
|
|
14
|
+
function removeUnusedComponents(root, removedPaths) {
|
|
15
|
+
const removedLengthStart = removedPaths.length;
|
|
16
|
+
for (const [path, { usedIn, name, componentType }] of components) {
|
|
17
|
+
const used = usedIn.some((location) => !removedPaths.some((removed) => location.absolutePointer.startsWith(removed) &&
|
|
18
|
+
(location.absolutePointer.length === removed.length ||
|
|
19
|
+
location.absolutePointer[removed.length] === '/')));
|
|
20
|
+
if (!used && componentType && root.components) {
|
|
21
|
+
removedPaths.push(path);
|
|
22
|
+
const componentChild = root.components[componentType];
|
|
23
|
+
delete componentChild[name];
|
|
24
|
+
components.delete(path);
|
|
25
|
+
if ((0, utils_1.isEmptyObject)(componentChild)) {
|
|
26
|
+
delete root.components[componentType];
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
return removedPaths.length > removedLengthStart
|
|
31
|
+
? removeUnusedComponents(root, removedPaths)
|
|
32
|
+
: removedPaths.length;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
ref: {
|
|
36
|
+
leave(ref, { location, type, resolve, key }) {
|
|
37
|
+
if (['Schema', 'Header', 'Parameter', 'Response', 'Example', 'RequestBody'].includes(type.name)) {
|
|
38
|
+
const resolvedRef = resolve(ref);
|
|
39
|
+
if (!resolvedRef.location)
|
|
40
|
+
return;
|
|
41
|
+
const [fileLocation, localPointer] = resolvedRef.location.absolutePointer.split('#', 2);
|
|
42
|
+
const componentLevelLocalPointer = localPointer.split('/').slice(0, 4).join('/');
|
|
43
|
+
const pointer = `${fileLocation}#${componentLevelLocalPointer}`;
|
|
44
|
+
const registered = components.get(pointer);
|
|
45
|
+
if (registered) {
|
|
46
|
+
registered.usedIn.push(location);
|
|
47
|
+
}
|
|
48
|
+
else {
|
|
49
|
+
components.set(pointer, {
|
|
50
|
+
usedIn: [location],
|
|
51
|
+
name: key.toString(),
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
},
|
|
57
|
+
Root: {
|
|
58
|
+
leave(root, ctx) {
|
|
59
|
+
const data = ctx.getVisitorData();
|
|
60
|
+
data.removedCount = removeUnusedComponents(root, []);
|
|
61
|
+
if ((0, utils_1.isEmptyObject)(root.components)) {
|
|
62
|
+
delete root.components;
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
},
|
|
66
|
+
NamedSchemas: {
|
|
67
|
+
Schema(schema, { location, key }) {
|
|
68
|
+
if (!schema.allOf) {
|
|
69
|
+
registerComponent(location, 'schemas', key.toString());
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
},
|
|
73
|
+
NamedParameters: {
|
|
74
|
+
Parameter(_parameter, { location, key }) {
|
|
75
|
+
registerComponent(location, 'parameters', key.toString());
|
|
76
|
+
},
|
|
77
|
+
},
|
|
78
|
+
NamedResponses: {
|
|
79
|
+
Response(_response, { location, key }) {
|
|
80
|
+
registerComponent(location, 'responses', key.toString());
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
NamedExamples: {
|
|
84
|
+
Example(_example, { location, key }) {
|
|
85
|
+
registerComponent(location, 'examples', key.toString());
|
|
86
|
+
},
|
|
87
|
+
},
|
|
88
|
+
NamedRequestBodies: {
|
|
89
|
+
RequestBody(_requestBody, { location, key }) {
|
|
90
|
+
registerComponent(location, 'requestBodies', key.toString());
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
NamedHeaders: {
|
|
94
|
+
Header(_header, { location, key }) {
|
|
95
|
+
registerComponent(location, 'headers', key.toString());
|
|
96
|
+
},
|
|
97
|
+
},
|
|
98
|
+
};
|
|
99
|
+
};
|
|
100
|
+
exports.RemoveUnusedComponents = RemoveUnusedComponents;
|
package/lib/env.d.ts
ADDED
package/lib/env.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.env = exports.isBrowser = void 0;
|
|
4
|
+
exports.isBrowser = typeof window !== 'undefined' ||
|
|
5
|
+
typeof process === 'undefined' ||
|
|
6
|
+
process?.platform === 'browser'; // main and worker thread
|
|
7
|
+
exports.env = exports.isBrowser ? {} : process.env || {};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import * as yamlAst from 'yaml-ast-parser';
|
|
2
|
+
import type { LineColLocationObject, LocationObject } from '../walk';
|
|
3
|
+
type YAMLMapping = yamlAst.YAMLMapping & {
|
|
4
|
+
kind: yamlAst.Kind.MAPPING;
|
|
5
|
+
};
|
|
6
|
+
type YAMLMap = yamlAst.YamlMap & {
|
|
7
|
+
kind: yamlAst.Kind.MAP;
|
|
8
|
+
};
|
|
9
|
+
type YAMLAnchorReference = yamlAst.YAMLAnchorReference & {
|
|
10
|
+
kind: yamlAst.Kind.ANCHOR_REF;
|
|
11
|
+
};
|
|
12
|
+
type YAMLSequence = yamlAst.YAMLSequence & {
|
|
13
|
+
kind: yamlAst.Kind.SEQ;
|
|
14
|
+
};
|
|
15
|
+
type YAMLScalar = yamlAst.YAMLScalar & {
|
|
16
|
+
kind: yamlAst.Kind.SCALAR;
|
|
17
|
+
};
|
|
18
|
+
type YAMLNode = YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | YAMLScalar;
|
|
19
|
+
export declare function getCodeframe(location: LineColLocationObject, color: boolean): string;
|
|
20
|
+
export declare function getLineColLocation(location: LocationObject): LineColLocationObject;
|
|
21
|
+
export declare function getAstNodeByPointer(root: YAMLNode, pointer: string, reportOnKey: boolean): YAMLMapping | YAMLMap | YAMLAnchorReference | YAMLSequence | yamlAst.YAMLScalar | undefined;
|
|
22
|
+
export {};
|