Error Suppression?

[sjstraw]

Hi, all -

We'd love to apply Spectral to help our devs use our API style guide for new development. But we aren't starting from scratch; there will be a bunch of APIs which won't adhere to our rules at first, so we will need to go through the process of recreating those APIs and deprecating the old ones.

As this goes on, we will have to tolerate specific non-conforming APIs for awhile while catching new APIs which don't conform.

What facilities does Spectral have that would allow us to suppress errors on specific APIs, so that CI passes, while we clean things up over time?

The docs for Spectral don't seem to mention suppression. However, it might be possible to define rules or functions which intentionally ignore some content. What's the best way to do this?

[P0lip]

Hey!
Have you considered using overrides?
I believe this might be a perfect fit for your use case.

[sjstraw]

Yes, this seems like exactly what I was looking for!

Thanks much for pointing me in the right direction!

Do these work with the standard rule sets as well with custom rule sets?

[P0lip]

Yes, they work for both the standard rulesets as well as the custom rulesets.
We've just updated docs and added more examples https://github.com/stoplightio/spectral/blob/29576f0fd75faebc4087c23e3746450c54dda0f9/docs/guides/4-custom-rulesets.md#overrides

[sjstraw]

Nice! Thanks, Jakub!

…

On Tue, Aug 31, 2021 at 12:56 PM Jakub Rożek ***@***.***> wrote: Yes, they work for both the standard rulesets as well as the custom rulesets. We've just updated docs and added more examples https://github.com/stoplightio/spectral/blob/29576f0fd75faebc4087c23e3746450c54dda0f9/docs/guides/4-custom-rulesets.md#overrides — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1791 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACM7WPB4M7NK5TNBI7QICPLT7UJTVANCNFSM5C5RGQMQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.