Fixes #637: Added a schema.json file - #1861
Open
Combo1 wants to merge 1 commit into
Open
Conversation
fabclmnt
self-requested a review
September 11, 2026 17:13
fabclmnt
requested changes
Sep 11, 2026
fabclmnt
left a comment
Collaborator
There was a problem hiding this comment.
Hi @Combo1, thanks for contributing and choosing and open issue. I do have a couple of comments though.
Fundamentally, the PR doesn't say why this shape of fix. #637 asks for
documentation of the JSON report fields, which means that content belongs in
docs/reference/ as a page on the JSON report, not a JSON file somewhere in the library.
On the schema itself:
- The structure doesn't match the report.
variablesis a top-level
field of BaseDescription, a sibling oftable, not nested inside it.
time_index_analysisis a TimeIndexAnalysis object or None, not a
string. See src/data_profiling/model/description.py. - It covers 3 of the 11 top-level fields. scatter, correlations,
missing, alerts, package, sample and duplicates are absent. - Nothing validates it. As written it's a hand-maintained copy of the
serialization that will drift silently. If we keep a schema, it needs
a test asserting a real to_json() payload conforms to it.
If you want to take this on properly: a docs/reference page describing
the JSON fields, generated from or checked against the dataclasses in
model/description.py, would close #637.
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
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.
This PR adds a schema.json.
The file is not used to verify the json file creation, but is only for documentation purposes, such that the user knows what a field means.
#637