Add B10 API spec drift rule to connector review mixin - #118
Merged
Merged
Conversation
The connector mixin covered newly added endpoints (B7, B8) but had no criterion for an existing endpoint being changed, so version/path swaps and response shape changes could pass review unflagged. B10 triggers only on endpoint change or addition. A changed endpoint is diffed against the checked-in api.yaml and reported as a blocking correctness break when the schema differs; an added endpoint is a suggestion to regenerate the spec. Both point the author at the build-openapi-spec.md skill. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Rename the spec reference from api.yaml to the real path, spec/openapi.json. Also require the regeneration prompt whenever an endpoint changes without a corresponding spec update, not only when the schema visibly differs. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
jugonzalez12
approved these changes
Sep 15, 2026
laurenleach
approved these changes
Sep 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The connector review mixin covered newly added endpoints (B7, B8) but had no criterion for an existing endpoint being changed. A version or path swap (
/v1/users→/v2/users), a renamed ID field, or a changed pagination style could pass review unflagged — the downstream rules (B1, B3) only catch the symptom if the reviewer connects the dots.B10 closes that gap and ties both cases to the
build-openapi-spec.mdskill.The rule
spec/openapi.json. Any schema difference (path/version change, field added/removed/renamed/retyped, ID field change, pagination style change) is reported asblocking-correctness. Ifspec/openapi.jsonwasn't updated in the PR it is stale, and that is reported too — atsuggestionseverity when the schema itself looks unchanged. Either way the author is told to regenerate the spec with the skill. If nospec/openapi.jsonexists, it falls through to the added-endpoint branch.suggestionasking the author to run the skill sospec/openapi.jsoncovers the new endpoint.Severity names match the base prompt's vocabulary (
blocking-correctness/suggestion, seebase-pr-review.md), so the reviewer maps them to the right merge gate.Note for reviewers
spec/openapi.jsonand thebuild-openapi-spec.mdskill both live in the connector repos being reviewed, not here. If the skill is invoked under a different name there, the rule text should be updated to match.🤖 Generated with Claude Code