Datenmodell

Rezepte

Ein selbst angelegtes Brotrezept in der persönlichen Rezept-Bibliothek. Trägt Identität (Name, Beschreibung, Schwierigkeit), Mengen (Mehl, Gesamt, Einheit), ein optionales Titelbild und die beiden frei aufgebauten Listen ingredients und phases, die den geführten Back-Ablauf steuern.

Modellname: bread_recipe

Endpunkte: 5

Max. Seitengröße: 200

Felder

Validierungsregeln pro Feld. Werte, die diese Bedingungen verletzen, werden mit 400 abgewiesen, bevor sie die Datenbank erreichen.

Feld	Typ	Regeln
diff	`string`	max. Länge`32`
hero	`string`	max. Länge`200`
name	`string`	max. Länge`200`
unit	`string`	max. Länge`32`
blurb	`string`	max. Länge`2000`
flour	`string`	max. Länge`64`
total	`string`	max. Länge`64`
phases	`list`	-
unitPl	`string`	max. Länge`32`
ingredients	`list`	-

Mutabilität

Welche Felder darfst du senden, und wann? Felder ohne Markierung werden vom Server vergeben - das Senden ist kein Fehler, sie werden stillschweigend ignoriert.

Anlegbar - im POST-Body lesbar.Änderbar - im PATCH-Body lesbar.Server-verwaltet - vom Body ignoriert.

Feld	Typ	Anlegbar	Änderbar
diff	string
hero	string
name	string
unit	string
blurb	string
flour	string
total	string
phases	list
unitPl	string
ingredients	list

Felder mit Anlegbar, aber ohne Änderbar, sind nach dem Erstellen unveränderlich. Server-verwaltete Felder umfassen id, Zeitstempel, Eigentümerschaft und Status.

Filter & Sortierung

Auf Listen-Endpunkten kombinierbar. Wiederholte Filter-Keys werden zu IN-Bedingungen, ein - vor einem Sort-Key kehrt die Richtung um. Beispiel: ?status=open&status=blocked&sort=-created_at.

Filter-Keys

namedata__name

diffdata__diff

statusstatus

is_archivedis_archived

owned_byowned_by

Sortier-Keys

created_atcreated_at

updated_atupdated_at

namedata__name

Standard: name

Endpunkte

Jeder Endpunkt unten zeigt seine HTTP-Methode, den Pfad und den dafür benötigten PAT-Scope. Code-Beispiele decken curl, JavaScript, TypeScript, Python, Rust, Java und WebSocket ab.

GET/xapi2/data/bread_recipebread_recipe:list

Objekte auflisten

Liefert eine paginierte Liste sichtbarer Objekte. Standard-Seitengröße 20; mit ?limit= änderbar (typabhängig begrenzt). ?after=<id> für Keyset-Paginierung bei nach created_at sortierten Listen, ?offset= für Offset-Paginierung.

curl -H "Authorization: Bearer pat_…" \
     "https://sourdoughtracker.com/xapi2/data/bread_recipe?limit=20"

GET/xapi2/data/bread_recipe/{id}bread_recipe:read

Einzelnes Objekt lesen

Liefert das Objekt anhand der ID. 404, falls es nicht existiert oder du keinen Lese-Zugriff hast (beide Fälle sind bewusst zusammengelegt).

curl -H "Authorization: Bearer pat_…" \
     https://sourdoughtracker.com/xapi2/data/bread_recipe/OBJECT_ID

POST/xapi2/data/bread_recipebread_recipe:create

Erstellen

Erstellt ein neues Objekt. Der Body ist ein flaches JSON-Dict mit Feldwerten. Server-seitige Felder (id, Zeitstempel, Ownership) werden automatisch gefüllt; nur die unten als anlegbar gelisteten Felder werden aus dem Body übernommen.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X POST https://sourdoughtracker.com/xapi2/data/bread_recipe \
     -d '{"name": "…"}'

PATCH/xapi2/data/bread_recipe/{id}bread_recipe:update

Aktualisieren

Teilweise Aktualisierung. Nur Felder im Body werden verändert; alles andere bleibt erhalten. Gleiche Erlaubnisliste wie bei Create, abzüglich der nach dem Anlegen unveränderlichen Felder.

curl -H "Authorization: Bearer pat_…" \
     -H "Content-Type: application/json" \
     -X PATCH https://sourdoughtracker.com/xapi2/data/bread_recipe/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/bread_recipe/{id}bread_recipe:delete

Löschen

Entfernt das Objekt. Es verschwindet sofort aus allen Standard-Listen und wird von read / list nicht mehr zurückgegeben.

curl -H "Authorization: Bearer pat_…" \
     -X DELETE https://sourdoughtracker.com/xapi2/data/bread_recipe/OBJECT_ID

In der CLI

Dieselben Endpunkte sind auch über die Sourdough Tracker CLI verfügbar. Für Skripte, CI und Bulk-Imports ist sie meist die schnellere Wahl.

sourdoughcli bread_recipe list --limit 5
sourdoughcli bread_recipe get <id>
sourdoughcli bread_recipe create --name "Hello"
sourdoughcli bread_recipe upsert --unique name --csv items.csv
sourdoughcli bread_recipe schema   # Felder & Limits

Volle Befehlsreferenz, Profile, CSV-Import, Auto-Retry, NDJSON-Streaming → /docs/cli