Datenmodell

Sauerteige

Ein einzelner Sauerteig-Starter. Trägt Identität (Name, Herkunft, Startdatum), Rezept-Defaults (Mehlsorte, Hydration), Zustand (letzte Fütterung, ausser Dienst) und Darstellung (Farbe, Avatar, Tags, Favorit). Übergeordnetes Objekt für jeden Journal-Eintrag des Starters.

Modellname: sourdough

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
mode	`enum`	enum`establishing \| maintenance \| activating \| baking`
name	`string`	max. Länge`120`
slug	`string`	max. Länge`120`
tags	`tags`	-
color	`string`	max. Länge`24`
notes	`string`	max. Länge`8000`
source	`string`	max. Länge`200`
retired	`bool`	-
favorite	`bool`	-
flour_type	`enum`	enum`white \| whole_wheat \| rye \| spelt \| einkorn \| khorasan \| mixed \| other`
started_at	`string`	max. Länge`32`
last_fed_at	`string`	max. Länge`32`
establish_day	`number`	-
feeding_ratio	`string`	max. Länge`32`
hydration_pct	`number`	-
ambient_temp_c	`number`	-
computed_state	`string`	max. Länge`64`
bake_target_date	`string`	max. Länge`32`
feeding_freq_hours	`number`	-
establish_started_at	`string`	max. Länge`32`
establish_step_done_at	`string`	max. Länge`64`
establish_next_remind_at	`string`	max. Länge`64`

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
mode	enum
name	string
slug	string
tags	tags
color	string
notes	string
source	string
retired	bool
favorite	bool
flour_type	enum
started_at	string
last_fed_at	string
establish_day	number
feeding_ratio	string
hydration_pct	number
ambient_temp_c	number
computed_state	string
bake_target_date	string
feeding_freq_hours	number
establish_started_at	string
establish_step_done_at	string
establish_next_remind_at	string

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

slugdata__slug

flour_typedata__flour_type

retireddata__retired

favoritedata__favorite

tagsdata__tags

statusstatus

is_archivedis_archived

owned_byowned_by

Sortier-Keys

created_atcreated_at

updated_atupdated_at

namedata__name

started_atdata__started_at

last_fed_atdata__last_fed_at

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/sourdoughsourdough: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/sourdough?limit=20"

GET/xapi2/data/sourdough/{id}sourdough: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/sourdough/OBJECT_ID

POST/xapi2/data/sourdoughsourdough: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/sourdough \
     -d '{"name": "…"}'

PATCH/xapi2/data/sourdough/{id}sourdough: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/sourdough/OBJECT_ID \
     -d '{"name": "…"}'

DELETE/xapi2/data/sourdough/{id}sourdough: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/sourdough/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 sourdough list --limit 5
sourdoughcli sourdough get <id>
sourdoughcli sourdough create --name "Hello"
sourdoughcli sourdough upsert --unique name --csv items.csv
sourdoughcli sourdough schema   # Felder & Limits

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