Schema-Properties (generiert)

Diese Seite listet die Properties aller 17 Config-Schemas aus tibi-types/schemas/config/.

Generiert, nicht von Hand editieren — neu erzeugen mit npm run gen:schemas.

Typnamen folgen JSON-Schema (string, integer, number, boolean, object, Liste von …); $ref-Verweise nennen den Baustein und dessen Typ, oneOf-Alternativen sind mit „oder“ verbunden.

action

Tibi action config — action.schema.json

Pflicht: name.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
name	string	ja	—	—
meta	actionMeta (action) — object	nein	—	—
permissions	actionPermissions (action) — object	nein	—	—
hooks	string oder hooks.schema.json — object	nein	—	—
audit	object	nein	—	—
cors	object	nein	—	—

Bausteine in action

Baustein	Felder	Pflicht
actionField	name, type, index, subFields, validator, readonly, hidden, strictFields, meta	name, type
actionMappedField	source, name, type, subFields, meta	type
actionFieldSection	title, description, fields	—
actionExecutionMeta	kind, cancellable	—
actionOutputProgressMapping	indexField, countField, statusField, messageField, fields	—
actionOutputMappingSection	fields	—
actionOutputMapping	summary, details, progress	—
actionOutputMeta	title, mapping	—
actionMethodMeta	query, data, execution, output	—
actionMeta	label, muiIcon, description, group, hide, methods	—
actionPermissionSet	methods	methods
actionPermissions	public, user	public, user

asset

Tibi asset config — asset.schema.json

Pflicht: name, path.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
name	string	ja	—	—
path	string	ja	—	—

collection-meta

Tibi collection meta config — collection-meta.schema.json

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
label	i18nText (defs) — string oder object	nein	—	—
muiIcon	string	nein	—	—
group	string	nein	—	—
exports	Liste von object	nein	—	Custom scripted exports (tibi-admin-nova ExportDialog). The script loads data itself via db.find/loadAll.
designGuide	i18nText (defs) — string oder object	nein	—	—
imageUrl	string oder evalString (defs) — object	nein	—	—
hide	boolean	nein	—	—
singleton	object	nein	—	—
subNavigation	Liste von object	nein	—	—
preview	previewConfig (defs) — fieldPath (defs) oder evalHtml (defs) oder previewSlots (defs)	nein	—	—
i18n	boolean, eine von: false oder object	nein	—	—
defaultSort	object	nein	—	—
viewHint	string, eine von: table, cards oder object	nein	—	—
pagebuilder	object	nein	—	—
sidebar	Liste von object	nein	—	—
sections	Liste von object	nein	—	—
openapi	openapi.schema.json — object	nein	—	—
query	object	nein	—	Additional query parameters hooks may read (ctx.request().query(name)). Documented for agents (REST _meta/OpenAPI, MCP collection_describe + extra argument) and validated on MCP calls. Credential-like keys (permission token names, auth headers) and core query keys are never allowed.
agent	object	nein	—	Editor- und Agenten-Dokumentation (Zweck, Workflows, Gotchas). Freiform-Doku, wird u.a. ueber MCP/REST _meta ausgespielt.

collection

Tibi collection config — collection.schema.json

Pflicht: name, permissions.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
name	string	ja	—	—
defaultLanguage	string	nein	—	—
uploadPath	string	nein	—	—
upload	uploadConfig (collection) — object	nein	—	—
permissions	string oder permissions.schema.json — object	ja	—	—
projections	string oder projections.schema.json — object	nein	—	—
hooks	string oder hooks.schema.json — object	nein	—	—
meta	string oder collection-meta.schema.json — object	nein	—	—
imageFilter	string oder image-filter.schema.json — object	nein	—	—
fields	string oder field-list.schema.json — Liste von string oder field.schema.json	nein	—	—
indexes	string oder Liste von (string oder indexConfig (collection) — object)	nein	—	—
audit	object	nein	—	—
bulk	object	nein	—	—
cors	object	nein	—	—
queryLimits	object	nein	—	—
readonlyFields	Liste von fieldPath (defs) — string	nein	—	—
hiddenFields	Liste von fieldPath (defs) — string	nein	—	—
strictFields	boolean	nein	—	—
search	Liste von searchConfig (collection) — object	nein	—	—

