CentreForDigitalHumanities / CentreForDigitalHumanities/Textcavator

Include JSON schema in definition API

Open
#1,588 0 comments 0 reactions 0 assignees View on GitHub
backend enhancement
Dominant language
Python
Stars
12
Forks
3
Avg merge
3d 3m
Merged PRs (30d)
9

Description

We have a JSON schema for corpus definitions, but it can only be accessed through the source code.

Suggestions:
- Include `$schema` property when exporting JSON definitions.
- Allow the frontend to validate JSON uploads against the (current) schema.
- Allow users to inspect the schema. (A URL to the JSON would be sufficient.)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the existing corpus-definition JSON schema, the definition API's JSON export, and the frontend's JSON upload handling. Check how exported definitions and uploaded files are processed. Done should include schema exposure in the API, a $schema property on exported definitions, frontend validation against the current schema, and a way for users to inspect the schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.