Skip to main content

Meta-Daten zu Feldern einer API

Im Unter-Element cms von Feldern einer API werden Meta-Daten zum jeweiligen Feld gespeichert. Im früheren Beispiel zum Datentyp String besagte bspw. "column": true, dass das Feld in der Listenansicht im CMS-Frontend dargestellt wird:

{
"application": "Tutorial",
"label": "API1 / String",
"project": "NeuroomNet-CMS Tutorial",

"fields": {
"name": {
"type": "string",
"empty": false,
"max": 40,
"min": 4,
"optional": false,
"cms": {
"column": true
}
}
}
}

Insgesamt gibt es folgende mögliche Einstellungen:

  • column wird für Felder gesetzt, die in der Liste erscheinen sollen
  • sortable erlaubt die Sortierung nach den Werten des Feldes
  • ascending ist (nur) dann die bevorzugte Sortierung
  • fulltext berücksichtigt das Feld bei einer Freitextsuche
  • unique verlangt, dass das Feld eindeutig ist - kann evtl. nur im Server geprüft werden
  • index erstellt einen Datenbankindex (ascending oder descending) zur Beschleunigung der Suche
  • useCase unterscheidet zwischen Groß- und Kleinschreibung
  • label der Anzeigename des Feldes in der CMS-Frontend

Natürlich ist hier der Phantasie erst einmal keine Grenze gesetzt, aber das CMS soll ja letztlich einfach bleiben und eine Beschränkung auf das Notwendigste ist sinnvoll - in diesem Sinne sind auf Basis der üblichen Erfahrungen die aufgeführten Einstellung das erforderlich Minimum.

column ist ein reiner Hinweis für das CMS-Frontend. Auch hier kann man sich noch weitere Layouteinstellungen für den Daten-Editier-Dialog vorstellen. Im Moment werden etwa alle Felder einfach in der Reihenfolge der API Konfiguration untereinander zur Eingabe angeboten.