alecthomas/voluptuous

export/generate json schema

Open

#408 opened on Oct 2, 2019

View on GitHub
 (1 comment) (5 reactions) (0 assignees)Python (221 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,845 stars)
PR merge metrics
 (Avg merge 61d 21h) (6 merged PRs in 30d)

Description

Could you please add an option to get the schema as json schema? I tried using a few 3rd-party libraries that claimed to be able to work with voluptuous and they all failed miserably. I believe the best is to have this feature built-in as you know how to access/traverse the internals of voluptuous schema with all the validations, nestings etc. That would be especially useful with modern IDEs that can validate yaml files versus json schema which could be automatically regenerated on any change of the voluptuous schema - you could immediately see the effect of your changes.

Contributor guide

Research direction
Explore the voluptuous source code to understand the internal schema structure and validator traversal. Study existing JSON schema generation libraries for inspiration. Implement a function that converts voluptuous validators to JSON schema types and constraints.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50