cms/tibi-types
5
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
9beb4d3a43
tibi-types/schemas/api-config/fieldMeta.json

732 lines
31 KiB
JSON
Raw Normal View History

updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
{
"$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": {
added inputProps to text, checkbox widget type
2022-11-28 05:45:17 +01:00
"^x-.*|widget|inputProps$": { "$comment": "stub for allOf" }
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
},
"allOf": [
{
"properties": {
"widget": { "enum": ["text", "checkbox"] }
}
added inputProps to text, checkbox widget type
2022-11-28 05:45:17 +01:00
},
{
"properties": {
"inputProps": {
"type": "object",
"properties": {
"multiline": { "type": "boolean" }
}
}
}
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
}
]
},
🔧 chore(schemas): update collectionNavigation.json and fieldMeta.json schemas 🔀 Merge branch 'feature/schema-update' into 'master' The collectionNavigation.json schema was updated to include a new enum value "MANUALLY" for the "order" property in the "defaultSort" object. This allows for manual sorting of items in the admin UI lists. The fieldMeta.json schema was updated to include new properties and definitions related to folding configuration for array fields, hiding field widgets, direction of fields, path steps, and meta elements. These updates enhance the flexibility and customization options for the field widgets in the application.
2023-08-06 11:31:19 +02:00
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
{
"$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"]
}
}
}
]
},
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
{
"$ref": "#/definitions/minimum",
"patternProperties": {
"^x-.*|widget|foreign$": { "$comment": "stub for allOf" }
},
"allOf": [
{
"properties": {
"widget": {
"enum": ["foreignKey"]
},
"foreign": {
"additionalProperties": false,
"description": "foreign key configuration",
"type": "object",
"properties": {
"collection": {
"type": "string",
"description": "collection name"
},
"id": {
"type": "string",
"description": "id field name"
},
"projection": {
"type": "string",
"description": "projection name used for fetching initial foreign entries from database"
},
"sort": {
"type": "string",
"description": "sort field name (-field for descending)"
},
"subNavigation": {
"type": "number",
"description": "sub navigation index in foreign collection"
},
"render": {
"description": "field name or eval object which returns string",
"oneOf": [
{ "type": "string" },
{
"$ref": "definitions.json#/definitions/evalObjectWithRaw"
schemas updated
2023-07-23 22:32:50 +02:00
},
{
"type": "object",
"properties": {
"defaultCollectionViews": {
"type": "boolean"
}
},
"required": [
"defaultCollectionViews"
]
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
}
]
}
}
}
}
}
]
},
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
{
"$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": {
🔨 refactor(fieldMeta.json): remove unnecessary code duplication and reorganize fieldMeta schema 🌟 feat(fieldMeta.json): add new properties for folding configuration, hiding field widget, direction, pathStep, and metaElements The changes in the fieldMeta.json schema remove unnecessary code duplication by removing a section that was already defined elsewhere. The schema is also reorganized to group related properties together for better readability. New properties for folding configuration, hiding field widget, direction, pathStep, and metaElements are added to enhance the flexibility and customization options of the fieldMeta schema.
2023-08-06 11:35:49 +02:00
"folding": {
"type": "object",
"description": "folding configuration for array fields",
"additionalProperties": false,
"properties": {
"previewUnfolded": {
"description": "preview for unfolded array element",
"oneOf": [
{ "type": "string" },
{
"$ref": "definitions.json#/definitions/evalObjectWithRaw"
}
]
},
"previewFolded": {
"description": "preview for folded array element",
"oneOf": [
{ "type": "string" },
{
"$ref": "definitions.json#/definitions/evalObjectWithRaw"
}
]
}
}
},
"hide": {
"type": "boolean",
"description": "hide field widget"
},
"direction": {
"type": "string",
"enum": ["horizontal", "vertical"]
},
"pathStep": {
"type": "object",
"properties": {
"title": {
"type": "string",
"const": "Zeile"
},
"icon": {
"type": "string",
"const": "viewSequentialOutline"
}
},
"required": ["title", "icon"]
},
"metaElements": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"source": {
"type": "string"
}
},
"required": ["source"]
},
{
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"source": {
"type": "string",
"const": "layout"
}
},
"required": ["source"]
}
]
},
{
"type": "object",
"properties": {
"tablist": {
"type": "object",
"properties": {
"tabs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"label": {
"type": "string"
},
"subFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
}
},
"required": [
"source"
]
}
}
},
"required": [
"name",
"label",
"subFields"
]
}
}
},
"required": ["tabs"]
}
}
}
]
},
openapi object allowed in field meta
2023-02-06 14:19:33 +01:00
"openapi": {
"type": "object"
},
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
"label": {
"$ref": "definitions.json#/definitions/i18nString",
"description": "label for field"
},
🔧 chore(schemas): update collectionNavigation.json and fieldMeta.json schemas 🔀 Merge branch 'feature/schema-update' into 'master' The collectionNavigation.json schema was updated to include a new enum value "MANUALLY" for the "order" property in the "defaultSort" object. This allows for manual sorting of items in the admin UI lists. The fieldMeta.json schema was updated to include new properties and definitions related to folding configuration for array fields, hiding field widgets, direction of fields, path steps, and meta elements. These updates enhance the flexibility and customization options for the field widgets in the application.
2023-08-06 11:31:19 +02:00
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
"addElementLabel": {
"$ref": "definitions.json#/definitions/i18nString",
"description": "label for adding element to list"
},
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
"helperText": {
"$ref": "definitions.json#/definitions/i18nString",
"description": "helper text for field"
},
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
"filter": {
"type": "object",
"description": "filter configuration for list view of this field",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"description": "filter type",
"enum": [
"default",
"select",
"bool",
"boolean",
"input",
"number",
"foreignKey"
]
}
}
},
🔧 chore(schemas): update collectionNavigation.json and fieldMeta.json schemas 🔀 Merge branch 'feature/schema-update' into 'master' The collectionNavigation.json schema was updated to include a new enum value "MANUALLY" for the "order" property in the "defaultSort" object. This allows for manual sorting of items in the admin UI lists. The fieldMeta.json schema was updated to include new properties and definitions related to folding configuration for array fields, hiding field widgets, direction of fields, path steps, and meta elements. These updates enhance the flexibility and customization options for the field widgets in the application.
2023-08-06 11:31:19 +02:00
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
"css": {
"description": "css styles for field widgets",
include tag for css
2023-03-30 12:09:24 +02:00
"oneOf": [
{ "$comment": "for include tag", "type": "string" },
{
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
"type": "object",
"properties": {
include tag for css
2023-03-30 12:09:24 +02:00
"input": {
"description": "css styles for input widget",
"oneOf": [
{
"$comment": "for include tag",
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"wrapper": {
"description": "css styles for input widget wrapper",
"$ref": "#/definitions/css"
},
"element": {
"description": "css styles for input widget sub elements",
"$ref": "#/definitions/css"
},
"foreignEntry": {
"description": "css styles for input widget linked foreign entries",
"$ref": "#/definitions/css"
}
}
}
]
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
},
include tag for css
2023-03-30 12:09:24 +02:00
"view": {
"description": "css styles for input widget",
"oneOf": [
{
"$comment": "for include tag",
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"wrapper": {
"description": "css styles for view widget wrapper",
"$ref": "#/definitions/css"
},
"element": {
"description": "css styles for view widget sub elements",
"$ref": "#/definitions/css"
},
"foreignEntry": {
"description": "css styles for input widget linked foreign entries",
"$ref": "#/definitions/css"
}
}
}
]
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
}
}
}
include tag for css
2023-03-30 12:09:24 +02:00
]
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
},
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
"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"
}
}
}
]
},
schemas updated
2023-07-23 22:32:50 +02:00
"containerProps": {
"type": "object",
"properties": {
"class": {
"type": "string"
},
"layout": {
"type": "object",
"properties": {
"breakBefore": {
"type": "boolean"
},
"breakAfter": {
"type": "boolean"
},
"size": {
"type": "object",
"properties": {
"default": {
"type": "string"
},
"small": {
"type": "string"
},
"large": {
"type": "string"
}
}
}
}
}
}
},
"inputProps": {
"type": "object",
"additionalProperties": true
},
🔧 chore(schemas): update collectionNavigation.json and fieldMeta.json schemas 🔀 Merge branch 'feature/schema-update' into 'master' The collectionNavigation.json schema was updated to include a new enum value "MANUALLY" for the "order" property in the "defaultSort" object. This allows for manual sorting of items in the admin UI lists. The fieldMeta.json schema was updated to include new properties and definitions related to folding configuration for array fields, hiding field widgets, direction of fields, path steps, and meta elements. These updates enhance the flexibility and customization options for the field widgets in the application.
2023-08-06 11:31:19 +02:00
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
"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": {
disabled css schema
2022-11-18 20:10:40 +01:00
"$comment": "https://raw.githubusercontent.com/rcorp/css-schema/master/schema.json"
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
}
}
}
]
}
}
}
}
},
"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"
}
]
meta: folding, foreignKey
2023-03-18 10:48:26 +01:00
},
"css": {
"anyOf": [
{ "type": "string" },
{
"$ref": "https://raw.githubusercontent.com/rcorp/css-schema/master/schema.json"
},
{
"type": "object",
"properties": {
"eval": {
"type": "string",
"description": "javascript code evaled to string or css object"
}
}
}
]
updated schema for contentbuilder and refactored code
2022-11-18 19:59:36 +01:00
}
}
}
Reference in New Issue Copy Permalink