diff --git a/api/collections/democol/meta.yml b/api/collections/democol/meta.yml index 8bf43ff..b052fe6 100644 --- a/api/collections/democol/meta.yml +++ b/api/collections/democol/meta.yml @@ -99,4 +99,14 @@ subNavigation: # Um diese Anordnung in Tabs zu strukturieren, ist die Verwendung von "tablist" # vorgesehen. # Die Definition befindet sich in einem gesonderten Kapitel -tablist: !include tablist.yml \ No newline at end of file +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 \ No newline at end of file diff --git a/api/collections/fields/info.yml b/api/collections/fields/info.yml index 4fa3c9a..d1e0254 100644 --- a/api/collections/fields/info.yml +++ b/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 diff --git a/api/collections/fields/title.yml b/api/collections/fields/title.yml index d7531d7..cc96fed 100644 --- a/api/collections/fields/title.yml +++ b/api/collections/fields/title.yml @@ -4,3 +4,5 @@ meta: label: de: Titel en: Title + openapi: + example: Demo Titel diff --git a/api/collections/medialib.yml b/api/collections/medialib.yml index 1efdf0e..be7af3b 100644 --- a/api/collections/medialib.yml +++ b/api/collections/medialib.yml @@ -98,3 +98,6 @@ meta: parent.focus() } //!js + + openapi: + disabled: true \ No newline at end of file diff --git a/api/config.yml b/api/config.yml index 67f3e78..4c1f471 100644 --- a/api/config.yml +++ b/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'"