jmapio / jmapio/jmap

Consider using JSON Schema for easy validation?

Open
#286 2 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
1.4k
Forks
100
Avg merge
18h 7m
Merged PRs (30d)
2

Description

Have you looked into using JSON Schema to define your JSON data structures?
It would mean you could auto validate JSON instances, and provide annotation of fields for those looking for understanding.

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 files, tests, or entry points are named. Start by reviewing the JMAP specification's JSON data structures and assess whether JSON Schema would provide useful validation and field annotations; done means a decided and documented approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
backend-api-design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.