@redocly/openapi-core 1.0.0-beta.126 → 1.0.0-beta.127
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/lib/bundle.js +5 -2
- package/lib/rules/common/spec.js +1 -0
- package/lib/rules/oas2/request-mime-type.d.ts +1 -1
- package/lib/rules/oas2/response-mime-type.d.ts +1 -1
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.d.ts +2 -2
- package/lib/rules/oas3/operation-4xx-problem-details-rfc7807.js +3 -3
- package/lib/rules/oas3/request-mime-type.d.ts +1 -1
- package/lib/rules/oas3/response-mime-type.d.ts +1 -1
- package/lib/walk.d.ts +6 -5
- package/lib/walk.js +23 -27
- package/package.json +1 -1
- package/__tests__/utils.ts +0 -88
- package/src/__tests__/__snapshots__/bundle.test.ts.snap +0 -437
- package/src/__tests__/bundle.test.ts +0 -236
- package/src/__tests__/codeframes.test.ts +0 -530
- package/src/__tests__/fixtures/.redocly.lint-ignore.yaml +0 -5
- package/src/__tests__/fixtures/extension.js +0 -24
- package/src/__tests__/fixtures/refs/definitions.yaml +0 -3
- package/src/__tests__/fixtures/refs/examples.yaml +0 -8
- package/src/__tests__/fixtures/refs/external-request-body.yaml +0 -13
- package/src/__tests__/fixtures/refs/externalref.yaml +0 -35
- package/src/__tests__/fixtures/refs/hosted.yaml +0 -35
- package/src/__tests__/fixtures/refs/openapi-with-external-refs-conflicting-names.yaml +0 -21
- package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml +0 -33
- package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml +0 -18
- package/src/__tests__/fixtures/refs/param-b.yaml +0 -1
- package/src/__tests__/fixtures/refs/param-c.yaml +0 -1
- package/src/__tests__/fixtures/refs/rename.yaml +0 -1
- package/src/__tests__/fixtures/refs/requestBody.yaml +0 -9
- package/src/__tests__/fixtures/refs/schema-a.yaml +0 -1
- package/src/__tests__/fixtures/refs/simple.yaml +0 -1
- package/src/__tests__/fixtures/refs/vendor.schema.yaml +0 -20
- package/src/__tests__/fixtures/resolve/External.yaml +0 -10
- package/src/__tests__/fixtures/resolve/External2.yaml +0 -4
- package/src/__tests__/fixtures/resolve/description.md +0 -3
- package/src/__tests__/fixtures/resolve/externalInfo.yaml +0 -4
- package/src/__tests__/fixtures/resolve/externalLicense.yaml +0 -1
- package/src/__tests__/fixtures/resolve/openapi-with-back.yaml +0 -13
- package/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml +0 -5
- package/src/__tests__/fixtures/resolve/openapi.yaml +0 -28
- package/src/__tests__/fixtures/resolve/schemas/type-a.yaml +0 -10
- package/src/__tests__/fixtures/resolve/schemas/type-b.yaml +0 -6
- package/src/__tests__/fixtures/resolve/transitive/a.yaml +0 -1
- package/src/__tests__/fixtures/resolve/transitive/components.yaml +0 -5
- package/src/__tests__/fixtures/resolve/transitive/schemas.yaml +0 -3
- package/src/__tests__/format.test.ts +0 -76
- package/src/__tests__/js-yaml.test.ts +0 -73
- package/src/__tests__/lint.test.ts +0 -388
- package/src/__tests__/logger-browser.test.ts +0 -53
- package/src/__tests__/logger.test.ts +0 -47
- package/src/__tests__/login.test.ts +0 -17
- package/src/__tests__/normalizeVisitors.test.ts +0 -151
- package/src/__tests__/output-browser.test.ts +0 -18
- package/src/__tests__/output.test.ts +0 -15
- package/src/__tests__/ref-utils.test.ts +0 -120
- package/src/__tests__/resolve-http.test.ts +0 -77
- package/src/__tests__/resolve.test.ts +0 -430
- package/src/__tests__/utils-browser.test.ts +0 -11
- package/src/__tests__/utils.test.ts +0 -144
- package/src/__tests__/walk.test.ts +0 -1545
- package/src/benchmark/benches/lint-with-many-rules.bench.ts +0 -35
- package/src/benchmark/benches/lint-with-nested-rule.bench.ts +0 -39
- package/src/benchmark/benches/lint-with-no-rules.bench.ts +0 -20
- package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts +0 -35
- package/src/benchmark/benches/lint-with-top-level-rule.bench.ts +0 -32
- package/src/benchmark/benches/rebilly.yaml +0 -32275
- package/src/benchmark/benches/recommended-oas3.bench.ts +0 -22
- package/src/benchmark/benches/resolve-with-no-external.bench.ts +0 -23
- package/src/benchmark/benchmark.js +0 -311
- package/src/benchmark/colors.js +0 -29
- package/src/benchmark/fork.js +0 -83
- package/src/benchmark/utils.ts +0 -36
- package/src/bundle.ts +0 -399
- package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap +0 -161
- package/src/config/__tests__/__snapshots__/config.test.ts.snap +0 -144
- package/src/config/__tests__/config-resolvers.test.ts +0 -491
- package/src/config/__tests__/config.test.ts +0 -307
- package/src/config/__tests__/fixtures/ingore-file.ts +0 -8
- package/src/config/__tests__/fixtures/load-redocly.yaml +0 -2
- package/src/config/__tests__/fixtures/plugin-config.yaml +0 -2
- package/src/config/__tests__/fixtures/plugin.js +0 -56
- package/src/config/__tests__/fixtures/resolve-config/api/nested-config.yaml +0 -11
- package/src/config/__tests__/fixtures/resolve-config/api/plugin.js +0 -69
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-circular.yaml +0 -7
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-custom-function.yaml +0 -17
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-file.yaml +0 -18
- package/src/config/__tests__/fixtures/resolve-config/local-config-with-wrong-custom-function.yaml +0 -15
- package/src/config/__tests__/fixtures/resolve-config/local-config.yaml +0 -9
- package/src/config/__tests__/fixtures/resolve-config/plugin.js +0 -80
- package/src/config/__tests__/fixtures/resolve-remote-configs/nested-remote-config.yaml +0 -3
- package/src/config/__tests__/fixtures/resolve-remote-configs/remote-config.yaml +0 -4
- package/src/config/__tests__/load.test.ts +0 -167
- package/src/config/__tests__/resolve-plugins.test.ts +0 -27
- package/src/config/__tests__/utils.test.ts +0 -204
- package/src/config/all.ts +0 -73
- package/src/config/builtIn.ts +0 -37
- package/src/config/config-resolvers.ts +0 -465
- package/src/config/config.ts +0 -330
- package/src/config/index.ts +0 -7
- package/src/config/load.ts +0 -144
- package/src/config/minimal.ts +0 -60
- package/src/config/recommended.ts +0 -60
- package/src/config/rules.ts +0 -54
- package/src/config/types.ts +0 -216
- package/src/config/utils.ts +0 -333
- package/src/decorators/__tests__/filter-in.test.ts +0 -310
- package/src/decorators/__tests__/filter-out.test.ts +0 -335
- package/src/decorators/__tests__/media-type-examples-override.test.ts +0 -665
- package/src/decorators/__tests__/remove-x-internal.test.ts +0 -316
- package/src/decorators/__tests__/resources/request.yaml +0 -3
- package/src/decorators/__tests__/resources/response.yaml +0 -3
- package/src/decorators/common/filters/filter-helper.ts +0 -72
- package/src/decorators/common/filters/filter-in.ts +0 -18
- package/src/decorators/common/filters/filter-out.ts +0 -18
- package/src/decorators/common/info-description-override.ts +0 -24
- package/src/decorators/common/info-override.ts +0 -15
- package/src/decorators/common/media-type-examples-override.ts +0 -79
- package/src/decorators/common/operation-description-override.ts +0 -30
- package/src/decorators/common/registry-dependencies.ts +0 -25
- package/src/decorators/common/remove-x-internal.ts +0 -59
- package/src/decorators/common/tag-description-override.ts +0 -25
- package/src/decorators/oas2/index.ts +0 -20
- package/src/decorators/oas3/index.ts +0 -22
- package/src/env.ts +0 -5
- package/src/format/codeframes.ts +0 -216
- package/src/format/format.ts +0 -375
- package/src/index.ts +0 -71
- package/src/js-yaml/index.ts +0 -14
- package/src/lint.ts +0 -130
- package/src/logger.ts +0 -34
- package/src/oas-types.ts +0 -57
- package/src/output.ts +0 -7
- package/src/redocly/__tests__/redocly-client.test.ts +0 -146
- package/src/redocly/index.ts +0 -187
- package/src/redocly/redocly-client-types.ts +0 -10
- package/src/redocly/registry-api-types.ts +0 -32
- package/src/redocly/registry-api.ts +0 -149
- package/src/ref-utils.ts +0 -85
- package/src/resolve.ts +0 -417
- package/src/rules/__tests__/fixtures/code-sample.php +0 -9
- package/src/rules/__tests__/fixtures/invalid-yaml.yaml +0 -1
- package/src/rules/__tests__/fixtures/ref.yaml +0 -1
- package/src/rules/__tests__/no-unresolved-refs.test.ts +0 -257
- package/src/rules/__tests__/utils.test.ts +0 -160
- package/src/rules/ajv.ts +0 -102
- package/src/rules/common/__tests__/info-license.test.ts +0 -62
- package/src/rules/common/__tests__/license-url.test.ts +0 -63
- package/src/rules/common/__tests__/no-ambiguous-paths.test.ts +0 -96
- package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts +0 -210
- package/src/rules/common/__tests__/no-identical-paths.test.ts +0 -58
- package/src/rules/common/__tests__/no-path-trailing-slash.test.ts +0 -85
- package/src/rules/common/__tests__/operation-2xx-response.test.ts +0 -192
- package/src/rules/common/__tests__/operation-4xx-response.test.ts +0 -231
- package/src/rules/common/__tests__/operation-operationId-unique.test.ts +0 -76
- package/src/rules/common/__tests__/operation-operationId-url-safe.test.ts +0 -45
- package/src/rules/common/__tests__/operation-parameters-unique.test.ts +0 -167
- package/src/rules/common/__tests__/operation-singular-tag.test.ts +0 -72
- package/src/rules/common/__tests__/path-http-verbs-order.test.ts +0 -95
- package/src/rules/common/__tests__/path-not-include-query.test.ts +0 -64
- package/src/rules/common/__tests__/path-params-defined.test.ts +0 -202
- package/src/rules/common/__tests__/paths-kebab-case.test.ts +0 -108
- package/src/rules/common/__tests__/scalar-property-missing-example.test.ts +0 -264
- package/src/rules/common/__tests__/security-defined.test.ts +0 -175
- package/src/rules/common/__tests__/spec.test.ts +0 -555
- package/src/rules/common/__tests__/tag-description.test.ts +0 -65
- package/src/rules/common/__tests__/tags-alphabetical.test.ts +0 -64
- package/src/rules/common/assertions/__tests__/asserts.test.ts +0 -869
- package/src/rules/common/assertions/__tests__/index.test.ts +0 -100
- package/src/rules/common/assertions/__tests__/utils.test.ts +0 -236
- package/src/rules/common/assertions/asserts.ts +0 -357
- package/src/rules/common/assertions/index.ts +0 -56
- package/src/rules/common/assertions/utils.ts +0 -331
- package/src/rules/common/info-contact.ts +0 -15
- package/src/rules/common/info-license-url.ts +0 -10
- package/src/rules/common/info-license.ts +0 -15
- package/src/rules/common/no-ambiguous-paths.ts +0 -50
- package/src/rules/common/no-enum-type-mismatch.ts +0 -52
- package/src/rules/common/no-http-verbs-in-paths.ts +0 -36
- package/src/rules/common/no-identical-paths.ts +0 -24
- package/src/rules/common/no-invalid-parameter-examples.ts +0 -36
- package/src/rules/common/no-invalid-schema-examples.ts +0 -27
- package/src/rules/common/no-path-trailing-slash.ts +0 -15
- package/src/rules/common/operation-2xx-response.ts +0 -24
- package/src/rules/common/operation-4xx-response.ts +0 -24
- package/src/rules/common/operation-description.ts +0 -13
- package/src/rules/common/operation-operationId-unique.ts +0 -21
- package/src/rules/common/operation-operationId-url-safe.ts +0 -19
- package/src/rules/common/operation-operationId.ts +0 -17
- package/src/rules/common/operation-parameters-unique.ts +0 -48
- package/src/rules/common/operation-singular-tag.ts +0 -17
- package/src/rules/common/operation-summary.ts +0 -13
- package/src/rules/common/operation-tag-defined.ts +0 -26
- package/src/rules/common/parameter-description.ts +0 -22
- package/src/rules/common/path-declaration-must-exist.ts +0 -15
- package/src/rules/common/path-excludes-patterns.ts +0 -23
- package/src/rules/common/path-http-verbs-order.ts +0 -30
- package/src/rules/common/path-not-include-query.ts +0 -17
- package/src/rules/common/path-params-defined.ts +0 -65
- package/src/rules/common/path-segment-plural.ts +0 -31
- package/src/rules/common/paths-kebab-case.ts +0 -19
- package/src/rules/common/required-string-property-missing-min-length.ts +0 -44
- package/src/rules/common/response-contains-header.ts +0 -35
- package/src/rules/common/scalar-property-missing-example.ts +0 -58
- package/src/rules/common/security-defined.ts +0 -65
- package/src/rules/common/spec.ts +0 -174
- package/src/rules/common/tag-description.ts +0 -10
- package/src/rules/common/tags-alphabetical.ts +0 -20
- package/src/rules/no-unresolved-refs.ts +0 -51
- package/src/rules/oas2/__tests__/boolean-parameter-prefixes.test.ts +0 -110
- package/src/rules/oas2/__tests__/response-contains-header.test.ts +0 -174
- package/src/rules/oas2/__tests__/response-contains-property.test.ts +0 -155
- package/src/rules/oas2/__tests__/spec/fixtures/description.md +0 -1
- package/src/rules/oas2/__tests__/spec/info.test.ts +0 -355
- package/src/rules/oas2/__tests__/spec/operation.test.ts +0 -123
- package/src/rules/oas2/__tests__/spec/paths.test.ts +0 -245
- package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts +0 -35
- package/src/rules/oas2/__tests__/spec/utils.ts +0 -32
- package/src/rules/oas2/boolean-parameter-prefixes.ts +0 -26
- package/src/rules/oas2/index.ts +0 -89
- package/src/rules/oas2/remove-unused-components.ts +0 -81
- package/src/rules/oas2/request-mime-type.ts +0 -17
- package/src/rules/oas2/response-contains-property.ts +0 -36
- package/src/rules/oas2/response-mime-type.ts +0 -17
- package/src/rules/oas3/__tests__/boolean-parameter-prefixes.test.ts +0 -111
- package/src/rules/oas3/__tests__/fixtures/common.yaml +0 -11
- package/src/rules/oas3/__tests__/no-empty-enum-servers.com.test.ts +0 -205
- package/src/rules/oas3/__tests__/no-example-value-and-externalValue.test.ts +0 -65
- package/src/rules/oas3/__tests__/no-invalid-media-type-examples.test.ts +0 -473
- package/src/rules/oas3/__tests__/no-server-example.com.test.ts +0 -60
- package/src/rules/oas3/__tests__/no-server-trailing-slash.test.ts +0 -79
- package/src/rules/oas3/__tests__/no-unused-components.test.ts +0 -131
- package/src/rules/oas3/__tests__/operation-4xx-problem-details-rfc7807.test.ts +0 -145
- package/src/rules/oas3/__tests__/response-contains-header.test.ts +0 -389
- package/src/rules/oas3/__tests__/response-contains-property.test.ts +0 -403
- package/src/rules/oas3/__tests__/spec/callbacks.test.ts +0 -41
- package/src/rules/oas3/__tests__/spec/fixtures/description.md +0 -1
- package/src/rules/oas3/__tests__/spec/info.test.ts +0 -391
- package/src/rules/oas3/__tests__/spec/operation.test.ts +0 -253
- package/src/rules/oas3/__tests__/spec/paths.test.ts +0 -284
- package/src/rules/oas3/__tests__/spec/referenceableScalars.test.ts +0 -77
- package/src/rules/oas3/__tests__/spec/servers.test.ts +0 -505
- package/src/rules/oas3/__tests__/spec/spec.test.ts +0 -298
- package/src/rules/oas3/__tests__/spec/utils.ts +0 -32
- package/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts +0 -305
- package/src/rules/oas3/boolean-parameter-prefixes.ts +0 -28
- package/src/rules/oas3/index.ts +0 -109
- package/src/rules/oas3/no-empty-servers.ts +0 -22
- package/src/rules/oas3/no-example-value-and-externalValue.ts +0 -14
- package/src/rules/oas3/no-invalid-media-type-examples.ts +0 -49
- package/src/rules/oas3/no-server-example.com.ts +0 -14
- package/src/rules/oas3/no-server-trailing-slash.ts +0 -15
- package/src/rules/oas3/no-server-variables-empty-enum.ts +0 -66
- package/src/rules/oas3/no-undefined-server-variable.ts +0 -30
- package/src/rules/oas3/no-unused-components.ts +0 -75
- package/src/rules/oas3/operation-4xx-problem-details-rfc7807.ts +0 -36
- package/src/rules/oas3/remove-unused-components.ts +0 -95
- package/src/rules/oas3/request-mime-type.ts +0 -31
- package/src/rules/oas3/response-contains-property.ts +0 -38
- package/src/rules/oas3/response-mime-type.ts +0 -31
- package/src/rules/oas3/spec-components-invalid-map-name.ts +0 -74
- package/src/rules/other/stats.ts +0 -73
- package/src/rules/utils.ts +0 -191
- package/src/types/index.ts +0 -149
- package/src/types/oas2.ts +0 -478
- package/src/types/oas3.ts +0 -597
- package/src/types/oas3_1.ts +0 -258
- package/src/types/redocly-yaml.ts +0 -1010
- package/src/typings/common.ts +0 -17
- package/src/typings/openapi.ts +0 -298
- package/src/typings/swagger.ts +0 -236
- package/src/utils.ts +0 -276
- package/src/visitors.ts +0 -491
- package/src/walk.ts +0 -453
- package/tsconfig.json +0 -8
- package/tsconfig.tsbuildinfo +0 -1
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
import { validateResponseCodes } from '../utils';
|
|
4
|
-
|
|
5
|
-
export const Operation2xxResponse: Oas3Rule | Oas2Rule = ({ validateWebhooks }) => {
|
|
6
|
-
return {
|
|
7
|
-
Paths: {
|
|
8
|
-
Responses(responses: Record<string, object>, { report }: UserContext) {
|
|
9
|
-
const codes = Object.keys(responses || {});
|
|
10
|
-
|
|
11
|
-
validateResponseCodes(codes, '2XX', { report } as UserContext);
|
|
12
|
-
},
|
|
13
|
-
},
|
|
14
|
-
WebhooksMap: {
|
|
15
|
-
Responses(responses: Record<string, object>, { report }: UserContext) {
|
|
16
|
-
if (!validateWebhooks) return;
|
|
17
|
-
|
|
18
|
-
const codes = Object.keys(responses || {});
|
|
19
|
-
|
|
20
|
-
validateResponseCodes(codes, '2XX', { report } as UserContext);
|
|
21
|
-
},
|
|
22
|
-
},
|
|
23
|
-
};
|
|
24
|
-
};
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
import { validateResponseCodes } from '../utils';
|
|
4
|
-
|
|
5
|
-
export const Operation4xxResponse: Oas3Rule | Oas2Rule = ({ validateWebhooks }) => {
|
|
6
|
-
return {
|
|
7
|
-
Paths: {
|
|
8
|
-
Responses(responses: Record<string, object>, { report }: UserContext) {
|
|
9
|
-
const codes = Object.keys(responses || {});
|
|
10
|
-
|
|
11
|
-
validateResponseCodes(codes, '4XX', { report } as UserContext);
|
|
12
|
-
},
|
|
13
|
-
},
|
|
14
|
-
WebhooksMap: {
|
|
15
|
-
Responses(responses: Record<string, object>, { report }: UserContext) {
|
|
16
|
-
if (!validateWebhooks) return;
|
|
17
|
-
|
|
18
|
-
const codes = Object.keys(responses || {});
|
|
19
|
-
|
|
20
|
-
validateResponseCodes(codes, '4XX', { report } as UserContext);
|
|
21
|
-
},
|
|
22
|
-
},
|
|
23
|
-
};
|
|
24
|
-
};
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { validateDefinedAndNonEmpty } from '../utils';
|
|
3
|
-
import { UserContext } from '../../walk';
|
|
4
|
-
import { Oas2Operation } from '../../typings/swagger';
|
|
5
|
-
import { Oas3Operation } from '../../typings/openapi';
|
|
6
|
-
|
|
7
|
-
export const OperationDescription: Oas3Rule | Oas2Rule = () => {
|
|
8
|
-
return {
|
|
9
|
-
Operation(operation: Oas2Operation | Oas3Operation, ctx: UserContext) {
|
|
10
|
-
validateDefinedAndNonEmpty('description', operation, ctx);
|
|
11
|
-
},
|
|
12
|
-
};
|
|
13
|
-
};
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Operation } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Operation } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
export const OperationIdUnique: Oas3Rule | Oas2Rule = () => {
|
|
7
|
-
const seenOperations = new Set();
|
|
8
|
-
|
|
9
|
-
return {
|
|
10
|
-
Operation(operation: Oas2Operation | Oas3Operation, { report, location }: UserContext) {
|
|
11
|
-
if (!operation.operationId) return;
|
|
12
|
-
if (seenOperations.has(operation.operationId)) {
|
|
13
|
-
report({
|
|
14
|
-
message: 'Every operation must have a unique `operationId`.',
|
|
15
|
-
location: location.child([operation.operationId]),
|
|
16
|
-
});
|
|
17
|
-
}
|
|
18
|
-
seenOperations.add(operation.operationId);
|
|
19
|
-
},
|
|
20
|
-
};
|
|
21
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Operation } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Operation } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
const validUrlSymbols = /^[A-Za-z0-9-._~:/?#\[\]@!\$&'()*+,;=]*$/;
|
|
7
|
-
|
|
8
|
-
export const OperationIdUrlSafe: Oas3Rule | Oas2Rule = () => {
|
|
9
|
-
return {
|
|
10
|
-
Operation(operation: Oas2Operation | Oas3Operation, { report, location }: UserContext) {
|
|
11
|
-
if (operation.operationId && !validUrlSymbols.test(operation.operationId)) {
|
|
12
|
-
report({
|
|
13
|
-
message: 'Operation `operationId` should not have URL invalid characters.',
|
|
14
|
-
location: location.child(['operationId']),
|
|
15
|
-
});
|
|
16
|
-
}
|
|
17
|
-
},
|
|
18
|
-
};
|
|
19
|
-
};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { validateDefinedAndNonEmpty } from '../utils';
|
|
3
|
-
import { UserContext } from '../../walk';
|
|
4
|
-
import { Oas2Operation } from '../../typings/swagger';
|
|
5
|
-
import { Oas3Operation } from '../../typings/openapi';
|
|
6
|
-
|
|
7
|
-
export const OperationOperationId: Oas3Rule | Oas2Rule = () => {
|
|
8
|
-
return {
|
|
9
|
-
Root: {
|
|
10
|
-
PathItem: {
|
|
11
|
-
Operation(operation: Oas2Operation | Oas3Operation, ctx: UserContext) {
|
|
12
|
-
validateDefinedAndNonEmpty('operationId', operation, ctx);
|
|
13
|
-
},
|
|
14
|
-
},
|
|
15
|
-
},
|
|
16
|
-
};
|
|
17
|
-
};
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Parameter } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Parameter } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
export const OperationParametersUnique: Oas3Rule | Oas2Rule = () => {
|
|
7
|
-
let seenPathParams: Set<string>;
|
|
8
|
-
let seenOperationParams: Set<string>;
|
|
9
|
-
|
|
10
|
-
return {
|
|
11
|
-
PathItem: {
|
|
12
|
-
enter() {
|
|
13
|
-
seenPathParams = new Set();
|
|
14
|
-
},
|
|
15
|
-
Parameter(
|
|
16
|
-
parameter: Oas2Parameter | Oas3Parameter,
|
|
17
|
-
{ report, key, parentLocations }: UserContext
|
|
18
|
-
) {
|
|
19
|
-
const paramId = `${parameter.in}___${parameter.name}`;
|
|
20
|
-
if (seenPathParams.has(paramId)) {
|
|
21
|
-
report({
|
|
22
|
-
message: `Paths must have unique \`name\` + \`in\` parameters.\nRepeats of \`in:${parameter.in}\` + \`name:${parameter.name}\`.`,
|
|
23
|
-
location: parentLocations.PathItem.child(['parameters', key]),
|
|
24
|
-
});
|
|
25
|
-
}
|
|
26
|
-
seenPathParams.add(`${parameter.in}___${parameter.name}`);
|
|
27
|
-
},
|
|
28
|
-
Operation: {
|
|
29
|
-
enter() {
|
|
30
|
-
seenOperationParams = new Set();
|
|
31
|
-
},
|
|
32
|
-
Parameter(
|
|
33
|
-
parameter: Oas2Parameter | Oas3Parameter,
|
|
34
|
-
{ report, key, parentLocations }: UserContext
|
|
35
|
-
) {
|
|
36
|
-
const paramId = `${parameter.in}___${parameter.name}`;
|
|
37
|
-
if (seenOperationParams.has(paramId)) {
|
|
38
|
-
report({
|
|
39
|
-
message: `Operations must have unique \`name\` + \`in\` parameters. Repeats of \`in:${parameter.in}\` + \`name:${parameter.name}\`.`,
|
|
40
|
-
location: parentLocations.Operation.child(['parameters', key]),
|
|
41
|
-
});
|
|
42
|
-
}
|
|
43
|
-
seenOperationParams.add(paramId);
|
|
44
|
-
},
|
|
45
|
-
},
|
|
46
|
-
},
|
|
47
|
-
};
|
|
48
|
-
};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Operation } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Operation } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
export const OperationSingularTag: Oas3Rule | Oas2Rule = () => {
|
|
7
|
-
return {
|
|
8
|
-
Operation(operation: Oas2Operation | Oas3Operation, { report, location }: UserContext) {
|
|
9
|
-
if (operation.tags && operation.tags.length > 1) {
|
|
10
|
-
report({
|
|
11
|
-
message: 'Operation `tags` object should have only one tag.',
|
|
12
|
-
location: location.child(['tags']).key(),
|
|
13
|
-
});
|
|
14
|
-
}
|
|
15
|
-
},
|
|
16
|
-
};
|
|
17
|
-
};
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { validateDefinedAndNonEmpty } from '../utils';
|
|
3
|
-
import { UserContext } from '../../walk';
|
|
4
|
-
import { Oas2Operation } from '../../typings/swagger';
|
|
5
|
-
import { Oas3Operation } from '../../typings/openapi';
|
|
6
|
-
|
|
7
|
-
export const OperationSummary: Oas3Rule | Oas2Rule = () => {
|
|
8
|
-
return {
|
|
9
|
-
Operation(operation: Oas2Operation | Oas3Operation, ctx: UserContext) {
|
|
10
|
-
validateDefinedAndNonEmpty('summary', operation, ctx);
|
|
11
|
-
},
|
|
12
|
-
};
|
|
13
|
-
};
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Definition, Oas2Operation } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Definition, Oas3Operation } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
export const OperationTagDefined: Oas3Rule | Oas2Rule = () => {
|
|
7
|
-
let definedTags: Set<string>;
|
|
8
|
-
|
|
9
|
-
return {
|
|
10
|
-
Root(root: Oas2Definition | Oas3Definition) {
|
|
11
|
-
definedTags = new Set((root.tags ?? []).map((t) => t.name));
|
|
12
|
-
},
|
|
13
|
-
Operation(operation: Oas2Operation | Oas3Operation, { report, location }: UserContext) {
|
|
14
|
-
if (operation.tags) {
|
|
15
|
-
for (let i = 0; i < operation.tags.length; i++) {
|
|
16
|
-
if (!definedTags.has(operation.tags[i])) {
|
|
17
|
-
report({
|
|
18
|
-
message: `Operation tags should be defined in global tags.`,
|
|
19
|
-
location: location.child(['tags', i]),
|
|
20
|
-
});
|
|
21
|
-
}
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
},
|
|
25
|
-
};
|
|
26
|
-
};
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Parameter } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Parameter } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
export const ParameterDescription: Oas3Rule | Oas2Rule = () => {
|
|
7
|
-
return {
|
|
8
|
-
Parameter(parameter: Oas2Parameter | Oas3Parameter, { report, location }: UserContext) {
|
|
9
|
-
if (parameter.description === undefined) {
|
|
10
|
-
report({
|
|
11
|
-
message: 'Parameter object description must be present.',
|
|
12
|
-
location: { reportOnKey: true },
|
|
13
|
-
});
|
|
14
|
-
} else if (!parameter.description) {
|
|
15
|
-
report({
|
|
16
|
-
message: 'Parameter object description must be non-empty string.',
|
|
17
|
-
location: location.child(['description']),
|
|
18
|
-
});
|
|
19
|
-
}
|
|
20
|
-
},
|
|
21
|
-
};
|
|
22
|
-
};
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
|
|
4
|
-
export const PathDeclarationMustExist: Oas3Rule | Oas2Rule = () => {
|
|
5
|
-
return {
|
|
6
|
-
PathItem(_path: object, { report, key }: UserContext) {
|
|
7
|
-
if ((key as string).indexOf('{}') !== -1) {
|
|
8
|
-
report({
|
|
9
|
-
message: 'Path parameter declarations must be non-empty. `{}` is invalid.',
|
|
10
|
-
location: { reportOnKey: true },
|
|
11
|
-
});
|
|
12
|
-
}
|
|
13
|
-
},
|
|
14
|
-
};
|
|
15
|
-
};
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { Oas2Rule, Oas3Rule } from '../../visitors';
|
|
2
|
-
import { Oas2PathItem } from '../../typings/swagger';
|
|
3
|
-
import { Oas3PathItem } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
export const PathExcludesPatterns: Oas3Rule | Oas2Rule = ({ patterns }) => {
|
|
7
|
-
return {
|
|
8
|
-
PathItem(_path: Oas2PathItem | Oas3PathItem, { report, key, location }: UserContext) {
|
|
9
|
-
if (!patterns)
|
|
10
|
-
throw new Error(`Parameter "patterns" is not provided for "path-excludes-patterns" rule`);
|
|
11
|
-
const pathKey = key.toString();
|
|
12
|
-
if (pathKey.startsWith('/')) {
|
|
13
|
-
const matches = patterns.filter((pattern: string) => pathKey.match(pattern));
|
|
14
|
-
for (const match of matches) {
|
|
15
|
-
report({
|
|
16
|
-
message: `path \`${pathKey}\` should not match regex pattern: \`${match}\``,
|
|
17
|
-
location: location.key(),
|
|
18
|
-
});
|
|
19
|
-
}
|
|
20
|
-
}
|
|
21
|
-
},
|
|
22
|
-
};
|
|
23
|
-
};
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2PathItem } from '../../typings/swagger';
|
|
3
|
-
import { Oas3PathItem } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
const defaultOrder = ['get', 'head', 'post', 'put', 'patch', 'delete', 'options', 'trace'];
|
|
7
|
-
|
|
8
|
-
export const PathHttpVerbsOrder: Oas3Rule | Oas2Rule = (opts: any) => {
|
|
9
|
-
const order: string[] = (opts && opts.order) || defaultOrder;
|
|
10
|
-
if (!Array.isArray(order)) {
|
|
11
|
-
throw new Error('path-http-verbs-order `order` option must be an array');
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
return {
|
|
15
|
-
PathItem(path: Oas2PathItem | Oas3PathItem, { report, location }: UserContext) {
|
|
16
|
-
const httpVerbs = Object.keys(path).filter((k) => order.includes(k));
|
|
17
|
-
|
|
18
|
-
for (let i = 0; i < httpVerbs.length - 1; i++) {
|
|
19
|
-
const aIdx = order.indexOf(httpVerbs[i]);
|
|
20
|
-
const bIdx = order.indexOf(httpVerbs[i + 1]);
|
|
21
|
-
if (bIdx < aIdx) {
|
|
22
|
-
report({
|
|
23
|
-
message: 'Operation http verbs must be ordered.',
|
|
24
|
-
location: { reportOnKey: true, ...location.child(httpVerbs[i + 1]) },
|
|
25
|
-
});
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
},
|
|
29
|
-
};
|
|
30
|
-
};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
|
|
4
|
-
export const PathNotIncludeQuery: Oas3Rule | Oas2Rule = () => {
|
|
5
|
-
return {
|
|
6
|
-
Paths: {
|
|
7
|
-
PathItem(_operation: object, { report, key }: UserContext) {
|
|
8
|
-
if (key.toString().includes('?')) {
|
|
9
|
-
report({
|
|
10
|
-
message: `Don't put query string items in the path, they belong in parameters with \`in: query\`.`,
|
|
11
|
-
location: { reportOnKey: true },
|
|
12
|
-
});
|
|
13
|
-
}
|
|
14
|
-
},
|
|
15
|
-
},
|
|
16
|
-
};
|
|
17
|
-
};
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Oas2Parameter } from '../../typings/swagger';
|
|
3
|
-
import { Oas3Parameter } from '../../typings/openapi';
|
|
4
|
-
import { UserContext } from '../../walk';
|
|
5
|
-
|
|
6
|
-
const pathRegex = /\{([a-zA-Z0-9_.-]+)\}+/g;
|
|
7
|
-
|
|
8
|
-
export const PathParamsDefined: Oas3Rule | Oas2Rule = () => {
|
|
9
|
-
let pathTemplateParams: Set<string>;
|
|
10
|
-
let definedPathParams: Set<string>;
|
|
11
|
-
let currentPath: string;
|
|
12
|
-
let definedOperationParams: Set<string>;
|
|
13
|
-
|
|
14
|
-
return {
|
|
15
|
-
PathItem: {
|
|
16
|
-
enter(_: object, { key }: UserContext) {
|
|
17
|
-
definedPathParams = new Set();
|
|
18
|
-
currentPath = key as string;
|
|
19
|
-
pathTemplateParams = new Set(
|
|
20
|
-
Array.from(key!.toString().matchAll(pathRegex)).map((m) => m[1])
|
|
21
|
-
);
|
|
22
|
-
},
|
|
23
|
-
Parameter(parameter: Oas2Parameter | Oas3Parameter, { report, location }: UserContext) {
|
|
24
|
-
if (parameter.in === 'path' && parameter.name) {
|
|
25
|
-
definedPathParams.add(parameter.name);
|
|
26
|
-
if (!pathTemplateParams.has(parameter.name)) {
|
|
27
|
-
report({
|
|
28
|
-
message: `Path parameter \`${parameter.name}\` is not used in the path \`${currentPath}\`.`,
|
|
29
|
-
location: location.child(['name']),
|
|
30
|
-
});
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
},
|
|
34
|
-
Operation: {
|
|
35
|
-
enter() {
|
|
36
|
-
definedOperationParams = new Set();
|
|
37
|
-
},
|
|
38
|
-
leave(_op: object, { report, location }: UserContext) {
|
|
39
|
-
for (const templateParam of Array.from(pathTemplateParams.keys())) {
|
|
40
|
-
if (
|
|
41
|
-
!definedOperationParams.has(templateParam) &&
|
|
42
|
-
!definedPathParams.has(templateParam)
|
|
43
|
-
) {
|
|
44
|
-
report({
|
|
45
|
-
message: `The operation does not define the path parameter \`{${templateParam}}\` expected by path \`${currentPath}\`.`,
|
|
46
|
-
location: location.child(['parameters']).key(), // report on operation
|
|
47
|
-
});
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
},
|
|
51
|
-
Parameter(parameter: Oas2Parameter | Oas3Parameter, { report, location }: UserContext) {
|
|
52
|
-
if (parameter.in === 'path' && parameter.name) {
|
|
53
|
-
definedOperationParams.add(parameter.name);
|
|
54
|
-
if (!pathTemplateParams.has(parameter.name)) {
|
|
55
|
-
report({
|
|
56
|
-
message: `Path parameter \`${parameter.name}\` is not used in the path \`${currentPath}\`.`,
|
|
57
|
-
location: location.child(['name']),
|
|
58
|
-
});
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
},
|
|
62
|
-
},
|
|
63
|
-
},
|
|
64
|
-
};
|
|
65
|
-
};
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
import { isPathParameter, isSingular } from '../../utils';
|
|
4
|
-
|
|
5
|
-
export const PathSegmentPlural: Oas3Rule | Oas2Rule = (opts) => {
|
|
6
|
-
const { ignoreLastPathSegment, exceptions } = opts;
|
|
7
|
-
return {
|
|
8
|
-
PathItem: {
|
|
9
|
-
leave(_path: any, { report, key, location }: UserContext) {
|
|
10
|
-
const pathKey = key.toString();
|
|
11
|
-
if (pathKey.startsWith('/')) {
|
|
12
|
-
const pathSegments = pathKey.split('/');
|
|
13
|
-
pathSegments.shift();
|
|
14
|
-
if (ignoreLastPathSegment && pathSegments.length > 1) {
|
|
15
|
-
pathSegments.pop();
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
for (const pathSegment of pathSegments) {
|
|
19
|
-
if (exceptions && exceptions.includes(pathSegment)) continue;
|
|
20
|
-
if (!isPathParameter(pathSegment) && isSingular(pathSegment)) {
|
|
21
|
-
report({
|
|
22
|
-
message: `path segment \`${pathSegment}\` should be plural.`,
|
|
23
|
-
location: location.key(),
|
|
24
|
-
});
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
},
|
|
29
|
-
},
|
|
30
|
-
};
|
|
31
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
|
|
4
|
-
export const PathsKebabCase: Oas3Rule | Oas2Rule = () => {
|
|
5
|
-
return {
|
|
6
|
-
PathItem(_path: object, { report, key }: UserContext) {
|
|
7
|
-
const segments = (key as string)
|
|
8
|
-
.substr(1)
|
|
9
|
-
.split('/')
|
|
10
|
-
.filter((s) => s !== ''); // filter out empty segments
|
|
11
|
-
if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
|
|
12
|
-
report({
|
|
13
|
-
message: `\`${key}\` does not use kebab-case.`,
|
|
14
|
-
location: { reportOnKey: true },
|
|
15
|
-
});
|
|
16
|
-
}
|
|
17
|
-
},
|
|
18
|
-
};
|
|
19
|
-
};
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
import { UserContext } from '../../walk';
|
|
2
|
-
import { Oas3Schema, Oas3_1Schema } from '../../typings/openapi';
|
|
3
|
-
import { Oas2Schema } from 'core/src/typings/swagger';
|
|
4
|
-
import { Oas3Rule } from 'core/src/visitors';
|
|
5
|
-
|
|
6
|
-
export const RequiredStringPropertyMissingMinLength: Oas3Rule = () => {
|
|
7
|
-
let skipSchemaProperties: boolean;
|
|
8
|
-
let requiredPropertiesSet: Set<string>;
|
|
9
|
-
|
|
10
|
-
return {
|
|
11
|
-
Schema: {
|
|
12
|
-
enter(schema: Oas3Schema | Oas3_1Schema | Oas2Schema) {
|
|
13
|
-
if (!schema?.required) {
|
|
14
|
-
skipSchemaProperties = true;
|
|
15
|
-
return;
|
|
16
|
-
}
|
|
17
|
-
requiredPropertiesSet = new Set(schema.required);
|
|
18
|
-
skipSchemaProperties = false;
|
|
19
|
-
},
|
|
20
|
-
|
|
21
|
-
SchemaProperties: {
|
|
22
|
-
skip() {
|
|
23
|
-
return skipSchemaProperties;
|
|
24
|
-
},
|
|
25
|
-
|
|
26
|
-
Schema: {
|
|
27
|
-
enter(
|
|
28
|
-
schema: Oas3Schema | Oas3_1Schema | Oas2Schema,
|
|
29
|
-
{ key, location, report }: UserContext
|
|
30
|
-
) {
|
|
31
|
-
if (requiredPropertiesSet.has(key as string) && schema.type === 'string') {
|
|
32
|
-
if (!schema?.minLength) {
|
|
33
|
-
report({
|
|
34
|
-
message: 'Property minLength is required.',
|
|
35
|
-
location: location.key(),
|
|
36
|
-
});
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
},
|
|
40
|
-
},
|
|
41
|
-
},
|
|
42
|
-
},
|
|
43
|
-
};
|
|
44
|
-
};
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import { Oas2Rule, Oas3Rule } from '../../visitors';
|
|
2
|
-
import { UserContext } from '../../walk';
|
|
3
|
-
import { Oas3Response } from '../../typings/openapi';
|
|
4
|
-
import { Oas2Response } from '../../typings/swagger';
|
|
5
|
-
import { getMatchingStatusCodeRange } from '../../utils';
|
|
6
|
-
|
|
7
|
-
export const ResponseContainsHeader: Oas3Rule | Oas2Rule = (options) => {
|
|
8
|
-
const names: Record<string, string[]> = options.names || {};
|
|
9
|
-
return {
|
|
10
|
-
Operation: {
|
|
11
|
-
Response: {
|
|
12
|
-
enter: (response: Oas2Response | Oas3Response, { report, location, key }: UserContext) => {
|
|
13
|
-
const expectedHeaders =
|
|
14
|
-
names[key] ||
|
|
15
|
-
names[getMatchingStatusCodeRange(key)] ||
|
|
16
|
-
names[getMatchingStatusCodeRange(key).toLowerCase()] ||
|
|
17
|
-
[];
|
|
18
|
-
for (const expectedHeader of expectedHeaders) {
|
|
19
|
-
if (
|
|
20
|
-
!response?.headers ||
|
|
21
|
-
!Object.keys(response?.headers).some(
|
|
22
|
-
(header) => header.toLowerCase() === expectedHeader.toLowerCase()
|
|
23
|
-
)
|
|
24
|
-
) {
|
|
25
|
-
report({
|
|
26
|
-
message: `Response object must contain a "${expectedHeader}" header.`,
|
|
27
|
-
location: location.child('headers').key(),
|
|
28
|
-
});
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
},
|
|
32
|
-
},
|
|
33
|
-
},
|
|
34
|
-
};
|
|
35
|
-
};
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
import type { Oas2Rule, Oas3Rule } from '../../visitors';
|
|
2
|
-
import type { UserContext } from '../../walk';
|
|
3
|
-
import type { Oas2Schema } from '../../typings/swagger';
|
|
4
|
-
import type { Oas3Schema, Oas3_1Schema } from '../../typings/openapi';
|
|
5
|
-
import { OasVersion } from '../../oas-types';
|
|
6
|
-
|
|
7
|
-
const SCALAR_TYPES = ['string', 'integer', 'number', 'boolean', 'null'];
|
|
8
|
-
|
|
9
|
-
export const ScalarPropertyMissingExample: Oas3Rule | Oas2Rule = () => {
|
|
10
|
-
return {
|
|
11
|
-
SchemaProperties(
|
|
12
|
-
properties: { [name: string]: Oas2Schema | Oas3Schema | Oas3_1Schema },
|
|
13
|
-
{ report, location, oasVersion, resolve }: UserContext
|
|
14
|
-
) {
|
|
15
|
-
for (const propName of Object.keys(properties)) {
|
|
16
|
-
const propSchema = resolve(properties[propName]).node;
|
|
17
|
-
|
|
18
|
-
if (!propSchema || !isScalarSchema(propSchema)) {
|
|
19
|
-
continue;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
if (
|
|
23
|
-
propSchema.example === undefined &&
|
|
24
|
-
(propSchema as Oas3_1Schema).examples === undefined
|
|
25
|
-
) {
|
|
26
|
-
report({
|
|
27
|
-
message: `Scalar property should have "example"${
|
|
28
|
-
oasVersion === OasVersion.Version3_1 ? ' or "examples"' : ''
|
|
29
|
-
} defined.`,
|
|
30
|
-
location: location.child(propName).key(),
|
|
31
|
-
});
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
},
|
|
35
|
-
};
|
|
36
|
-
};
|
|
37
|
-
|
|
38
|
-
function isScalarSchema(schema: Oas2Schema | Oas3Schema | Oas3_1Schema) {
|
|
39
|
-
if (!schema.type) {
|
|
40
|
-
return false;
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
if (schema.allOf || (schema as Oas3Schema).anyOf || (schema as Oas3Schema).oneOf) {
|
|
44
|
-
// Skip allOf/oneOf/anyOf as it's complicated to validate it right now.
|
|
45
|
-
// We need core support for checking contrstrains through those keywords.
|
|
46
|
-
return false;
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
if (schema.format === 'binary') {
|
|
50
|
-
return false;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
if (Array.isArray(schema.type)) {
|
|
54
|
-
return schema.type.every((t) => SCALAR_TYPES.includes(t));
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
return SCALAR_TYPES.includes(schema.type);
|
|
58
|
-
}
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { Oas3Rule, Oas2Rule } from '../../visitors';
|
|
2
|
-
import { Location } from '../../ref-utils';
|
|
3
|
-
import { UserContext } from '../../walk';
|
|
4
|
-
import { Oas2Definition, Oas2Operation, Oas2SecurityScheme } from '../../typings/swagger';
|
|
5
|
-
import { Oas3Definition, Oas3Operation, Oas3SecurityScheme } from '../../typings/openapi';
|
|
6
|
-
|
|
7
|
-
export const SecurityDefined: Oas3Rule | Oas2Rule = () => {
|
|
8
|
-
const referencedSchemes = new Map<
|
|
9
|
-
string,
|
|
10
|
-
{
|
|
11
|
-
defined?: boolean;
|
|
12
|
-
from: Location[];
|
|
13
|
-
}
|
|
14
|
-
>();
|
|
15
|
-
|
|
16
|
-
const operationsWithoutSecurity: Location[] = [];
|
|
17
|
-
let eachOperationHasSecurity: boolean = true;
|
|
18
|
-
|
|
19
|
-
return {
|
|
20
|
-
Root: {
|
|
21
|
-
leave(root: Oas2Definition | Oas3Definition, { report }: UserContext) {
|
|
22
|
-
for (const [name, scheme] of referencedSchemes.entries()) {
|
|
23
|
-
if (scheme.defined) continue;
|
|
24
|
-
for (const reportedFromLocation of scheme.from) {
|
|
25
|
-
report({
|
|
26
|
-
message: `There is no \`${name}\` security scheme defined.`,
|
|
27
|
-
location: reportedFromLocation.key(),
|
|
28
|
-
});
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
if (root.security || eachOperationHasSecurity) {
|
|
33
|
-
return;
|
|
34
|
-
} else {
|
|
35
|
-
for (const operationLocation of operationsWithoutSecurity) {
|
|
36
|
-
report({
|
|
37
|
-
message: `Every operation should have security defined on it or on the root level.`,
|
|
38
|
-
location: operationLocation.key(),
|
|
39
|
-
});
|
|
40
|
-
}
|
|
41
|
-
}
|
|
42
|
-
},
|
|
43
|
-
},
|
|
44
|
-
SecurityScheme(_securityScheme: Oas2SecurityScheme | Oas3SecurityScheme, { key }: UserContext) {
|
|
45
|
-
referencedSchemes.set(key.toString(), { defined: true, from: [] });
|
|
46
|
-
},
|
|
47
|
-
SecurityRequirement(requirements, { location }) {
|
|
48
|
-
for (const requirement of Object.keys(requirements)) {
|
|
49
|
-
const authScheme = referencedSchemes.get(requirement);
|
|
50
|
-
const requirementLocation = location.child([requirement]);
|
|
51
|
-
if (!authScheme) {
|
|
52
|
-
referencedSchemes.set(requirement, { from: [requirementLocation] });
|
|
53
|
-
} else {
|
|
54
|
-
authScheme.from.push(requirementLocation);
|
|
55
|
-
}
|
|
56
|
-
}
|
|
57
|
-
},
|
|
58
|
-
Operation(operation: Oas2Operation | Oas3Operation, { location }: UserContext) {
|
|
59
|
-
if (!operation?.security) {
|
|
60
|
-
eachOperationHasSecurity = false;
|
|
61
|
-
operationsWithoutSecurity.push(location);
|
|
62
|
-
}
|
|
63
|
-
},
|
|
64
|
-
};
|
|
65
|
-
};
|