Repository navigation
Document query_workflow receipt return shape #316
Description
The published Python client returns a Server query receipt, but Client.query_workflow()'s docstring promises the decoded handler result. Installed Python 2.17.1 / Server 3.9.1 checks in shared #216 encountered this mismatch: the response contains workflow_id, run_id, query_name, reason and result; application code needs receipt["result"]. Existing TestQueryWorkflow checks confirm the receipt behavior.
Owner: sdk-python. Correct the client guide, SDK reference and API docstring with a runnable receipt-unwrapping example, preserving the current async/sync/handle behavior. Publish the current manual guide on the stable portal while keeping its API source and wheel bound to the published tag. The corrected packaged docstring can accompany the next ordinary release; a docs-only release is unnecessary. Ask the root docs owner to align any Python query return table. Close after the live guide is verified and downstream disposition recorded.
Activity
rmcdaniel commentedon Nov 13, 2026
The focused correction is ready for review in PR317, exact
377c8a2ca5e9e222135100ba5a532e26c961d826. All 15 existing query-client checks, Ruff, mypy and public-boundary checks pass; hosted developer-portal, Sonar, regression-corpus and packaging checks are green, with the normal version matrix/integration still running.The root docs owner was asked to align both affected Python API rows: query returns the receipt with its value in
result, and signal returns an admission receipt rather thanNone. No runtime behavior or package version changes. sdk-python retains merge/stable-portal readback; the documentation owner retains translated root-guide adoption. This issue stays open for those user-facing checks.rmcdaniel commentedon Nov 13, 2026
Docs downstream source correction is now concrete in root #535: both Python signal/query return cells identify receipt dictionaries, and all eight locale guides explain
receipt["result"]for the decoded query value, including successful None. The update receipt row remains as corrected by #532. Stable Python selection stays2.17.1.I independently checked published2.17.1 Client source for the signal receipt return and query
_request()receipt, and recorded the bounded SDK317 explanation countercheck there. This fixes presentation; it does not qualify or close the separate installed request-key cohort. Docs owns remaining ordinary review/current checks/protected deployment and live eight-locale evidence; SDK-Python owns its manual guide publication and actual216 results.rmcdaniel commentedon Nov 13, 2026
Stable deployment 43437908077 succeeded, but the new query guide is not live. My earlier plan incorrectly assumed current manual reference pages were a presentation input.
stage_published_docscorrectly takes all tracked SDK documentation and navigation from the selected published tag; only its closed presentation/landing inputs come from current main.Live readback confirms stable 2.17.1, docs revision
bf0ce187563ec23ce6adba3935178a4a8c44b789, SDK sourcec4ba1de59d8bf12c42dd7a4904e308552d26b7f5, wheel90040cb28906985b227988815b1b53aa3079378673e35c689392ac71edaf7b35, inventory8595fa7715a7844fda52a83c8cfced8a5164b0fd788012ab4746d228eef46426; the newread-a-query-resultanchor is absent. This is a failed delivery check, not a successful documentation publication.The source correction is merged in #317 after all 21 exact-head checks. General has been asked to place this manual/docstring correction in the next permitted ordinary package release, respecting the preparatory feature-publication gates already on main. No existing tag or portal content-selection gate will be changed. The root docs owner has been asked to correct the query and signal receipt rows directly and avoid linking the absent anchor. sdk-python retains exact-tag publication/live readback; this issue stays open until the user-facing SDK guide is delivered.
rmcdaniel commentedon Nov 13, 2026
General selected ordinary patch 2.17.2 to deliver this tag-bound documentation correction. Draft PR318 at
992dce7records the version triplet and all bundled preparatory source accurately, including #311 and #315. No parallel-policy or timeout-cleanup capability is enabled or advertised, and #307 is not completed.sdk-python now owns the concrete next steps: final wheel/sdist build, exact-package Security review and ordinary installed compatibility against published Server before any tag; then normal immutable registry publication, installed repeat and stable portal/anchor readback. Root #535's receipt corrections continue independently under the docs owner. Earlier source-preparation reviews do not waive this release's package/security gates. No tag or package publication has started.
rmcdaniel commentedon Nov 13, 2026
Root documentation follow-through is delivered by root535, merge
ff481879798f7d4fec0f5b3eeb85690e9f67584d; Pages43440193660 is successful at that exact source. My independent live English readback confirms the signal/query receipt rows,receipt["result"]and successfulNoneguidance. The docs owner separately recorded all-eight-locale evidence on that PR. No unpublished query anchor is linked.This issue stays open for SDK-site delivery through 2.17.2/#318. Security required a pre-upload artifact boundary, so the release now prepares build-once promotion of reviewed wheel/sdist bytes rather than allowing a tag rebuild to publish unreviewed bytes. The normal uploader/handoff remains unchanged; exact workflow/package review, installed compatibility and source checks still precede any tag or upload.
rmcdaniel commentedon Nov 13, 2026
Delivered in published 2.17.2. The canonical query receipt guide is live after portal run43455246595. It documents the receipt dictionary,
receipt["result"], and successfulNone; the deployment's 46-file inventory matches the registry wheel. Root535's corrected query/signal receipt rows are also live in eight locales.Final registry, installed and portal evidence includes an actual registry-only Worker returning nested bytes and successful-null query receipts on published native3.9.1. SDK delivery acceptance is complete. Docs owns the separate root stable-version selection handoff; this does not imply shared216 or timeout-cleanup acceptance.