SDK consistency (tenants.list) and v0.14 upgrade guide#751
Merged
Conversation
…s 0) Made-with: Cursor
Made-with: Cursor
Made-with: Cursor
…s.txt, README Made-with: Cursor
- Add upgrade-v0.14.mdx with full v0.14 breaking changes and new section for list tenants: method rename (listTenants → list) and request object in all SDKs (TypeScript, Go, Python) - Add Upgrade to v0.14 link to docs/pages/guides.mdx Supersedes PR #745 (docs/upgrade-v0.14) with complete guide. Made-with: Cursor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns the “list tenants” SDK surface area across languages (intended rename to tenants.list with a single request object, consistent with events.list / attempts.list) and adds a comprehensive v0.14 upgrade guide to the docs.
Changes:
- Adds a new spec SDK test for listing tenants via
tenants.list(request). - Updates docs navigation and adds a v0.14 upgrade guide (including the tenants list breaking change section).
- Updates SDK regeneration scripts and several language examples to use the new
tenants.listAPI shape.
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| spec-sdk-tests/tests/tenants.test.ts | New TS spec test for tenants.list(request) |
| spec-sdk-tests/scripts/regenerate-sdk.sh | Adjusts Go regeneration/build behavior and environment handling |
| sdks/schemas/speakeasy-modifications-overlay.yaml | Adds Speakeasy overlay intending to rename /tenants GET to list + request object |
| examples/sdk-typescript/auth.ts | Adds TS example call to list tenants |
| examples/sdk-python/run-auth.sh | Adds helper script to run Python example via venv |
| examples/sdk-python/requirements.txt | Adds pip requirements for the Python example |
| examples/sdk-python/example/auth.py | Adds Python example call to list tenants via request object |
| examples/sdk-python/README.md | Documents the new run script / setup options |
| examples/sdk-go/go.mod | Updates indirect deps |
| examples/sdk-go/go.sum | Updates checksums for Go example deps |
| examples/sdk-go/auth.go | Adds Go example call to list tenants via request object |
| docs/pages/guides/upgrade-v0.14.mdx | Adds full v0.14 upgrade guide |
| docs/pages/guides.mdx | Adds nav link to the v0.14 upgrade guide |
| contributing/sdks.md | Notes Go cache env vars workaround for regeneration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+209
to
+218
| - target: $["paths"]["/tenants"]["get"] | ||
| update: | ||
| x-speakeasy-name-override: list | ||
| x-speakeasy-max-method-params: 0 | ||
| x-speakeasy-metadata: | ||
| after: sdk.tenants.list() | ||
| before: sdk.Tenants.listTenants() | ||
| created_at: 1745611620645 | ||
| reviewed_at: 1745611624395 | ||
| type: method-name |
…-params test - Upgrade guide: use simple []string for Go (tenantId/topic), not tagged unions - spec-sdk-tests: add test that events.list accepts array params (tenantId, topic) Made-with: Cursor
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
alexluong
approved these changes
Mar 13, 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
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
tenants.listTenants→tenants.list(andTenants.List/tenants.list) with a single request object in all SDKs (TypeScript, Go, Python), consistent withevents.listandattempts.list.docs/pages/guides/upgrade-v0.14.mdx) including the new List tenants: method rename and request object section, plus nav link inguides.mdx.Supersedes
Closes / supersedes #745 (docs/upgrade-v0.14). This PR includes the complete v0.14 upgrade guide (PostgreSQL TEXT migration, array query params, Python
body=, relaxed URL validation, emptycustom_headers) and adds thetenants.listbreaking-change section and the guides nav link.Checklist
guides.mdxMade with Cursor