Repository navigation
Fix example IDs and list-syndicates params in code examples - #4
Merged
Merged
Conversation
The docs site vendors examples_manifest.json as x-codeSamples, and the installation samples used an ID prefix the API does not issue (Wefunder/wefunder#23500): - installations: ins_9t2xExample -> inst_7hQExampleInstall01 (inst_ prefix) - syn_example / syn_abc123Example placeholders -> the swagger syn_ example Example values are copied from swagger/v2/swagger.yaml. The manifest is regenerated with scripts/build_examples_manifest.py. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
rivetbot
approved these changes
Oct 12, 2026
rivetbot
left a comment
rivetbot
left a comment
There was a problem hiding this comment.
Reviewed b23ef38. No blocking findings.
The installation and syndicate example IDs match the canonical API specification, and the existing wrapper signatures and generated request paths accept these string IDs. All 16 extracted example regions match the committed manifest. The Python 3.11–3.13 checks and generated-spec consistency check passed; the 3.11 job reports 170 passing tests.
Validation was read-only source inspection, manifest comparison and CI-log review. I did not rerun tests or call the live API; sandbox e2e is intentionally skipped on pull requests. The release, docs-manifest repin and clean regeneration remain the documented follow-through for #23500.
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.
Part of Wefunder/wefunder#23500
What changed and why
The docs site vendors
examples_manifest.jsonasx-codeSamples, so these snippets show up on docs.wefunder.com. The installation samples used an ID prefix the API does not issue. Formats come fromswagger/v2/swagger.yamlon Wefunder/wefundermaster, and the replacement values are copied from its examples.createInstallationToken,getInstallation,revokeInstallation"ins_9t2xExample""inst_7hQExampleInstall01"inst_…(exampleinst_7hQExampleInstall01)examples/install_target.py, README (syndicates.get,list_syndicate_members)"syn_example"/"syn_abc123Example""syn_aB3xQ9k2vF8mNp1zT5wY7Qc4"syndicate_idissyn_...(swagger example, full length)The other three defects in the issue (
intent_abc123,syndicates.get(42),syndicates.list(limit=...)) do not appear in this repo's examples.getIntent,getSyndicateandlistSyndicateshave no Python example yet.wf.syndicates.get(syndicate_id: str)andwf.intents.get(intent_id: str)are already typed as strings, so this PR makes no client changes.The examples are edited in
examples/*.py.examples_manifest.jsonis regenerated withpython scripts/build_examples_manifest.py, not edited by hand.Verification
Run in a venv with
pip install -e ".[dev]":Found but not changed
spec/openapi.yaml(the synced spec copy) still has oldx-codeSampleswith the bad values (5 hits). It changes on the nextscripts/sync_spec.py, so I did not hand-edit it.After merge
examples_manifest.json. This PR does not bump the version, tag, or release.api-docs/sdk-manifests.config.jsonto the new tag, runyarn sync-sdk-manifests, thenyarn clean-api-docs all && yarn gen-api-docs all, and commit.🤖 Generated with Claude Code