corrections

This commit is contained in:
2023-06-07 08:58:23 +00:00
parent e3bd309274
commit a976ce09bd
13 changed files with 54 additions and 29 deletions

View File

@@ -1,7 +1,8 @@
# /assets
Die /assets-API ist dazu gedacht, den Zugriff auf bestimmte Ordnerpfade zu ermöglichen, die direkt über den Tibi-Server erreichbar sind. Diese Pfade werden in der Konfigurationsdatei (config.yml) definiert und relativ zu dieser Datei interpretiert. Jeder dieser Pfade wird durch einen eindeutigen Namen identifiziert, der in der URL verwendet wird.
URL-Struktur
## URL-Struktur
Die Struktur der URL für den Zugriff auf die Assets ist wie folgt:

View File

@@ -1,6 +1,6 @@
# `/_/NAMESPACE/COLLECTION`
Dieser Endpoint ermöglicht Interaktionen mit den Collectionen, die flexible Strukturen zur Organisation und Kategorisierung von Daten darstellen. Sie können Collectioneintrag abrufen, aktualisieren, erstellen und löschen. Jede Collection wird durch einen eindeutigen Namespace und Namen identifiziert.
Dieser Endpoint ermöglicht Interaktionen mit den Collectionen, die flexible Strukturen zur Organisation und Kategorisierung von Daten darstellen. Sie können einen Collectioneintrag abrufen, aktualisieren, erstellen und löschen. Jede Collection wird durch einen eindeutigen Namespace und Namen identifiziert.
## GET /{namespace}/{collection}
@@ -12,7 +12,7 @@ Die Antwort ist ein Objekt mit folgenden Eigenschaften:
- `data`: Ein Array von CollectionEntry Objekten.
- `count`: Die Gesamtzahl der Einträge die zurückgegeben wurden.
- `count`: Die Gesamtzahl der Einträge.
```ts
interface Collection {
@@ -84,7 +84,7 @@ Diese Anforderung löscht einen vorhandenen Eintrag in einer Collection. Sie nim
Die Antwort ist ein boolean, das true zurückgibt, wenn das Löschen erfolgreich war.
Jede Collection besteht aus mehreren Feldern (CollectionField), die verschiedene Datenpunkte repräsentieren. Jedes Feld hat einen Namen, einen Typ und ggf. eine Reihe von Subfeldern. Die Metadaten eines Feldes (CollectionFieldMeta) können zusätzliche Informationen über das Feld enthalten, wie z.B. ein Label, Hilfstexte, Widget-Typen und mehr.
Jede Collection besteht aus mehreren Feldern (CollectionField), die verschiedene Datenpunkte repräsentieren. Jedes Feld hat einen Namen, einen Typ und ggf. eine Reihe von Subfeldern. Die Metadaten eines Feldes (CollectionFieldMeta) können zusätzliche Informationen über das Feld enthalten, wie z.B. ein Label, Hilfstexte, Widget-Typen, InputProps und mehr.
Eine Collection kann auch Metadaten (CollectionMeta) enthalten, die Informationen über die Collection selbst enthalten.

View File

@@ -6,7 +6,7 @@ Dieser Endpoint ermöglicht es Benutzern, sich in das System einzuloggen. Dabei
## Anforderungsparameter
Der /login Endpoint erwartet folgende Daten im Anforderungskörper (options.data):
Der /login Endpoint erwartet folgende Daten im Body:
- `username`: Der Benutzername des Benutzers, der sich anmelden möchte. Typ: String.
@@ -35,7 +35,7 @@ interface User {
insertTime: string // Zeitpunkt der Erstellung des Benutzerkontos
updateTime: string // Letzter Zeitpunkt der Aktualisierung des Benutzerkontos
username: string // Benutzername des Benutzers
role: number // Rolle des Benutzers im System
role: number // Rolle des Benutzers im System (0=admin, 1 = editor, 2 = user)
permissions: any[] // Berechtigungen des Benutzers
meta: {
// Weitere optionale Benutzerinformationen

View File

@@ -1,21 +1,19 @@
# `/project`
Dieser Endpoint bietet eine Schnittstelle für den Zugriff und die Manipulation von Projektdaten. Benutzer können Projekte erstellen, abrufen, aktualisieren und löschen.
GET /project
## GET /project
Mit dieser Funktion können Sie eine Liste aller Projekte abrufen. Diese Funktion nimmt optionale Parameter an, die verwendet werden können, um die abgerufenen Projekte zu sortieren oder zu filtern.
Diese Anforderung ruft eine Liste aller Projekte ab. Sie kann optionale Parameter verwenden, um die abgerufenen Projekte zu sortieren oder zu filtern.
Antwort
Diese request ruft eine Liste aller Projekte ab. Sie kann optionale Parameter verwenden, um die abgerufenen Projekte zu sortieren oder zu filtern.
### Antwort
Die Antwort auf diese Anforderung ist ein Objekt mit zwei Eigenschaften:
Die Antwort auf diese request ist ein Objekt mit zwei Eigenschaften:
- `data`: Ein Array von Projekt-Objekten.
- `count`: Die Gesamtzahl der Projekte die zurück gegeben wurden.
- `count`: Die Gesamtzahl der Projekte die es gibt.
Jedes Projekt-Objekt hat die folgenden Eigenschaften:
@@ -24,7 +22,7 @@ interface Project {
id?: string // Eindeutiger Identifikator für das Projekt
insertTime?: string // Zeitpunkt der Erstellung des Projekts
updateTime?: string // Letzter Zeitpunkt der Aktualisierung des Projekts
configFile: string // Pfad zur Konfigurationsdatei des Projekts
configFile: string // Pfad zur config.yml des Projekts
name: string // Name des Projekts
description: string // Beschreibung des Projekts
users?: string[] // Array von Benutzer-IDs mit Zugriff auf das Projekt

View File

@@ -12,7 +12,7 @@ Die Antwort auf diese Anforderung ist ein Users Objekt mit folgenden Eigenschaft
- `data`: Ein Array von User Objekten.
- `count`: Die Gesamtzahl der Benutzer (optional).
- `count`: Die Gesamtzahl der Benutzer.
Jedes User Objekt hat die folgenden Eigenschaften: