Datenmodell
Journal-Einträge
Ein Eintrag im fortlaufenden Journal des übergeordneten Starters. Diskriminiert über kind ∈ {feed, bake, observation, milestone, photo}. Trägt occurred_at, optionale Bewertungen (Anstieg/Geruch/Blasen), Rezeptdetails für Bakes, ein Inline-Foto über photo_blob_id und einen freien Text. Die chronologische Anzeige auf der Starter-Seite liest gefiltert nach parent_id aus dieser Slice.
log_entry200Felder
Validierungsregeln pro Feld. Werte, die diese Bedingungen verletzen, werden mit 400 abgewiesen, bevor sie die Datenbank erreichen.
| Feld | Typ | Regeln |
|---|---|---|
| body | string | max. Länge 8000 |
| kind | enum | enum feed | bake | observation | milestone | photo |
| tags | tags | - |
| title | string | max. Länge 200 |
| rise_pct | number | - |
| parent_id | string | max. Länge 64ref →sourdoughowned |
| flour_used | string | max. Länge 200 |
| loaf_count | number | - |
| aroma_score | number | - |
| bake_recipe | string | max. Länge 4000 |
| occurred_at | string | max. Länge 32 |
| bake_outcome | enum | enum amazing | great | ok | dense | flat | undercooked | overcooked |
| water_temp_c | number | - |
| feeding_ratio | string | max. Länge 32 |
| hydration_pct | number | - |
| ambient_temp_c | number | - |
| bubble_activity | number | - |
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.
| Feld | Anlegbar | Änderbar |
|---|---|---|
| body | ||
| kind | ||
| tags | ||
| title | ||
| rise_pct | ||
| parent_id | ||
| flour_used | ||
| loaf_count | ||
| aroma_score | ||
| bake_recipe | ||
| occurred_at | ||
| bake_outcome | ||
| water_temp_c | ||
| feeding_ratio | ||
| hydration_pct | ||
| ambient_temp_c | ||
| bubble_activity |
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
data__parent_iddata__kinddata__bake_outcomestatusis_archivedowned_bySortier-Keys
data__occurred_atcreated_atupdated_atStandard: occurred_at
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.
/xapi2/data/log_entrylog_entry:listObjekte 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/log_entry?limit=20"
/xapi2/data/log_entry/{id}log_entry:readEinzelnes 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/log_entry/OBJECT_ID
/xapi2/data/log_entrylog_entry:createErstellen
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/log_entry \-d '{"name": "…"}'
/xapi2/data/log_entry/{id}log_entry:updateAktualisieren
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/log_entry/OBJECT_ID \-d '{"name": "…"}'
/xapi2/data/log_entry/{id}log_entry:deleteLö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/log_entry/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 log_entry list --limit 5sourdoughcli log_entry get <id>sourdoughcli log_entry create --parent-id "Hello"sourdoughcli log_entry upsert --unique parent_id --csv items.csvsourdoughcli log_entry schema # Felder & Limits
Volle Befehlsreferenz, Profile, CSV-Import, Auto-Retry, NDJSON-Streaming → /docs/cli