Bausteine in collection

Baustein	Felder	Pflicht
uploadConfig	maxBodySize, allowedMimeTypes	—
indexConfig	name, key, unique, dropDups, background, sparse, defaultLanguage, languageOverride	key
searchConfig	name, mode, fields, meta, eval, filter, ngram, regex, score, vector, rrf, async, autoRegenerate	name, mode

defs

Shared definitions for Tibi config schemas — defs.schema.json

Dieses Schema definiert nur $ref-Bausteine (kein eigenes Config-Ziel):

Baustein	Typ	Pflicht	Beschreibung
i18nText	string oder object	—	—
fieldPath	string	—	—
evalString	object	Pflicht: eval	—
evalHtml	object	Pflicht: eval	—
boolOrEval	boolean oder evalString (defs)	—	—
boolOrUiCondition	boolean oder string oder evalString (defs)	—	—
uiCondition	string oder evalString (defs)	—	—
sortField	fieldPath (defs) oder object	—	—
pagebuilderViewport	integer oder string, eine von: desktop, tablet, phone	—	—
badgeVariant	string, eine von: success, error, warning, info, neutral	—	—
choiceItem	object	—	—
choices	string oder Liste von choiceItem (defs) oder object	—	—
previewTableColumn	fieldPath (defs) oder object	—	—
previewSlots	object	—	—
previewConfig	fieldPath (defs) oder evalHtml (defs) oder previewSlots (defs)	—	—
foreignRender	fieldPath (defs) oder evalHtml (defs) oder object oder previewSlots (defs)	—	—
methodPermissionGet	boolean oder object	—	—
methodPermissionWrite	boolean oder object	—	—

embedding

Tibi server config — embedding section (server-level, not project config) — embedding.schema.json

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
providers	Liste von provider — object	nein	—	—
groups	Liste von group — object	nein	—	—
goldenPath	string	nein	—	Verzeichnis der Gold-Dateien für die Mitglieds-Prüfung (Vorgabe: testdata/embedding-golden relativ zum Arbeitsverzeichnis). Erzeugen mit cmd/embed-probe-golden. Ohne verankerte Gold-Datei prüft die Gruppe nur gegen ihre Referenz.

Bausteine in embedding

Baustein	Felder	Pflicht
provider	name, type, model, modelPath, dimensions, baseURL, apiKey, documentPrefix, queryPrefix, timeoutPerAttempt, slowThreshold, revision, sparse	name
group	name, description, members, onSingleQuery, onBulkWrite, health	name, members

field-list

Tibi field list config — field-list.schema.json

Dieses Schema beschreibt eine Liste — keine Objekt-Properties, sondern Elemente:

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
[] (Elemente)	string oder field.schema.json — field	—	—	Jedes Element ist entweder ein Feldname (string) oder ein Feld-Objekt nach field.schema.json.

field-meta

Tibi field meta config — field-meta.schema.json

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
label	i18nText (defs) — string oder object	nein	—	—
widget	string, eine von: text, textarea, number, checkbox, switch, select, selectArray, chipArray, date, datetime, file, image, json, richtext, html, foreignKey, foreignKeyChipArray, foreignFile, foreignMedia, pagebuilder, pageBuilder, templateProps, containerLessObject, containerLessObjectArray, color	nein	—	—
i18n	fest: false	nein	—	—
helperText	i18nText (defs) — string oder object	nein	—	—
hideLabel	boolean	nein	—	—
hide	boolean	nein	—	—
protected	boolOrUiCondition (defs) — boolean oder string oder evalString (defs)	nein	—	—
position	string	nein	—	—
section	i18nText (defs) — string oder object	nein	—	—
containerProps	object	nein	—	—
defaultValue	string oder number oder boolean oder null oder array oder object	nein	—	—
dependsOn	uiCondition (defs) — string oder evalString (defs)	nein	—	—
inputProps	object	nein	—	—
choices	choices (defs) — string oder Liste von choiceItem (defs) oder object	nein	—	—
foreign	object	nein	—	—
downscale	object	nein	—	—
imageEditor	boolean oder object	nein	—	—
drillDown	boolean	nein	—	—
pageSize	integer	nein	—	—
preview	previewConfig (defs) — fieldPath (defs) oder evalHtml (defs) oder previewSlots (defs)	nein	—	—
addElementLabel	i18nText (defs) — string oder object	nein	—	—
filter	boolean oder object	nein	—	—
pagebuilder	object	nein	—	—
schemaRef	object	nein	—	—
openapi	fieldOpenapi (openapi) — object	nein	—	—

