Skip to content

Pin examples to API version 2026-09-22 - #358

Open
purpshell wants to merge 1 commit into
mainfrom
docs/api-version-2026-09-22
Open

purpshell wants to merge 1 commit into
mainfrom
docs/api-version-2026-09-22

Conversation

@purpshell

@purpshell purpshell commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

Summary

The API now accepts only Polymorfa-Version: 2026-09-22 (polymorfa/polymorfa#782). The TypeScript and browser SDKs already default to 2026-09-22. This PR updates the places that still pinned 2026-03-20:

  • the root README (API versions section);
  • the @polymorfa/sdk README example;
  • the @polymorfa/browser README note on retired versions;
  • examples/full-platform/lib/polymorfa.ts;
  • the retired-version test fixtures, which now use 2026-03-20 as the refused version.

Impact

Impact table

Area Updated / blocked Change or named blocker Paths / companion PRs / evidence
SDK docs and examples Updated Pins move to 2026-09-22. README.md, packages/*/README.md, examples/full-platform
SDK tests Updated Retired-version fixtures match the new API message. packages/*/test/transport.test.ts

No impact table

Area Why there is no impact Supporting paths or evidence
SDK runtime Defaults are already 2026-09-22, and nothing branches on the version. packages/typescript/src/version.ts, packages/browser/src/transport.ts
Go, Python, PHP, Rust and C# SDKs Not on main yet (#348 is a draft). #348
Published packages No version bump needed. Docs and tests only.

Verification

npx vitest run packages/typescript/test/transport.test.ts packages/browser/test/transport.test.ts: 2 files, 37 tests passed.

Session provenance and UI evidence

  • Agent: Claude Opus 5.5 through T3 Code, registration polymorfa/polymorfa#540. The transcript checkpoint is blocked by the known T3 v2 recorder gap.
  • UI: none.

Rollout and rollback

Merge in either order with polymorfa/polymorfa#782. To roll back, revert this commit.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

Summary by CodeRabbit

  • Documentation
    • Updated API guidance and examples to use 2026-09-22 as the minimum supported revision and default.
    • Clarified that requests pinned to earlier revisions, such as 2026-03-20, receive an error rather than being automatically upgraded and retried.
  • Tests
    • Updated version-rejection checks to reflect the new minimum revision.

The API now refuses Polymorfa-Version 2026-03-20 (polymorfa/polymorfa#782).
The SDKs already default to 2026-09-22; update the README pins, the
full-platform example and the retired-version test fixtures to match.

Co-Authored-By: Claude <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-19T14:46:31.901655Z 40483fc PR opened
🔒 Security Review ✅ Completed 2026-10-19T14:47:02.519530Z 40483fc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Team
  • Run ID: 3b16f3db-863b-45b8-8022-7dede61a0c4d
📥 Commits

Reviewing files that changed from the base of the PR and between d2c5b3d and 40483fc.

📒 Files selected for processing: 6
  • README.md
  • examples/full-platform/lib/polymorfa.ts
  • packages/browser/README.md
  • packages/browser/test/transport.test.ts
  • packages/typescript/README.md
  • packages/typescript/test/transport.test.ts

Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

📝 Walkthrough

The documented minimum accepted API revision is now 2026-09-22. Example and shared client configurations use that revision. Browser and TypeScript transport tests use 2026-03-20 as the retired explicit revision and retain assertions for the error response, one request, and the supplied version header.

Changes: API revision cutoff

Layer / File(s) Summary
Update documented and configured revisions
README.md, packages/browser/README.md, examples/full-platform/lib/polymorfa.ts, packages/typescript/README.md
Documentation identifies 2026-09-22 as the minimum accepted revision. Client configuration examples use 2026-09-22.
Update retired-revision transport tests
packages/browser/test/transport.test.ts, packages/typescript/test/transport.test.ts
Tests use 2026-03-20 as the explicit retired revision and expect the 2026-09-22 minimum. They retain assertions for an invalid_parameter rejection, one request, and the supplied version header.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 40483

The documentation and examples identify the 2026-09-22 API revision, while tests exercise rejection of the retired 2026-03-20 revision. No actionable merge risk is evident from the supplied change context.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 3 files. (3 skipped: 3 … Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly describes the primary change: updating examples and related references to API version 2026-09-22. It is concise and specific.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 3 files. (3 skipped: 3 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

  • Fix all pre-merge checks with AI
✨ Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant