Repository navigation
docs: async queries reject task history; /v1/search rejects empty text - #2412
Conversation
✅ Pull with Spice PassedPassing checks:
|
There was a problem hiding this comment.
🟢 Approved
Both documentation updates match the supplied runtime evidence, with no unresolved findings.
No open issues 🎉
What changed in this PR
Updates vNext documentation to reflect runtime restrictions on async queries and search requests. Versioned documentation remains unchanged.
Changes:
- Documents unsupported async-query sources, synchronous alternatives, and the rejection error code.
- Clarifies that search text must contain a non-whitespace character.
| File | Description |
|---|---|
| website/public/openapi.json | Clarifies the search text requirement. |
| website/docs/features/distributed-query/index.md | Documents async-query restrictions and alternatives. |
Review effort: Balanced
|
🚀 deployed to https://e3befbce.spiceai-org-website.pages.dev |
|
Needs a maintainer: approve the workflow runs on The
To unblock: approve the three runs from the Actions tab. Once |
|
🚀 deployed to https://035657b4.spiceai-org-website.pages.dev |
|
🚀 deployed to https://2a57e1ee.spiceai-org-website.pages.dev |
|
🚀 deployed to https://81f5d619.spiceai-org-website.pages.dev |
Summary
Documents two user-visible changes from
spiceai/spiceaimerged between 2026-10-14 and 2026-10-21. Both are vNext only: neither merge commit is in av2.3.*orv2.4.0-rc.*tag, sowebsite/versioned_docs/is unchanged.runtime.task_historyorruntime.local_task_historynow fails, because task history is read only on the scheduler. The "Defaults and Limitations" list on the distributed query page now states this, together with the existing rejection of locally accelerated datasets and Cayenne catalog tables, which the list did not mention./v1/searchrejects empty text (fix(search): reject empty or whitespace-only text on /v1/search spiceai#15119). Thetextfield's description inwebsite/public/openapi.jsonnow matches the runtime spec: it must contain at least one non-whitespace character.Generated API pages
Editing
website/public/openapi.jsontriggers theGenerate API Docsworkflow, which regenerateswebsite/docs/api/HTTP/from this file. This PR changes one description string and no paths, so the regeneration only rewrites thepost-searchrequest schema. The docs spec also lacks three endpoints that the runtime spec has (POST /v1/decisions,GET /v1/nsql/context,GET /v1/tools/search). That drift predates this PR and is out of scope:Source PRs
Verification
Every value below was read from
spiceai/spiceaiorigin/trunkat437273525b132f821051335b183f7c0319354045. These are name, existence, and value claims taken from code; no cluster was run, so the async-query rejection is Unverified, code inspection only beyond what these lines show.Local build at the branch head:
Test plan
cd website && npm run buildexits 0 (output above)git diff --name-only origin/trunk..HEAD