field

Tibi field config — field.schema.json

Bildet den Baustein field dieses Schemas ab.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
name	string	ja	—	—
type	string, eine von: string, string[], number, number[], boolean, object, object[], file, file[], date, any	ja	—	—
index	Liste von string, eine von: single, unique, text, sparse, background	nein	—	—
subFields	string oder Liste von (string oder field — object)	nein	—	—
validator	object	nein	—	—
readonly	boolOrEval (defs) — boolean oder evalString (defs)	nein	—	—
hidden	boolOrEval (defs) — boolean oder evalString (defs)	nein	—	—
strictFields	boolean	nein	—	—
meta	field-meta.schema.json — object	nein	—	—

Bausteine in field

Baustein	Felder	Pflicht
field	name, type, index, subFields, validator, readonly, hidden, strictFields, meta	name, type

hooks

Tibi hooks config — hooks.schema.json

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
get	getHooks (hooks) — object	nein	—	—
post	postHooks (hooks) — object	nein	—	—
put	putHooks (hooks) — object	nein	—	—
delete	deleteHooks (hooks) — object	nein	—	—
audit	auditHooks (hooks) — object	nein	—	—

Bausteine in hooks

Baustein	Felder	Pflicht
hook	type, file, timeout	type, file
getHooks	handle, read, return, file	—
postHooks	bind, validate, handle, create, return, bulkCreate, bulkReturn	—
putHooks	bind, validate, update, return, bulkUpdate, bulkReturn	—
deleteHooks	delete, return, bulkDelete, bulkReturn	—
auditHooks	return	—

image-filter

Tibi image filter config — image-filter.schema.json

Dieses Schema nutzt freie Schlüssel (Pattern):

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
<name> (Muster ^[a-zA-Z0-9_-]+$)	Liste von object	—	—	Freier Schlüssel, Wert siehe Untertabelle.

Wertefelder zu ^[a-zA-Z0-9_-]+$

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
width	number	nein	—	—
height	number	nein	—	—
fit	boolean	nein	—	—
fill	boolean	nein	—	—
resampling	string, eine von: nearestNeighbor, hermite, linear, catmullRom, lanczos, box, mitchellNetravili, bSpline, gaussian, bartlett, hann, hamming, blackman, welch, cosine	nein	—	—
anchor	string, eine von: center, topLeft, top, topRight, left, right, bottomLeft, bottom, bottomRight	nein	—	—
brightness	number	nein	—	—
saturation	number	nein	—	—
contrast	number	nein	—	—
gamma	number	nein	—	—
blur	number	nein	—	—
sharpen	number	nein	—	—
invert	boolean	nein	—	—
grayscale	boolean	nein	—	—
quality	number	nein	—	—
lossless	boolean	nein	—	—
skipLargerDimension	boolean	nein	—	—
skipLargerFilesize	boolean	nein	—	—
outputType	string, eine von: jpg, jpeg, png, webp	nein	—	—

job

Tibi job config — job.schema.json

Pflicht: type, file.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
cron	string	nein	—	—
type	fest: javascript	ja	—	—
file	string	ja	—	—
timeout	integer	nein	—	—
meta	object	nein	—	—

openapi

Tibi OpenAPI collection config — openapi.schema.json

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
disabled	boolean	nein	—	Exclude this entire collection from the generated OpenAPI spec
get	operationObject — object	nein	—	OpenAPI operation overrides for the list endpoint (GET /{collection})
getOne	operationObject — object	nein	—	OpenAPI operation overrides for the single-entry endpoint (GET /{collection}/{id})
post	operationObject — object	nein	—	OpenAPI operation overrides for the create endpoint (POST /{collection})
put	operationObject — object	nein	—	OpenAPI operation overrides for the update endpoint (PUT /{collection}/{id})
delete	operationObject — object	nein	—	OpenAPI operation overrides for the delete endpoint (DELETE /{collection}/{id})

