[MAINT]: anicca is no longer maintained

[wolfy1339]

Describe the need

The anicca module is no longer maintained, it's repository is archived.

A replacement will need to be found, as it is no longer maintained, and does not support OpenAPI 3.1

SDK Version

N/A

API Version

N/A

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[kfcampbell]

Here are some cursory options we may consider for replacements:

• OpenAPITools/openapi-diff
  • Can render HTML, markdown, and JSON diffs
  • Java tooling, accessible through Docker
• Azure/openapi-diff
  • Can render JSON diffs
  • Is an NPM module
• Atlassian/openapi-diff
  • Can render JSON diffs
  • Is an NPM module
• opticdev/optic
  • Does not appear to be able to output in anything but a user-readable text format

Are there other alternatives you might be looking at that I'm missing?

[wolfy1339]

I hadn't really looked into replacements myself.

They would need to be tested to make sure they can handle the OpenAPI spec with the limited resources of GitHub Actions.

[gr2m]

When I researched this, all other solutions blew up due to the size of GitHub's schemas. But that was two years ago

[wolfy1339]

I've found https://github.com/Tufin/oasdiff that can diff OpenAPI specs,
It can output text, YAML, HTML, JSON

I have tested it against api.github.com.deref.json and ghec.deref.json and it holds up and is pretty fast at it

Unfortunately, it's output includes the changes to externalDocs properties on the endpoints definitions. Those changes aren't relevant for our needs and would need some post-processing to remove them from the diff

[gr2m]

FYI https://x.com/__xuorig__/status/1729594597922193408?s=46

• https://frevo.dev/
• https://www.oasdiff.com/

[wolfy1339]

Those do look great,
However, frevo is web based, while we would like a CLI and oasdiff doesn't support OpenAPI 3.1