Skip to content

fix(datalens): the models follow the specification of 2026-10-10: the favorite flags are deprecated - #570

Merged
bim-ba merged 1 commit into
mainfrom
chore/datalens-spec-drift
Oct 10, 2026
Merged

bim-ba merged 1 commit into
mainfrom
chore/datalens-spec-drift

Conversation

@bim-ba

@bim-ba bim-ba commented Oct 10, 2026 •

Copy link
Copy Markdown
Owner

DataLens changed its published specification after the models were last regenerated (2026-10-07). This brings the generated models, the snapshot and the README numbers up to it. Mechanical: the generator itself is not changed.

What the regeneration changed, by kind

Kind What
Deprecations The includeFavorite arguments and isFavorite fields now carry deprecated=True and "will be removed in a future API version" in their descriptions, in nine generated modules: dashboard, editor, html_pages, navigation, ql, reports, sql_queries, wizard, workbook
New module datalens/schemas/favorites.py (96 lines): the models of a new section, Favorites
New published operations checkFavorites, listFavorites: in scripts/api_snapshot/datalens.json, and in NOT_WRAPPED with the reason "new section published 2026-10, wrapping not decided". They are not wrapped here; whether to wrap them is a decision for the owner
New reply field hasMoreRows in a result of sqlqueries run (RunSqlQueryResultResultsItem): whether the statement returned more rows than the reply holds. The model now declares it; before, it was kept as an undeclared extra
Anything else Nothing: every other changed line of the generated models is a deprecation (checked by filtering the diff)

Follow-ups by generation: scripts/datalens_schemas.sha256; tests/snapshots/mcp_output_schemas.txt (the output schemas of 11 tools now carry the deprecation); the README "Against the published API" numbers were regenerated (gen_coverage.py --write): DataLens published 141 → 143, wrapped 134, not wrapped on purpose 7 → 9.

The generated CLI and MCP reference did not change: no help text or tool description takes its words from the deprecated fields. The hand-written help of --include-favorite still does not say "deprecated"; I left it, since it is not generated.

Why fix and not chore

The output schemas of tools change, so a client sees the deprecation; that should reach a release.

The specification this came from

Saved copy: ~/.cache/ycli-research/name/dl/spec.json on the machine that ran this, fetched from https://api.datalens.tech/json/ on 2026-10-10, sha256 798680dfba3eca36573e883a1796c5fea3a524b3d4dba17245671872ef8c24cf. The repository keeps no record of which specification the committed models came from (only the hashes of the generated files); that is why this could not be told apart from a hand edit without regenerating, and it is noted for tech debt.

The snapshot was refreshed for DataLens only (scripts/api_drift.py --refresh datalens); the other services were not fetched.

Checked

  • uv run pytest: 6952 passed, 5 skipped, coverage 100% (lines and branches); lint-imports, ty, ruff clean; scripts/gen_datalens_models.py --check passes; pre-commit hooks passed on the commit.

Not run

  • No live call to DataLens: whether the service still honours includeFavorite was not tried.
  • scripts/api_drift.py --live for the other services.

🤖 Generated with Claude Code

… favorite flags are deprecated

Regenerated from the specification DataLens publishes today. The `includeFavorite` arguments and `isFavorite` fields of nine sections now say they are deprecated, as the specification does, and the output schemas of the tools that return them carry it.

The specification also has a new section, Favorites (`checkFavorites`, `listFavorites`). Its models are generated; the two operations are listed as not wrapped, with the reason that wrapping them is not decided.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch was previously deployed

1 inactive deployment
yandex-e2e — 89b436da Deployed Oct 10, 2026 by bim-ba via live (all) #704
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant