Skip to content

Fixes #637: Added a schema.json file - #1861

Open
Combo1 wants to merge 1 commit into
Data-Centric-AI-Community:developfrom
Combo1:develop
Open

Fixes #637: Added a schema.json file#1861
Combo1 wants to merge 1 commit into
Data-Centric-AI-Community:developfrom
Combo1:develop

Conversation

@Combo1

@Combo1 Combo1 commented Sep 4, 2026

Copy link
Copy Markdown

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

@fabclmnt
fabclmnt self-requested a review September 11, 2026 17:13

@fabclmnt fabclmnt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. variables is a top-level
    field of BaseDescription, a sibling of table, not nested inside it.
    time_index_analysis is 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.

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.

2 participants