villebro opened a new pull request, #43804:
URL: https://github.com/apache/superset/pull/43804
### SUMMARY
Documentation and OpenAPI-schema follow-ups from a final review of the
`gaq-to-gtf` epic (#43407). All findings were P2/P3; **no runtime behavior
changes**.
**P2 — async chart-data OpenAPI advertised the removed GAQ response shape.**
The async endpoint returns `{task_ids, cursor, tab_id}` from GTF submission
(`submit_chart_data_query_tasks`), but `ChartDataAsyncResponseSchema` still
exposed `channel_id`, `job_id`, `user_id`, `status`, and `result_url`.
- Rewrote the marshmallow schema (which drives the live `/swagger/v1`) to
`task_ids` / `cursor` / `tab_id`.
- Updated the committed docs snapshot `docs/static/resources/openapi.json` —
the schema component and both chart-data `202` examples — to match.
**P2 — generated API docs still listed the removed async-events endpoint.**
`/api/v1/async_event/` and `AsyncEventsRestApi` were removed from the
backend but still published in the docs. Removed the path, tag, and `202`
schema from the docs snapshot and the generated `docs/developer_docs/api.mdx`,
and dropped the hard-coded `AsyncEventsRestApi` entries from the generators
(`generate-api-index.mjs`, `fix-openapi-spec.py`) so a regeneration doesn't
re-add them. The frozen `version-6.1.0` versioned docs are intentionally left
untouched (they document a released version).
**P3 — stale frontend cancellation comment.** `asyncEvent.ts` said chart
tasks "do not cancel an underlying warehouse query after execution starts." The
worker now registers engine-level abort handlers
(`_capture_query_cancellation`), so this is reworded as best-effort /
engine-dependent.
**P3 — websocket operator docs omitted `/ready`.** The `superset-websocket`
README health-check section only listed `/health`. Documented `/ready`
(readiness — `200` only while the Redis subscriber is connected/subscribed,
`503` otherwise) for load-balancer draining, and clarified `/health` as pure
liveness.
**P3 — extension task-payload semantics.** The extension docs said
`update_task()` "replaces the previous payload completely"; the code merges
(top-level keys). Corrected to describe incremental merge semantics.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
N/A (docs/schema only).
### TESTING INSTRUCTIONS
- `python -c "import json;
json.load(open('docs/static/resources/openapi.json'))"` — snapshot is valid
JSON.
- Load `/swagger/v1` and confirm the chart-data `202` response documents
`task_ids`/`cursor`/`tab_id` and that `AsyncEventsRestApi` /
`/api/v1/async_event/` are gone.
### ADDITIONAL INFORMATION
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in
[SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
---
Part of the GAQ → GTF migration epic (#43407).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
