tibi-types/schemas/api-config/fieldMeta.json

371 lines
15 KiB
JSON
Raw Normal View History

{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "JSON Schema tibi-server field meta configuration",
"description": "tibi-server field meta linter",
"type": "object",
"anyOf": [
{
"$ref": "#/definitions/minimum"
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": { "enum": ["text", "checkbox"] }
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": { "enum": ["richtext", "richText"] }
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget|choices$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"required": ["choices"],
"properties": {
"widget": {
"enum": [
"checkboxArray",
"select",
"selectArray",
"chipArray"
]
},
"choices": {
"oneOf": [
{
"type": "object",
"description": "endpoint configuration",
"additionalProperties": false,
"properties": {
"endpoint": {
"type": "string",
"description": "endpoint URL or path"
},
"params": {
"type": "object",
"description": "query parameters"
},
"mapping": {
"type": "object",
"description": "data mapping",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "name of id field"
},
"name": {
"type": "string",
"description": "name of name/description field"
}
}
}
}
},
{
"type": "array",
"description": "choices to select from",
"items": {
"type": "object",
"properties": {
"id": {
"oneOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "number"
}
]
},
"name": {
"description": "name is human readable value",
"$ref": "definitions.json#/definitions/i18nString"
},
"chipStyle": {
"$ref": "https://raw.githubusercontent.com/rcorp/css-schema/master/schema.json"
}
},
"required": ["id", "name"]
}
}
]
}
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": {
"enum": ["date", "datetime"]
}
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": {
"enum": ["file", "image"]
}
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": {
"enum": ["json"]
}
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": {
"enum": ["tabs"]
}
}
}
]
},
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget|baseHref|cssHref|imageSelect|fileSelect|videoSelect|customTags|style$": {
"$comment": "stub for allOf"
}
},
"allOf": [
{
"properties": {
"widget": {
"enum": ["contentbuilder"]
},
"baseHref": {
"description": "base href for relative links inside of ContentBuilder",
"oneOf": [
{ "type": "string" },
{
"$ref": "definitions.json#/definitions/evalObject"
}
]
},
"cssHref": {
"description": "href to css file for use with ContentBuilder",
"oneOf": [
{ "type": "string" },
{
"type": "array",
"items": { "type": "string" }
},
{
"$ref": "definitions.json#/definitions/evalObject"
}
]
},
"imageSelect": {
"description": "target for image selection",
"$ref": "#definitions/assetsTarget"
},
"fileSelect": {
"description": "target for file selection",
"$ref": "#definitions/assetsTarget"
},
"videoSelect": {
"description": "target for video selection",
"$ref": "#definitions/assetsTarget"
},
"customTags": {
"description": "custom tags to add to ContentBuilder",
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["placeholder", "label"],
"properties": {
"placeholder": {
"type": "string",
"description": "placeholder inside html code"
},
"label": {
"$ref": "definitions.json#/definitions/i18nString"
}
}
}
},
{
"$ref": "definitions.json#/definitions/evalObject"
}
]
},
"style": {
"description": "css style to inject into ContentBuilder",
"oneOf": [
{ "type": "string" },
{
"$ref": "definitions.json#/definitions/evalObject"
}
]
}
}
}
]
}
],
"definitions": {
"minimum": {
"additionalProperties": false,
"patternProperties": {
"^x\\-": {
"description": "template property"
}
},
"properties": {
"label": {
"$ref": "definitions.json#/definitions/i18nString",
"description": "label for field"
},
"helperText": {
"$ref": "definitions.json#/definitions/i18nString",
"description": "helper text for field"
},
"dependsOn": {
"description": "depends on rule",
"oneOf": [
{ "type": "string" },
{
"type": "object",
"properties": {
"eval": {
"type": "string",
"description": "javascript code which hides field widget if evaluates to false with $, $this, $parent and $stack variables"
}
}
}
]
},
"defaultValue": {
"description": "default value or code to get the value",
"oneOf": [
{ "type": "array" },
{ "type": "string" },
{ "type": "null" },
{ "type": "boolean" },
{ "type": "number" },
{
"type": "object",
"properties": {
"eval": {
"type": "string",
"description": "js code with $navigation variable"
}
}
}
]
},
"valueMap": {
"type": "object",
"description": "map values to icons",
"patternProperties": {
".*": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"muiIcon": {
"type": "string"
},
"style": {
"$ref": "https://raw.githubusercontent.com/rcorp/css-schema/master/schema.json"
}
}
}
]
}
}
}
}
},
"assetsTarget": {
"oneOf": [
{
"type": "string",
"description": "url for assets view"
},
{
"type": "object",
"properties": {
"collection": {
"type": "string",
"description": "collection name"
},
"subNavigation": {
"type": "number",
"description": "sub navigation index in collections meta.subNavigation"
}
}
},
{
"$ref": "definitions.json#/definitions/evalObject"
}
]
}
}
}