Agents Lookup

Use cases / Decision models (Jev)

Catch API changes that alter meaning without changing shape

Diff two OpenAPI specs in code, then ask Jev whether changed descriptions or fields alter the contract's meaning for clients.

DifficultyAdvanced
Setup time4-8 hours
CategoryDecision models (Jev)

The use case

API teams can catch removed fields with a structural diff, but not a field that keeps its name while its meaning changes, such as an amount moving from cents to dollars in the description. This tool diffs two OpenAPI specs in code first, then asks Jev about each changed description or schema whether a client would now read the contract differently. Possible breaking changes are flagged in the pull request. An API owner decides whether a change needs a new version or a client notice.

Example workflow

  1. Store OpenAPI specs in the repository
  2. Run a structural diff between the base and the PR version
  3. Send each changed field and description pair to Jev with a Noul question on meaning change
  4. Comment flagged items on the pull request
  5. An API owner decides on versioning and client notices

Tools

Risks and guardrails

Sources

Written by Agents Lookup. Credits and official pages for the tools this use case names: