Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix #915: Ignore examples with circular schemas #923

Closed
wants to merge 14 commits into from
Closed

fix #915: Ignore examples with circular schemas #923

Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ead745a
First attempt to fix #894: oas3-valid-(content-)schema-example has pr…
m-mohr Jan 14, 2020
31fc677
Use OpenAPI schemas
m-mohr Jan 15, 2020
554b58e
Don't use OpenAPI schemas
m-mohr Jan 15, 2020
3ec31f3
Merge branch 'develop' into patch-3
m-mohr Jan 15, 2020
7d12620
Set default oasVersion
m-mohr Jan 15, 2020
87d8b72
Use optional instead of 0.
m-mohr Jan 16, 2020
08cf665
Merge branch 'develop' into patch-3
m-mohr Jan 16, 2020
2facf24
Fix annoying lint rule
m-mohr Jan 16, 2020
5f735ff
Update src/functions/schema.ts
m-mohr Jan 17, 2020
f43dbe4
Merge branch 'develop' into patch-3
m-mohr Jan 17, 2020
03270c7
Ignore examples with circular references #915
m-mohr Jan 17, 2020
0dd6524
Merge remote-tracking branch 'upstream/develop' into patch-4
m-mohr Jan 21, 2020
d17f92b
Fix lint issues
m-mohr Jan 21, 2020
6f642cf
Merge branch 'develop' into patch-4
Jan 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/functions/schema-path.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export interface ISchemaPathOptions {
field?: string;
// The oasVersion, either 2 or 3 for OpenAPI Spec versions, could also be 3.1 or a larger number if there's a need for it, otherwise JSON Schema
oasVersion?: Optional<number>;
// Whether to ignore circular schemas (true) or not (false)
ignoreCircular?: boolean;
}

export type SchemaPathRule = IRule<RuleFunction.SCHEMAPATH, ISchemaPathOptions>;
Expand All @@ -34,6 +36,10 @@ export const schemaPath: IFunction<ISchemaPathOptions> = (targetVal, opts, paths

const results: IFunctionResult[] = [];

if (opts.ignoreCircular && JSONPath({ path: '$..$ref', json: schemaObject }).length > 0) {
return results;
}

for (const relevantItem of relevantItems) {
const result = schema(
relevantItem.value,
Expand Down