Come dire allo strumento di convalida dello schema JSON di scegliere lo schema dal valore della proprietà?

Question

Ad esempio uno schema per un file system, la directory contiene un elenco di file. Lo schema è costituito dalle specifiche del file, successivamente un sottotipo "immagine" e un altro "testo".

Nella parte inferiore è presente lo schema della directory principale. La directory ha un contenuto di proprietà che è una matrice di elementi che dovrebbero essere sottotipi di file.

Fondamentalmente quello che sto cercando è un modo per dire al validatore di cercare il valore di un "$ ref" da una proprietà nell'oggetto json che viene convalidato.

Esempio JSON:

{ 
    "name":"A directory", 
    "content":[ 
     { 
      "fileType":"http://x.y.z/fs-schema.json#definitions/image", 
      "name":"an-image.png", 
      "width":1024, 
      "height":800 
     } 
     { 
      "fileType":"http://x.y.z/fs-schema.json#definitions/text", 
      "name":"readme.txt", 
      "lineCount":101 
     } 
     { 
      "fileType":"http://x.y.z/extended-fs-schema-video.json", 
      "name":"demo.mp4", 
      "hd":true 
     } 

    ] 
} 

La "pseudo" Schema nota che e definizioni "testo", "immagine" sono compresi nello stesso schema, ma potrebbero essere definiti altrove

{ 
    "id": "http://x.y.z/fs-schema.json", 
    "definitions": { 
     "file": { 
      "type": "object", 
      "properties": { 
       "name": { "type": "string" }, 
       "fileType": { 
        "type": "string", 
        "format": "uri" 
       } 
      } 
     }, 
     "image": { 
      "allOf": [ 
      { "$ref": "#definitions/file" }, 
      { 
       "properties": { 
        "width": { "type": "integer" }, 
        "height": { "type": "integer"} 
       } 
      } 
      ] 
     }, 
     "text": { 
      "allOf": [ 
      { "$ref": "#definitions/file" }, 
      { "properties": { "lineCount": { "type": "integer"}}} 
      ] 
     } 
    }, 
    "type": "object", 
    "properties": { 
     "name": { "type": "string"}, 
     "content": { 
      "type": "array", 
      "items": { 
       "allOf": [ 
       { "$ref": "#definitions/file" }, 
       { *"$refFromProperty"*: "fileType" } // the magic thing 
       ] 
      } 
     } 
    } 
} 

Answer 1

Le parti di convalida di JSON Schema da sole non possono farlo: rappresentano una struttura fissa. Quello che vuoi richiede la risoluzione/gli schemi di riferimento alla validazione .

Tuttavia, si può esprimere questo utilizzando JSON Hyper-Schema, e un link rel="describedby":

{ 
    "title": "Directory entry", 
    "type": "object", 
    "properties": { 
     "fileType": {"type": "string", "format": "uri"} 
    }, 
    "links": [{ 
     "rel": "describedby", 
     "href": "{+fileType}" 
    }] 
} 

Così qui, ci vuole il valore da "fileType" e lo usa per calcolare un legame con la relazione "describedby" - che significa "lo schema in questa posizione descrive anche i dati correnti".

Il problema è che la maggior parte dei validatori non prende in considerazione alcun collegamento (compresi quelli "descritti da"). Hai bisogno di trovare un "iper-validatore" che lo faccia.

UPDATE: la biblioteca tv4 ha aggiunto questo come una caratteristica

Answer 2

Penso risposta cloudfeet è una soluzione valida. Puoi anche utilizzare lo stesso approccio described here.

Si avrebbe un tipo di oggetto file che potrebbe essere "anyOf" tutti i sottotipi che si desidera definire. Dovresti usare un enum per poter fare riferimento e validare contro ciascuno dei sottotipi.

Se gli schemi di sottotipi sono nello stesso file di JSON-Schema, non è necessario fare riferimento all'ur in modo esplicito con "$ ref". Un validatore draft4 corretto troverà il valore enum e proverà a convalidare tale "subschema" nell'albero Json-Schema.

In draft5 (in corso) è stata proposta una dichiarazione "switch" che consente di esprimere le alternative in modo più esplicito.