glideapps/quicktype

Generate ComponentModel.DataAnnotations attributes for JSON Schema constraints

Open

#825 opened on Apr 25, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (10,867 stars) (968 forks)batch import
C#JSON Schemagood first issue

Description

There are attributes for min/max and regular expressions, maybe more. I'm not sure they're checked by Json.NET when deserializing, but it would nice to have them in general. Also, the JSON Schema generator of Json.NET will use them to reproduce the constraints in the schema.

Contributor guide

Tech stack
typescript
Domain
toolingdeveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Knowledge of C# DataAnnotationsUnderstanding of JSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
This issue requests adding DataAnnotation attributes (such as MinLength, MaxLength, RegularExpression) to generated C# classes based on JSON Schema constraints. To implement, examine how quicktype currently generates C# code (likely in src/quicktype core/language/CSharp.ts) and how JSON Schema constraints are processed in the schema processing pipeline. The comment mentions that Json.NET's JSON Schema generator uses these attributes, so it would be beneficial for round tripping. There are no prior discussions or PRs to reference, so the implementation should start by adding support for the most common string constraints and ensuring they are emitted when generating C# code.