Ignoring changes in certain fields.

[seriouslag]

Could you provide more test or examples of modifying the rules.

I would like to add a rule to ignore changes in the 'example' fields
https://learn.openapis.org/specification/docs.html#adding-examples

[seriouslag]

I found you can take the diff results and filter them.

Feels clunky but works.

import { compareOpenApi } from 'api-smart-diff';
...
const { diffs } = compareOpenApi(existingSpec, newSpec);
const filteredDiffs = diffs.filter((diff) => {
  if (diff.path.includes('examples') || diff.path.includes('example')) {
    return false;
  }
  return true;
});
const areSpecsEqual = filteredDiffs.length === 0;

...