RicoSuter/NJsonSchema

Propagate item-level validation on string arrays from JSON schema to C# object model

Open

#1 292 ouverte le 8 déc. 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)C# (550 forks)github user discovery
help wantedproject: NJsonSchema.CodeGeneration.CSharptype: enhancement

Métriques du dépôt

Stars
 (1 578 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

I have a string array field which validates not only the length of the array, but the length of the strings in the array as well:

"Tags": {
      "type": "array",
      "minItems": 1,
      "maxItems": 16,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 3
      }
    },

However, when converted to a C# OM, the per-item validation gets lost:

[Newtonsoft.Json.JsonProperty("Tags", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)]
[System.ComponentModel.DataAnnotations.MinLength(1)]
[System.ComponentModel.DataAnnotations.MaxLength(16)]
public System.Collections.Generic.ICollection<string> Tags { get; set; }

I don't have a bright idea on how this validation criteria could live in the .NET world, it's possible that there's no way to currently phrase that using the DataAnnotations, but I'm hoping to be surprised!

Guide contributeur

Direction de recherche
Examinez comment NJsonSchema génère du code C# pour les propriétés de tableau avec des schémas d'éléments. Concentrez vous sur le chemin de génération de code qui émet des attributs DataAnnotations. Recherchez la prise en charge existante pour d'autres validations au niveau de l'élément (par exemple, pattern) et étendez la à minLength/maxLength. La spécification JSON Schema définit ces propriétés sur les schémas d'éléments ; le générateur doit les mapper à des attributs .NET appropriés ou à une validation personnalisée.
Stack technique
csharp
Domaine
backendtooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#JSON Schema
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50