Skip to content

feat(query): add canonical AST schema + OpenAPI generation for query DSL #3330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sinity merged 1 commit into from
Jul 27, 2026
Merged

feat(query): add canonical AST schema + OpenAPI generation for query DSL #3330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions devtools/render_openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
from devtools.command_catalog import control_plane_command
from devtools.render_support import write_if_changed
from polylogue.archive.query.metadata import terminal_query_examples, terminal_query_source_list
from polylogue.archive.query.query_ast_schema import QUERY_AST_SCHEMA_VERSION, QueryExpressionExplanationAst
from polylogue.archive.viewport import (
read_view_http_choices,
read_view_http_format_choices,
Expand Down Expand Up @@ -75,6 +76,7 @@
WebCredentialRevocationPayload,
WebCredentialFailurePayload,
QueryErrorPayload,
QueryExpressionExplanationAst,
)

_WEB_CREDENTIAL_FAILURE_STATES = [
Expand Down Expand Up @@ -900,6 +902,23 @@ def _build_openapi_document() -> dict[str, Any]:
},
},
"x-polylogue-route-contracts": [_route_contract_payload(contract) for contract in ROUTE_CONTRACTS],
"x-polylogue-query-ast": {
"schema_version": QUERY_AST_SCHEMA_VERSION,
"schema": "#/components/schemas/QueryExpressionExplanationAst",
"description": (
"Canonical, versioned projection of the query DSL's compiled "
"predicate tree, unit-source pipeline, and lowering plan. "
"Every query DSL expression -- fielded compact queries, "
"``sessions where ...`` Boolean expressions, terminal unit "
"sources (``actions where ...``), and durable-reference "
"pipelines (``from result-set:... | ...``) -- lowers to this "
"one documented shape. Obtain it via the MCP ``explain`` "
'operation (``kind="query"``) or '
"``Polylogue.explain_query_expression(expression)``; there is "
"no separate HTTP route yet (tracked as a future extension of "
"this schema's live surface)."
),
},
}


Expand Down
Loading