Repository navigation
DID-10196: [VER2-PY] sdk-python: DESIGN.md 3.1 detection rules and the shared openapi/breaking-vectors.json - #26
Merged
Merged
Conversation
…e shared openapi/breaking-vectors.json
…e shared openapi/breaking-vectors.json
arosasg
added a commit
that referenced
this pull request
Nov 8, 2026
The last commit of the vectors pull request (#26) was pushed after it merged, so main kept 73 cases while sdk-node, sdk-go, sdk-java, sdk-php and sdk-dotnet copied the 75-case file from its branch. This lands that commit: the cases union-required-field-no-longer-required and union-variant-numbered-with-its-null-variant, the generator entries and the detector change they need. openapi/breaking-vectors.json now has the same bytes as the other repositories (SHA-256 5c9a66000f9743f9...). Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Problem
The seven server SDKs' spec syncs disagree on edge cases (removed parameters, nullable request values, format changes,
server: falseoperations), so one upstream change can produce seven different "Breaking changes" lists. DESIGN.md 3.1 named the categories but not the exact rules, and nothing shared checked them.Solution
2f22a158…).codegen/spec_sync.py) follows the rules. Changes from today:server: falseoperations.type string -> null(null= no body left).BreakingChange.normalized()gives<METHOD> <path> <where> <field>: <kind>;classify(before, after)runs the real sync on two documents. Parameters now read "query parameterlimit" in the summary.codegen/breaking_vectors.pywritesopenapi/breaking-vectors.json: 73 hand-written cases, at least two per DESIGN.md bullet. It refuses to write while the detector disagrees, and--checkreports a stale file.ci:, so this releases nothing.Verification
test_breaking_vectors.py,test_spec_sync.py,test_codegen.py: 171 passed. Every vector passes, renders are byte-identical, the 2026-11-04 pair still gives 14 changes and 2026-11-06 "None detected".openapi/breaking-vectors.jsonwith identical bytes and--checkpasses.31102cb: every job passed (tests on Linux, macOS and Windows, Python 3.10 to 3.14, lint, type check, generated code, build, secret scan). The live sandbox tests were skipped because CI has no sandbox key.🤖 Generated with Claude Code