2017-02-21 16 views
3

jsonスキーマのプロパティに(タイトルと説明以外の)追加またはカスタムのメタデータを追加することはできますか?json-schema追加のメタデータ

理想的には私はそうのようないくつかのメタデータを追加したいと思います:

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

は、あなたがそれを可能にしdefinitionsに何かを追加することはできますか?

答えて

6

追加のメタデータキーワードを使用するために特別な操作を行う必要はありません。あなたはそれらを使うことができます。 JSONスキーマでは、未定義のキーワードを含めることはエラーではありません。 JSONスキーマのセマンティクスを持たないものは、静かに無視する必要があります。したがって、次のスキーマは完全に有効であり、バリデータの実装と競合してはいけません。

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

descriptionプロパティを使用して、そこに(JSONスキーマ内のJSONなどのように)必要に応じて解釈して適用できる特定の構造を配置できます。

関連する問題