2017-02-21 3 views
3

Можно добавить дополнительные или настраиваемые метаданные (кроме названия и описания) в свойство json schema?дополнительные метаданные json-schema

В идеале я хотел бы добавить некоторые метаданные, как так:

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

Вы можете что-то добавить к definitions, чтобы это?

ответ

6

Вам не нужно ничего делать, чтобы использовать дополнительные ключевые слова метаданных. Вы можете просто использовать их. В схеме JSON не обязательно включать неопределенные ключевые слова. Все, что не имеет семантики JSON Schema, должно быть спокойно проигнорировано. Таким образом, следующая схема полностью действительна и не должна противоречить какой-либо реализации валидатора.

{ 
    "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, так сказать).

Смежные вопросы