openapi

api/collections/democol/meta.yml

@@ -100,3 +100,13 @@ subNavigation:
 # vorgesehen.
 # Die Definition befindet sich in einem gesonderten Kapitel
 tablist: !include tablist.yml
+
+# OpenAPI-Spezifikation für die API-Endpunkte der Kollektion
+openapi:
+    get:
+        summary: 
+            en: list all datasets of democol
+            de: listet alle Datensätze der Kollektion democol auf
+        description: 
+            en: list all datasets of democol with pagination and/or filtering
+            de: listet alle Datensätze der Kollektion democol mit Paginierung und/oder Filterung

api/collections/fields/info.yml

@@ -11,3 +11,22 @@ subFields:
           label:
               de: Autor
               en: Author
+    - name: tags
+      type: object[]
+      meta:
+          label:
+              de: Tags
+              en: Tags
+      subFields:
+          - name: name
+            type: string
+            meta:
+                label:
+                    de: Name
+                    en: Name
+          - name: color
+            type: string
+            meta:
+                label:
+                    de: Farbe
+                    en: Color

api/collections/fields/title.yml

@@ -4,3 +4,5 @@ meta:
     label:
         de: Titel
         en: Title
+    openapi:
+        example: Demo Titel

api/collections/medialib.yml

@@ -98,3 +98,6 @@ meta:
                       parent.focus()
                   }
                   //!js
+
+    openapi:
+        disabled: true

api/config.yml

@@ -9,6 +9,16 @@ 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'"