jsonスキーマで合計/共用体の型を表現する方法

Question

json-schemaを使用して既存のJSONの使用を文書化しようとしています。システムは、オブジェクト属性の1つに対して以下の2つの可能性を許容する。

どちらか

{ 
    "tracking_number" : 123 
} 

それとも

{ 
    "tracking_number" : [ 123, 124, 125 ] 
} 

どのように私はこの使用してJSONスキーマを表現することができますか？

Answer 1

anyOfを使用して、プロパティが1つまたは別のスキーマに準拠している必要があることをアサートします。

{ 
    "type": "object", 
    "properties": { 
     "tracking_number": { 
      "anyOf": [ 
       { "$ref": "#/definitions/tracking_number" }, 
       { "type": "array", "items": { "$ref": "#/definitions/tracking_number" } 
      ] 
    }, 
    "definitions": { 
     "tracking_number": { "type": "integer" } 
    } 
}