Bausteine in openapi

Baustein	Felder	Pflicht
codeSample	lang, label, source	lang, source
responseObject	description, x-summary	—
operationObject	disabled, tags, summary, description, x-codeSamples, parameters, responses, security	—
fieldOpenapi	disabled, description, example, format, enum, deprecated	—

permissions

Tibi permissions config — permissions.schema.json

Pflicht: public, user.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
public	permissionSet (permissions) — object	ja	—	—
user	permissionSet (permissions) — object	ja	—	—

Bausteine in permissions

Baustein	Felder	Pflicht
permissionSet	methods, filter, validProjections, readonlyFields, hiddenFields	methods

project

Tibi project config — project.schema.json

Pflicht: namespace.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
namespace	string	ja	—	—
meta	object	nein	—	—
upload	uploadConfig (project) — object	nein	—	—
collections	Liste von (string oder collection.schema.json — object)	nein	—	—
jobs	Liste von (string oder job.schema.json — object)	nein	—	—
actions	Liste von (string oder action.schema.json — object)	nein	—	—
assets	Liste von (string oder asset.schema.json — object)	nein	—	—
cors	object	nein	—	—
admin	object	nein	—	—
hook	object	nein	—	—
audit	object	nein	—	—
strictFields	boolean	nein	—	—
snapshotPath	string	nein	—	Base directory for snapshot data, relative to configDir. Default: ‘{configDir}/snapshots’.
snapshots	Liste von (string oder snapshot.schema.json — object)	nein	—	List of snapshot profiles for automated point-in-time backups.
legacy	object	nein	—	—

Bausteine in project

Baustein	Felder	Pflicht
uploadConfig	maxBodySize, allowedMimeTypes	—

projections

Tibi projections config — projections.schema.json

Dieses Schema nutzt freie Schlüssel (Pattern):

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
<name> (Muster ^[a-zA-Z0-9_]+$)	object	—	—	Freier Schlüssel, Wert siehe Untertabelle.

Wertefelder zu ^[a-zA-Z0-9_]+$

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
select	object oder null	ja	—	—

snapshot

Tibi snapshot config — snapshot.schema.json

Pflicht: name.

Property	Typ	Pflicht	Vorgabe/Default	Beschreibung
name	string	ja	—	Unique identifier for this snapshot profile (e.g. ‘content-navigation’)
description	string	nein	—	Optional human-readable explanation of this snapshot profile
collections	Liste von (string oder object)	nein	—	Collection filter: empty = all, include-mode = only listed, exclude-mode = all except listed. Mixed include+exclude is invalid.
includeMedia	boolean	nein	true	Whether to include media files (file/file[] fields) via hardlinks. Default: true.
collectionDedup	boolean	nein	false	Enable SHA256-based deduplication of collection JSON exports. Identical exports share one canonical copy via hardlinks in .store/collections/. Default: false.
mode	string, eine von: json, db, both	nein	—	Storage strategy for collection data. ‘json’ = BSON Extended JSON files on disk (current, implemented), ‘db’ = MongoDB $out copy (future), ‘both’ = both (future). Default: ‘json’.
retention	object	nein	—	Auto-pruning rules for old snapshot entries. Omit for unlimited retention.
schedule	string	nein	—	Cron expression for automatic execution (e.g. ‘0 3 * * *’ = daily 3am UTC, ‘@every 24h’). Empty = manual trigger only.
permissions	Liste von string	nein	—	Bare permission names for team-based access (Phase 2). Empty = admin-only in Phase 1.
enabled	boolean	nein	false	Whether this snapshot profile is active. Disabled profiles are skipped by the scheduler but can still be triggered manually.

Generiert aus tibi-types 9e12a8e (Stand 2026-10-19) — Änderungen an den Schemas dort erfordern npm run gen:schemas.