From 3b7cb45df57bae8f7c2d7a0d8eb65efdb6ad3e42 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 22 Sep 2026 12:17:05 +0000 Subject: [PATCH] docs: sync documentation with recent changes Fix two small gaps left by PRs merged since #103, both verified against the code on main: - README.md: the Python SDK section's list of NL2SQL public attributes omitted engine.auth (AuthAPI), which the same paragraph's convenience methods (check_permissions, get_allowed_resources) delegate to. - web/playground/README.md: the Settings panel's per-node model selector ids were missing #model-datasourceresolver, added by #121's answerability check node. Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01HyeURBJcF67mhU6v1apcoD --- README.md | 5 +++-- web/playground/README.md | 7 ++++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 978ec6ab..d886782f 100644 --- a/README.md +++ b/README.md @@ -296,8 +296,9 @@ again reuses the validated plan from the plan cache (`sq.plan_source == "cache"` still validated for the caller's role. `NL2SQL` also exposes `engine.query`, `engine.datasource`, `engine.llm`, -`engine.indexing`, `engine.policy`, `engine.settings`, `engine.results` and -`engine.benchmark`. See [the public facade](docs/api/core/public-facade.md) and +`engine.indexing`, `engine.auth`, `engine.policy`, `engine.settings`, +`engine.results` and `engine.benchmark`. See +[the public facade](docs/api/core/public-facade.md) and [`examples/`](examples/). ## Configuration diff --git a/web/playground/README.md b/web/playground/README.md index 074a5563..091844ea 100644 --- a/web/playground/README.md +++ b/web/playground/README.md @@ -90,9 +90,10 @@ The React source for the page `nl2sql demo` serves. only in masked form (`#settings-key-current`); saving one writes it to the demo project's `.env.demo` and turns replay into live without a restart, and the mode line follows. **Model for each step** has one selector per LLM node - (`#model-decomposer`, `#model-astplanner`, `#model-refiner`, - `#model-answersynthesizer`) with a Default option, and **Save models** - (`#settings-save-models`) writes the changed ones to `configs/llm.demo.yaml`. + (`#model-datasourceresolver`, `#model-decomposer`, `#model-astplanner`, + `#model-refiner`, `#model-answersynthesizer`) with a Default option, and + **Save models** (`#settings-save-models`) writes the changed ones to + `configs/llm.demo.yaml`. Choosing a model that runs without a temperature shows `#settings-temperature-note`. The model list comes from `GET /api/settings`; the page names no model itself. When the server has settings off (a