Skip to content

docs: remove stale catalog annotations from catalog-metadata-sync guide - #482

Merged
Chenglong Wang (Chenglong-MS) merged 2 commits into
microsoft:devfrom
mastartm:docs/remove-catalog-annotations
Oct 13, 2026
Merged

Chenglong Wang (Chenglong-MS) merged 2 commits into
microsoft:devfrom
mastartm:docs/remove-catalog-annotations

Conversation

@mastartm

@mastartm Burak Kaan G枚k (mastartm) commented Oct 13, 2026 •

Copy link
Copy Markdown

Fixes #480

docs/dev-guides/11-catalog-metadata-sync.md still documented the catalog annotations feature, which was removed (see the comment in data_connector.py: "User annotations were removed in favor of source-system metadata only").

This PR prunes the annotation/merge material from the guide and keeps the sync, cache and table_key content, which is still accurate:

  • removed the references to catalog_annotations.py / catalog_merge.py, the /catalog-annotations endpoints, ANNOTATION_* error codes and CATALOG_ANNOTATIONS
  • removed the annotation storage format, PATCH semantics, write strategy, and the merge section
  • rewrote the search section to the current scoring (table name, source description, column name, source column description)
  • simplified the lifecycle table, the agent pipeline matrices and the i18n/message_code notes accordingly

Verification: grep -c -i annotation docs/dev-guides/11-catalog-metadata-sync.md goes from 41 to 0.

Docs-only change; no code touched.
This change was prepared with AI assistance (Claude) and reviewed by me.

The annotations feature was removed (data_connector.py: "User annotations
were removed in favor of source-system metadata only"), but the dev guide
still documented its files, endpoints, error codes and storage format.

Prune the annotation/merge material and keep the sync, cache and table_key
content, which is still accurate.

Fixes microsoft#480
@mastartm
Burak Kaan G枚k (mastartm) changed the base branch from main to dev October 13, 2026 17:54
@mastartm

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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.

docs/dev-guides/11-catalog-metadata-sync.md still documents the removed catalog annotations feature (files, endpoints, error codes)

2 participants