Build tooling/automation to analyze openapi and jsonschema specs for breaking changes

[sunshowers]

We could either use a pre-existing tool or do our own implementation.

Pre-existing tools: (Note, openapi and JSONSchema are different formats that are related):

• https://github.com/Azure/openapi-diff
• https://github.com/criteo/openapi-comparator
• https://www.npmjs.com/package/json-schema-diff
• https://github.com/getsentry/json-schema-diff

Building our own:

• Consider https://github.com/obi1kenobi/trustfall -- it's used in https://github.com/obi1kenobi/cargo-semver-checks which is morally similar

[smklein]

https://github.com/oxidecomputer/omicron/issues/3407 is a related issue we'd like to suss out with these tools

[ahl]

After looking at the tools @sunshowers linked, I'm going to do a time-bounded exploration into what building our own would look like. It seems possible to me that we may want to customize this tool for our purposes in the future so if it's easy enough to build our own, that may pay dividends.

[obi1kenobi]

👋 cargo-semver-checks and Trustfall author here. I just stumbled across this issue.

may want to customize this tool for our purposes in the future

I'd really love to hear more about this, if you're open to chatting about it. I've started building some more tooling that uses the same query-based architecture and applying it to other domains: querying over GitHub data, linting Python APIs for breaking changes, etc. I've also looked into writing linters for OpenAPI and JSONSchema since people keep asking for those.

I realize this issue is pretty old so maybe it's not that important anymore. But if custom linting / monitoring / querying over arbitrary APIs and formats is still interesting for your use cases, I'd love to chat!