How to ignore/disable rules for specific matches

[josephearl]

I am using Spectral CLI and have a .spectral.yaml configuration with:

extends: "@my-org/custom-ruleset"

When running Spectral with this configuration against my OpenAPI yaml I get some errors:

/path/to/openapi.yaml
 254:32  error  custom-object-properties-rule  Object properties should be camelCase  components.schemas.AnObject.properties.thePropertyName

In this case it is intended that this object property does not match the rule, and so I'd like to ignore this match

I have tried some variations on match_ignores in my configuration yaml, but that just seems to result in an error when running Spectral, e.g. adding:

match_ignores:
  ignores:
    - rule_id: custom-object-properties-rule
      match_text: "components.schemas.AnObject.properties.thePropertyName"

results in:

Error running Spectral!
Error #1: [object Object]

[josephearl]

To answer my own question, need to add

overrides:
  - files:
      - "/path/to/openapi.yaml#/components/schemas/AnObject/properties/thePropertyName"
    rules:
      custom-object-properties-rule: "off"

[rustonaut]

as mentioned in the documentation https://meta.stoplight.io/docs/spectral/293426e270fac-overrides this only works for root files

This means the moment you have $ref to other files this solutions stops working reliably/consistently.

[sayeedhussain]

@josephearl the solution mentioned by you is not working for me as of today. I am using spectral docker image.

[jarrod-lowe]

For the sake of anyone else who, like me, have been trying to use match_ignores and found this page... The documentation that turns up on google is actually for a different product - spectralops. Spectral has no match_ignores option, you need to use the overrides as shown in the accepted answer.