feat(sdk): adopt standard API vocabulary - #47
Open
necolas wants to merge 2 commits into
Open
Conversation
Callers can use the standard API names in each SDK while existing code continues to use the deprecated public aliases. Expose the preferred request and result names across TypeScript, Python, and Go. Send only standard HTTP fields. Read both response generations, and prefer the standard field when both forms exist.
This was referenced Aug 29, 2026
Callers can keep the TypeScript targetRef and Go TargetRef options without a deprecation warning. Both forms still accept fully qualified branch refs and send the current target_branch HTTP field. Add a neutral TypeScript option type while keeping the published legacy name as a compatibility type.
necolas
added a commit
that referenced
this pull request
Aug 29, 2026
Keep the route migration on the latest PR #47 contract. Preserve commit target-ref options without a deprecation and combine both TypeScript compatibility checks.
rkdud007
approved these changes
Aug 31, 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
2 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
targetRefand GoTargetRefsupported without a deprecationThe commit target-ref options remain limited to fully qualified
refs/heads/*values. They normalize to the currenttarget_branchHTTP field.targetBranchorTargetBranchwins when both forms reach the request.A future generic ref-write change can broaden these options and make them preferred without asking callers to migrate away from them first.
Compatibility gate
This PR adds fields to exported Go structs. Documented keyed literals remain valid. External unkeyed composite literals can stop compiling. The release owner must resolve this compatibility decision before publication.
Verification
pnpm exec vitest --run— 217 tests passedpnpm build— passedpnpm exec tsc --project tsconfig.type-tests.json— passed./venv/bin/pytest -v— 192 tests passedgo test ./...— passedgit diff --checkand the added-line secret scan — passed