feat(docs): data dictionary export (living documentation)#441
Open
seonghobae wants to merge 2 commits into
Open
feat(docs): data dictionary export (living documentation)#441seonghobae wants to merge 2 commits into
seonghobae wants to merge 2 commits into
Conversation
…tions
snapshot_to_data_dictionary_md renders a living-documentation dictionary from a snapshot (tables, columns, PK/FK markers, defaults, comments, example values, non-PK indexes, view/mview labels) merged with the project's table annotations. Endpoint GET /api/snapshots/{uuid}/data-dictionary.md (IDOR-safe). Frontend: api fetchDataDictionaryMarkdown + demo, toolbar '📖' button downloading data-dictionary.md. +4 backend tests (262 total); tsc clean, frontend 136 tests.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AxU2xaupAjp912oDNFuWyd
Same one-line union-attr fix as on adhesive-piper; makes backend CI (mypy) green on this stacked branch. Collapses at rebase/merge onto the fixed base. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AxU2xaupAjp912oDNFuWyd
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on
adhesive-piper(PR #440). Implements P1 fromdocs/valuation-gap-analysis.md.Living documentation
GET /api/snapshots/{uuid}/data-dictionary.mdrenders a Markdown data dictionary from a snapshot — tables, columns (type/null/default/PK·FK/comment/example value), foreign keys, non-PK indexes, view/mview labels — merged with the project's table annotations. The annotation feature now doubles as human-authored docs alongside the introspected structure.app/spec/data_dictionary.py), IDOR-safe endpoint📖toolbar button → downloadsdata-dictionary.mdVerification
backend
pytest262 passed (+4), frontendvitest136,tscclean🤖 Generated with Claude Code