Skip to content

Document the Databases and Tables endpoints - #1902

Merged
jacalata merged 7 commits into
gh-pagesfrom
jac/docs-databases-tables
Nov 14, 2026
Merged

jacalata merged 7 commits into
gh-pagesfrom
jac/docs-databases-tables

Conversation

@jacalata

@jacalata jacalata commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Adds reference entries for the databases and tables endpoints, including the permissions, data quality warning and tag methods, and Databases and Tables items in the docs menu.
  • Documents the behavior on development: populate_tables is not currently enabled (version 99 gate), delete_table_default_permissions takes (rule, item), and update requests do not send empty values.
  • Fixes the datasources.delete_dqw REST API link.

Refs #735

Related

🤖 Generated with Claude Code

jacalata and others added 7 commits November 9, 2026 13:51
The databases and tables endpoints, and the DatabaseItem, TableItem and
ColumnItem classes, had no API reference entries. Add sections for every
method, note that databases.populate_tables is not enabled and show the
Metadata API alternative, and list the new explore_databases_tables
sample.

Closes #735

Co-Authored-By: Claude Code <noreply@anthropic.com>
The link pointed at the delete_dqw_triggers anchor, which is not the
method this call makes. Point it at delete_dqws, Delete Data Quality
Warning by Content, and correct the link text.

Co-Authored-By: Claude Code <noreply@anthropic.com>
populate_tables raises NotImplementedError rather than gating on a
placeholder version. delete_table_default_permissions takes (item, rule),
and the old order warns. Update requests send only the values that are
set, so None leaves a property unchanged and an empty string clears it.

Refs #735

Co-Authored-By: Claude Code <noreply@anthropic.com>
content_permissions and description are sent by update, and an empty
description clears it. update_tags raises EndpointUnavailableError below
REST API 3.9.

Co-Authored-By: Claude Code <noreply@anthropic.com>
Revert the two passages that describe unmerged #1901 behavior:
- databases.populate_tables is documented as not currently enabled
  (version 99 gate, EndpointUnavailableError), not as unsupported.
- databases.delete_table_default_permissions is documented as
  (rule, item), not (item, rule), and the tables property row
  matches the populate_tables wording.

Co-Authored-By: Claude Code <noreply@anthropic.com>
databases.update and tables.update send a value only when it is not
empty on development, so the update docs say that empty strings do not
clear description or certification_note. Revert the "only the values
that are set" wording, which depends on unmerged #1901.

Co-Authored-By: Claude Code <noreply@anthropic.com>
- DatabaseItem.content_permissions: drop the value list and the claim
  that databases.update sends it (not true on development; the write
  and the LockedToDatabase value come with #1901).
- Drop the explore_databases_tables.py references (sample is in #1907).
- Handle empty results in the databases.populate_tables example.

Co-Authored-By: Claude Code <noreply@anthropic.com>
@jacalata
jacalata merged commit 3bcf8f5 into gh-pages Nov 14, 2026
6 checks passed
@jacalata
jacalata deleted the jac/docs-databases-tables branch November 14, 2026 08:52
jacalata added a commit that referenced this pull request Nov 14, 2026
Do not merge before both PRs land:
- #1901 (databases and tables fixes): populate_tables raises
  NotImplementedError, delete_table_default_permissions takes
  (item, rule), update sends only the values that are set,
  content_permissions is sent and accepts LockedToDatabase.
- #1907 (databases and tables sample): the explore_databases_tables.py
  references.

Also guard the databases.populate_tables example against empty results,
matching #1902.

Co-Authored-By: Claude Code <noreply@anthropic.com>
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