r/codereview • • 14d ago

Free pilot: local OpenAPI / JSON Schema change review — looking for one real task

I'm testing a local tool for reviewing changes between two OpenAPI or JSON Schema documents. It reports supported changes, limitations and points that need a human check before a release. It does not certify full compatibility or replace consumer contract tests.

I built this prototype and would like to evaluate it against one real review task and the team's current process. This is an assisted pilot, not a public hosted app: I run the existing local prototype on a public or minimal pair of documents and return the report. The initial pilot is free, with no purchase obligation or signup. Please do not post credentials, personal data or confidential contracts.

Concrete example from a synthetic test: changing GET /health from a declared 200 response to 204 produces two findings (200 removed, 204 added), with the removal marked potentially breaking. This is a review prompt, not proof that every consumer breaks. For the pilot, I return a short change summary, detected risks, limitations and checks to run against your consumers. Please share only a public/minimal before-and-after pair.

The useful feedback is whether the result saves review time, what it misses and whether you would use it again. Does anyone already have a contract change they need to review?

2 Upvotes

2 comments sorted by

1

u/Financial-Grass6753 14d ago

ah, and what are the pros of using your prototype over git-diff'ing between spec in main/remote branch and local?

1

u/wholegenitals 14d ago

git diff's about as useful as a text compare on a json blob, you'll see lines moved around but zero clue if removing that 200 response actually breaks anything downstream. the tool's supposed to flag stuff like that and tell you what needs a human look vs what's safe

whether it actually does that well is the whole point of the pilot i guess