tibi-docs/api/config.yml

# Der Namespace legt die eigentliche Projektbezeichnung und den Datenbankkontext fest.
# Er sollte nach Projektinitialisierung auf dem tibi-server nicht mehr angepasst werden.
# In den Projekteinstellungen im tibi-server kann der Namespace durch einen Datenbankeintrag
# überschrieben werden.
# Über die Bezeichnung des Namespace plus einen Prefix der in der globalen Server-Konfig
# hinterlegt ist, definiert sich der Datenbank-Name innerhalb der MongoDB.
namespace: demo

# Das "meta"-Objekt ist frei definierbar, wird aber vom tibi-admin in spezieller Form erwartet.
# Mögliche Angaben, die der tibi-admin versteht, sind hier mit aufgeführt.
meta:
    # OpenAPI Spezifikationen
    openapi:
        #info:
        #    title: Demo API
        #    version: 1.0.0
        #    description: Eine Demo-API für den tibi-server
        servers:
            - url: https://tibi-admin-server.code.testversion.online/api/v1/_/demo
              description: code-server

    # Pfad zu einer Bilddatei die als Projektbild im tibi-admin verwendet wird
    imageUrl:
        eval: "$projectBase + '_/assets/img/pic.jpg'"

    # Liste möglicher Berechtigungen, die Benutzern zugeordnet werden können
    permissions:
        - # Name der Berechtigung
          name: news
          # Label für die Anzeige im Admin
          # (kann string oder object mit Sprachen als keys sein)
          label:
              de: Neuigkeiten
              en: News

        - name: pages
          label:
              de: Seiten
              en: Pages

# "collections" ist eine Auflistung von Kollektions-Konfigurationen.
# Hier bietet sich eine Auslagerung und Einbindung via YAML-Tag "!include" an.
collections:
    - !include collections/democol.yml
    - !include collections/medialib.yml
    # Dummy Kollektion für Hooks, die für serverseitiges Rendering benötigt werden
    - !include collections/ssr.yml

# Unter "jobs" können Jobs definiert werden, die regelmäßig ausgeführt werden sollen.
jobs:
    - !include jobs/demojob.yml

# Werden Dateien innerhalb vom tibi-admin benötigt, bietet es sich an diese über
# "assets"-Pfade erreichbar zu machen.
assets:
    - !include assets/demoassets.yml
    - name: img
      path: img