Workflow Code Review

Review API Changes

Review workflow for changes that affect the public API

reviewapicompatibility
CLAUDE.md

When reviewing changes to a public API:

  1. Check for breaking changes: removed fields, renamed parameters, changed response shapes, new required fields.
  2. If breaking changes exist, verify the API version has been bumped.
  3. Check that new endpoints have input validation and return consistent error shapes.
  4. Check that the API documentation has been updated to match the changes.
  5. Check backwards compatibility: will existing clients break? Is there a migration path?
  6. Verify error codes and messages are helpful for API consumers.
  7. Check rate limiting and auth requirements on new endpoints.

Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.

get crystl