Allow url accessible rules - Githubissues

opticdev / optic

OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.

https://useoptic.com

MIT License

1.35k stars 79 forks source link

Allow url accessible rules #2848

Closed niclim closed 2 months ago

niclim commented 2 months ago

🍗 Description

What does this PR do? Anything folks should know?

Handles the different ways to specify your ruleset and allows it to be downloaded via URL (e.g. github URL)

from the optic.yml file -> extends key
- in the optic.yml config: extends: https://gist.githubusercontent.com/niclim/9daff82cf3f68386fa24fec689796c18/raw/59f441e0bfe3911891e897fec6b8d515214a4047/gistfile1.txt
from the x-optic-standard key
- e.g. in the api file x-optic-standard: https://gist.githubusercontent.com/niclim/9daff82cf3f68386fa24fec689796c18/raw/59f441e0bfe3911891e897fec6b8d515214a4047/gistfile1.txt

Also handles the hosting rule definitions locally

from the hosted custom rule -> can point to a GH url

📚 References

Links to relevant docs (Notion, Twist, GH issues, etc.), if applicable.

👹 QA

How can other humans verify that this PR is correct?