INCATools / INCATools/odkcore

Replace `dataclasses-jsonschema`

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jinja
Stars
2
Forks
4
Avg merge
7d 16h
Merged PRs (30d)
8

Description

We used to rely on `dataclasses-jsonschema` to generate a JSON Schema for the ODK configuration object (using the `json_schema()` method from the `JsonSchemaMixin` class).

This no longer works: `json_schema()` systematically fails to generate the expected schema. And this will likely never be fixed since [dataclasses-jsonschema](https://github.com/s-knibbs/dataclasses-jsonschema) has not had any release since 2022 and is officially no longer maintained since 2023.

If we want to restore the possibility of generating a schema for the configuration object, we should consider an alternative. Maybe Pydantic?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named. Start by locating the ODK configuration object and its JsonSchemaMixin/json_schema() usage, then assess an alternative such as Pydantic; done means generating the expected JSON Schema works again.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.