docs: synapse pickFile result shape + breakage history#8
Merged
Conversation
The Synapse SDK 0.8.0 changes `FileResult` from carrying `base64Data` to carrying a workspace file `id`. Update the example in apps/synapse to show the new shape and the intended downstream usage (pass id to a tool, tool reads bytes server-side). Add a caution Aside noting that the picker was broken in NimbleBrain hosts before 0.8.0 — the SDK was sending the wrong method name and calls would hang. Tighten the apps/bridge `synapse/request-file` table row to mention the persisted-file shape so readers don't have to cross-reference.
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
1 participant
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
synapse.pickFile()example inapps/synapse.mdxto show the newFileResultshape ({ id, filename, mimeType, size }) and the intended downstream usage — pass theidto a tool, let the tool read bytes server-side via the host's file APIs.pickFile/pickFileswere broken in NimbleBrain hosts before `@nimblebrain/synapse@0.8.0` (the SDK sent `synapse/pick-file` while the host bridge handles `synapse/request-file`; calls would hang).Coordination
This PR documents the post-merge state of two upstream PRs:
Hold this docs PR's merge until after `@nimblebrain/synapse@0.8.0` publishes to npm. Until then, the docs would describe a contract the published SDK doesn't honor yet. Both upstream PRs are linked above.
Test plan