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(rulesets): oasExample should clean id fields from non-schema objects #2561

Merged
merged 1 commit into from
Dec 12, 2023
Merged

fix(rulesets): oasExample should clean id fields from non-schema objects #2561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 packages/rulesets/src/oas/functions/__tests__/oasExample.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ describe('oasExample', () => {
type: 'object',
required: ['id', 'url'],
properties: {
'x-stoplight': {
id: 'abc',
},
id: {
type: 'string',
},
Expand All @@ -122,6 +125,9 @@ describe('oasExample', () => {
format: 'uri',
},
},
'x-stoplight': {
id: 'abc',
},
example: {
id: 'bf23bc970b78d27691e8',
url: 'https://api.example.com/banking/accounts/bf23bc970b78d27691e8',
Expand Down
38 changes: 29 additions & 9 deletions packages/rulesets/src/oas/functions/oasExample.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,17 +111,37 @@ function* getSchemaValidationItems(
}
}

const KNOWN_TRAVERSE_KEYWORDS = [
/* eslint-disable @typescript-eslint/no-unsafe-argument */
...Object.keys(traverse['keywords']),
...Object.keys(traverse['arrayKeywords']),
...Object.keys(traverse['propsKeywords']),
/* eslint-enable @typescript-eslint/no-unsafe-argument */
];

/**
* Modifies 'schema' (and all its sub-schemas) to remove all "example" fields.
* Modifies 'schema' (and all its sub-schemas) to remove all id fields from non-schema objects
* In this context, "sub-schemas" refers to all schemas reachable from 'schema'
* (e.g. properties, additionalProperties, allOf/anyOf/oneOf, not, items, etc.)
* @param schema the schema to be "de-examplified"
* @returns 'schema' with example fields removed
* @param schema the schema to be sanitized
* @returns 'schema' with id fields removed
*/
function deExamplify(schema: Record<string, unknown>): void {
traverse(schema, <traverse.Callback>(fragment => {
if ('example' in fragment) {
delete fragment.example;
function cleanSchema(schema: Record<string, unknown>): void {
traverse(schema, { allKeys: true }, <traverse.Callback>((
fragment,
jsonPtr,
rootSchema,
parentJsonPtr,
parentKeyword,
) => {
if (parentKeyword === void 0 || KNOWN_TRAVERSE_KEYWORDS.includes(parentKeyword)) return;

if ('id' in fragment) {
delete fragment.id;
}

if ('$id' in fragment) {
delete fragment.id;
}
}));
}
Expand Down Expand Up @@ -165,11 +185,11 @@ export default createRulesetFunction<Record<string, unknown>, Options>(
delete schemaOpts.schema.required;
}

// Make a deep copy of the schema and then remove all the "example" fields from it.
// Make a deep copy of the schema and then remove all objects containing id or $id and that are not schema objects.
// This is to avoid problems down in "ajv" which does the actual schema validation.
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
schemaOpts.schema = JSON.parse(JSON.stringify(schemaOpts.schema));
deExamplify(schemaOpts.schema);
cleanSchema(schemaOpts.schema);

for (const validationItem of validationItems) {
const result = oasSchema(validationItem.value, schemaOpts, {
Expand Down