opencode
6c92b6358d
Full documentation hub replacing the release-notes-only view: - Handbook pages (docs/handbook) for all features and admin/betrieb - API reference generated from lib/api-spec/openapi.yaml via scripts/src/generate-docs.mjs (replaces sync-release-docs.mjs): endpoints, schemas/fields, search index, per-release snapshots - mkdocs layout: sidebar nav, right TOC with scrollspy, search overlay, version dropdown, repo link - FieldHelp (?) buttons in forms linking to reference field docs - v0.7.0 release notes backfilled, v0.8.0 release notes added
61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
---
|
||
title: Datenmodell & Felder
|
||
order: 8
|
||
---
|
||
|
||
# Datenmodell & Felder
|
||
|
||
Dieses Handbuch erklärt die zentralen Objekte von toolr auf verständliche
|
||
Weise. Die **vollständige, maschinell generierte Feld-Referenz** findest du in
|
||
der [Referenz](/docs/reference/schemas/tool) — dort sind alle Typen, Pflicht-
|
||
angaben und Constraints der aktuellen Version dokumentiert.
|
||
|
||
> Die Referenz ist **versionsgebunden**: Über das Versions-Dropdown oben
|
||
> kannst du ältere API-Stände einsehen.
|
||
|
||
## Die wichtigsten Objekte
|
||
|
||
### Tool
|
||
|
||
Ein Tool ist der zentrale Eintrag im Katalog
|
||
([Feld-Referenz](/docs/reference/schemas/tool)):
|
||
|
||
| Feld | Bedeutung |
|
||
| --- | --- |
|
||
| `id` | Eindeutige ID. |
|
||
| `name` | Anzeigename. |
|
||
| `description` | Kurzbeschreibung. |
|
||
| `category` | Kategorie-Zuordnung. |
|
||
| `websiteUrl` / `iconUrl` | Offizielle Website bzw. Logo-Link (optional). |
|
||
| `createdBy` | Nutzer, der das Tool angelegt hat (optional). |
|
||
| `features` / `tags` | Listen von Schlüsselfähigkeiten bzw. Schlagwörtern. |
|
||
| `createdAt` / `updatedAt` | Zeitstempel. |
|
||
| `deletedAt` / `deletedBy` | Soft-Delete-Informationen (Papierkorb). |
|
||
|
||
> **ToolWithStats** erweitert `Tool` um die Aggregatwerte `ratingCount`,
|
||
> `avgUsefulness`, `avgUsability` und `avgCombined` (siehe
|
||
> [Feld-Referenz](/docs/reference/schemas/toolwithstats)).
|
||
|
||
### Rating
|
||
|
||
Eine Bewertung (`Rating`) besteht aus `usefulness` und `usability` (jeweils
|
||
1–5) sowie optionalem Kommentar und Bewerternamen. Details unter
|
||
[Bewertungen](/docs/handbook/bewertungen).
|
||
|
||
### User / AuthUser
|
||
|
||
- **User** (Admin-Sicht): `id`, `username`, `email`, `role`, `tier`,
|
||
`authProvider`, `createdAt` — siehe [Administration](/docs/handbook/administration).
|
||
- **AuthUser** (Eigenansicht): `sub`, `email`, `name`, `preferredUsername`,
|
||
`role`, `tier`, `entitlements`, `isLocal`.
|
||
|
||
### VersionInfo
|
||
|
||
`GET /version` liefert `version`, `commitSha`, `buildDate` und
|
||
`trashRetentionDays` (siehe [Feld-Referenz](/docs/reference/schemas/versioninfo)).
|
||
|
||
## Referenz selber durchsuchen
|
||
|
||
Nutze das **Suchfeld** in der Doku-Seitenleiste: Es durchsucht Handbuch,
|
||
Endpunkt- und Feldbeschreibungen und springt direkt zum passenden Anker.
|