json-schema métadonnées supplémentaires

Question

Il est possible d'ajouter des métadonnées supplémentaires ou personnalisées (autres que le titre et la description) à une propriété de schéma json?

Idéalement, je voudrais ajouter des métadonnées comme ceci:

//... 
"properties": { 
    "contactFullName": { 
    "$ref": "#/definitions/fullName", 
    "custom": "my custom metadata here" 
    } 
} 
//... 

Pouvez-vous ajouter quelque chose à definitions pour permettre cela?

Answer 1

Vous n'avez rien à faire de spécial pour utiliser des mots-clés de métadonnées supplémentaires. Vous pouvez simplement les utiliser. Dans JSON Schema, ce n'est pas une erreur d'inclure des mots-clés non définis. Tout ce qui n'a pas de sémantique JSON Schema doit être discrètement ignoré. Ainsi, le schéma suivant est entièrement valide et ne devrait pas entrer en conflit avec une implémentation de validateur.

{ 
    "title": "Foo", 
    "description": "All the foo you can GET", 
    "version": "1.0.3", 
    "author": "Jason Desrosiers", 
    "type": "object", 
    "properties": { 
    "id": { "type": "string" } 
    } 
} 

Answer 2

Vous pourriez utiliser la propriété description et y mettre une certaine structure qui pourrait ensuite être interprétée et appliquée selon les besoins (comme JSON dans un schéma JSON, pour ainsi dire).