@o3r/configuration
Version:
This module contains configuration-related features such as CMS compatibility, Configuration override, store and debugging. It enables your application runtime configuration and comes with an integrated ng builder to help you generate configurations suppo
225 lines (224 loc) • 6.4 kB
JSON
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "ConfigurationMetadataSchema",
"description": "Schema of Component configurations",
"type": "array",
"items": {
"type": "object",
"required": [
"library",
"name",
"path",
"type",
"properties"
],
"properties": {
"library": {
"type": "string",
"description": "Library name"
},
"name": {
"type": "string",
"description": "Name of the component configuration"
},
"title": {
"type": "string",
"description": "Title of the component configuration"
},
"description": {
"type": "string",
"description": "Description of the component configuration"
},
"path": {
"type": "string",
"description": "Path to the configuration file"
},
"type": {
"type": "string",
"description": "Type of the component",
"enum": [
"BLOCK",
"COMPONENT",
"APPLICATION",
"PAGE",
"GLOBAL",
"NESTED_ELEMENT",
"EXPOSED_COMPONENT"
]
},
"tags": {
"type": "array",
"description": "List of tags associated to the configuration.",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"description": "List of categories with description",
"items": {
"type": "object",
"required": [
"name",
"label"
],
"properties": {
"name": {
"type": "string",
"description": "Configuration category name"
},
"label": {
"type": "string",
"description": "Configuration category description"
}
}
}
},
"properties": {
"type": "array",
"description": "List of configuration properties",
"items": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Configuration property name"
},
"description": {
"type": "string",
"description": "Description of the configuration property"
},
"type": {
"type": "string",
"description": "type of the configuration",
"enum": [
"boolean",
"number",
"string",
"string[]",
"element[]",
"enum",
"enum[]"
]
},
"value": {
"type": "string",
"description": "Value of the property"
},
"values": {
"type": "array",
"description": "Structured configuration array of string",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"patternProperties": {
".*": {
"type": "string"
}
},
"additionalProperties": false
}
]
}
},
"required": {
"type": "boolean",
"description": "If true, the property input will be flagged as mandatory in the CMS view"
},
"widget": {
"type": "object",
"description": "Widget used to display the property",
"required": [
"type"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string"
},
"parameters": {
"type": "object",
"description": "map of widget parameters. Each parameter can be a string, number or boolean or an array of those",
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z0-9-_:.]+$": {
"type": [
"string",
"number",
"boolean",
"array"
],
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
}
}
}
},
"reference": {
"library": "string",
"name": "string"
},
"label": {
"type": "string",
"description": "Name of the property to display"
},
"category": {
"type": "string",
"description": "The category for a configuration property"
},
"choices": {
"type": "array",
"description": "The choices for the enum",
"items": {
"type": "string"
}
},
"restrictionKeys": {
"type": "array",
"description": "Restriction keys to customize the user permissions",
"items": {
"type": "string"
}
}
},
"allOf": [
{
"if": {
"properties": { "type": { "anyOf": [{ "const": "string[]" }, { "const": "element[]" }, { "const": "enum[]" }] } }
},
"then": {
"required": ["values"]
},
"else": {
"required": ["value"]
}
},
{
"if": {
"properties": { "type": { "anyOf": [{ "const": "enum" }, { "const": "enum[]" }] } }
},
"then": {
"required": ["choices"]
}
}
]
},
"minItems": 1
}
}
}
}