RicoSuter/NJsonSchema

When using #ref the CSharp CodeGen does not include appropriate data annotiations

Open

#957 opened on Apr 23, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (550 forks)github user discovery
help wantedtype: enhancement

Repository metrics

Stars
 (1,578 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I recently added some $refs to my schema and noticed that the generator dropped some of the annotation. Previous schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "id": {
           "type": "string",
           "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
        }
    }
}

New schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "id": {
           "$ref": "#/definitions/guid"
        }
    },
    "definitions": {
        "guid": {
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$"
        }
    }
}

The generated code no longer has the DataAnnotiation for regular expressions. It also removes length restrictions, etc.

Contributor guide

Research direction
Inspect how the C# code generator resolves $ref references in JSON Schema and trace where data annotations like pattern or length restrictions are lost. Look at the code that processes definitions and property generation.
Tech stack
csharp
Domain
api
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GitJSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75