Open-source gym & body-weight tracker, now in the App Store (iPhone + Apple Watch) and as an Android APK. Plan routines, log workouts, see which muscles are trained, import from Strong/Hevy/FitNotes. Self-host it or use it on the phone alone.
JavaScript apple-watchbodyweightdockerfitnessfitness-trackergymhealthiosmcpnodejspasskeysprogressive-web-applicationspwareactself-hostedself-hostingvitewebauthnweightliftingworkout-tracker
Follow-up to #255: the API reference documents the Coach's configurable message length (#280) and the refused empty endpoint (#289), and the published page is rebuilt with the session-only Coach config, the renewed phone token and the refused empty state
Duarte Santos9bd3fe5875dc
diff --git a/api/openapi.yaml b/api/openapi.yamlindex ef62d1ef9..e1e6b5af7 100644--- a/api/openapi.yaml+++ b/api/openapi.yaml@@ -1284,8 +1284,10 @@ paths:$ref: '#/components/schemas/CoachIntake'refine:type: string- maxLength: 1000- description: A change asked for in plain words, applied to the proposal now waiting.+ maxLength: 4000+ description: |+ A change asked for in plain words, applied to the proposal now waiting. Cut to+ the instance's `maxMessageLen` (1000 unless the admin changed it; 200–4000).example: { intake: { goal: muscle, experience: novice, daysPerWeek: 3, equipment: [dumbbell, barbell] } }responses:'202': { $ref: '#/components/responses/CoachJobQueued' }@@ -1313,8 +1315,10 @@ paths:properties:note:type: string- maxLength: 1000- description: Anything the profile wants the Coach to know this time round.+ maxLength: 4000+ description: |+ Anything the profile wants the Coach to know this time round. Cut to the+ instance's `maxMessageLen` (1000 unless the admin changed it; 200–4000).responses:'202': { $ref: '#/components/responses/CoachJobQueued' }'401': { $ref: '#/components/responses/Unauthorized' }@@ -1537,13 +1541,20 @@ paths:description: For the provider being set (or the current one). Empty string clears it.baseUrl:type: string- description: Only for a provider with a configurable endpoint; validated before it is stored.+ description: |+ Only for a provider with a configurable endpoint; validated before it is stored.+ Empty means "back to the default", so it is refused for a provider that has none.community: { type: boolean, description: Offer the cohort comparison on this instance. }caps:type: objectproperties:perProfileDaily: { type: integer, minimum: 0, maximum: 200, description: 0 = no cap. }instanceDaily: { type: integer, minimum: 0, maximum: 5000, description: 0 = no cap. }+ maxMessageLen:+ type: integer+ minimum: 200+ maximum: 4000+ description: How long a chat message, refinement or review note can be. Clamped into the range; not a number keeps the current value.example: { enabled: true, provider: compatible, model: qwen3.8-27b, caps: { perProfileDaily: 10, instanceDaily: 0 } }responses:'200':@@ -1552,7 +1563,10 @@ paths:application/json:schema: { $ref: '#/components/schemas/Ok' }'400':- description: Unknown provider, an endpoint set on a provider that has a fixed one, or a base URL that did not validate.+ description: |+ Unknown provider, an endpoint set on a provider that has a fixed one, a base URL that+ did not validate, or an empty one for a provider with no default endpoint to fall back+ to (`compatible`).content:application/json:schema: { $ref: '#/components/schemas/Error' }@@ -2182,6 +2196,13 @@ components:- $ref: '#/components/schemas/CoachProposal'- type: 'null'cap: { $ref: '#/components/schemas/CoachCap' }+ maxMessageLen:+ type: integer+ minimum: 200+ maximum: 4000+ description: |+ The longest note or refinement this instance keeps, in characters. It rides on the+ poll so a chat that is already open follows an admin's change.last:oneOf:- type: object@@ -2345,6 +2366,7 @@ components:properties:perProfileDaily: { type: integer }instanceDaily: { type: integer }+ maxMessageLen: { type: integer, description: 'How long a chat message, refinement or review note can be (200–4000, default 1000).' }community: { type: boolean }runtime:type: objectdiff --git a/website/api.html b/website/api.htmlindex b00dc1996..eef77f2e2 100644--- a/website/api.html+++ b/website/api.html@@ -313,10 +313,12 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<span class="m get">GET</span><span class="ep-path"><code>/api/config</code><span class="ep-chip public">public</span></span><span class="ep-chev" aria-hidden="true"></span>- <span class="ep-sum">Public instance configuration</span>+ <span class="ep-sum">Instance configuration</span></summary><div class="ep-body"><p>The flags the login screen needs before anyone is signed in. Both reflect environment variables on the server (<code>INVITE_ONLY</code>, <code>ALLOW_GUEST</code>).</p>+<p>A caller with a valid session also gets a <code>coach</code> key: the block when the instance has the AI Coach switched on <b>and</b> a provider connected, and <code>null</code> when it has not. A caller with no session gets no key at all — the block names the provider this instance talks to, which is the same fact <code>GET /api/coach/disclosure</code> will not hand out unauthenticated.</p>+<p>The key is always present for a session, <code>null</code> included, so a client that caches this answer can tell "no Coach on this instance" from "you were not signed in when you asked" and knows whether asking again would change it.</p><p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Public — no authentication required.</span></p>@@ -324,7 +326,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<div class="ptab"><div class="prow rrow"><span class="r-code s2">200</span>- <span class="p-desc">Instance flags.<span class="r-sig">{ invite_only: boolean, allow_guest: boolean }</span></span>+ <span class="p-desc">Instance flags, plus the Coach block for a signed-in caller.<span class="r-sig">{ invite_only: boolean, allow_guest: boolean, coach: object | null }</span></span></div></div></div>@@ -345,7 +347,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<span class="ep-sum">Who am I?</span></summary><div class="ep-body">-<p>Resolves the current session to a user.</p>+<p>Resolves the current session to a user. A paired phone (bearer token) whose token is past half of <code>SESSION_DAYS</code> also receives a fresh <code>token</code> to use from now on; it carries the account's current session version, so "sign out everywhere" revokes it like the old one. Cookie sessions never get one.</p><p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer <token></code> from mobile-app pairing.</span></p>@@ -353,7 +355,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<div class="ptab"><div class="prow rrow"><span class="r-code s2">200</span>- <span class="p-desc">A valid session.<span class="r-sig">{ user: <a href="#schema-SessionUser">SessionUser</a> }</span></span>+ <span class="p-desc">A valid session.<span class="r-sig">{ user: <a href="#schema-SessionUser">SessionUser</a>, token: string }</span></span></div><div class="prow rrow"><span class="r-code s4">401</span>@@ -706,7 +708,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon</div><div class="prow rrow"><span class="r-code s4">400</span>- <span class="p-desc"><code>state</code> missing or not an object, <code>state</code> an array, or <code>workouts</code>/<code>routines</code> set to anything other than an array or null. Entries inside those two arrays that are not objects (<code>null</code>, numbers, nested arrays) are dropped before the write rather than refused, so a client with a damaged copy still syncs.<span class="r-sig"><code>{"error":"state required"}</code> · <code>{"error":"invalid state"}</code></span></span>+ <span class="p-desc"><code>state</code> missing or not an object, <code>state</code> an array or an object with nothing of the profile in it (<code>_rev</code>/<code>_ts</code> do not count — both would empty the profile), or <code>workouts</code>/<code>routines</code> set to anything other than an array or null. Entries inside those two arrays that are not objects (<code>null</code>, numbers, nested arrays) are dropped before the write rather than refused, so a client with a damaged copy still syncs.<span class="r-sig"><code>{"error":"state required"}</code> · <code>{"error":"invalid state"}</code></span></span></div><div class="prow rrow"><span class="r-code s4">401</span>@@ -1144,8 +1146,8 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon</div><div class="prow"><span class="p-name">refine</span>- <span class="p-type">string <span class="p-hint">(≤ 1000 chars)</span></span>- <span class="p-desc">A change asked for in plain words, applied to the proposal now waiting.</span>+ <span class="p-type">string <span class="p-hint">(≤ 4000 chars)</span></span>+ <span class="p-desc">A change asked for in plain words, applied to the proposal now waiting. Cut to the instance's <code>maxMessageLen</code> (1000 unless the admin changed it; 200–4000).</span></div></div><pre><code>{@@ -1203,8 +1205,8 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab"><div class="prow"><span class="p-name">note</span>- <span class="p-type">string <span class="p-hint">(≤ 1000 chars)</span></span>- <span class="p-desc">Anything the profile wants the Coach to know this time round.</span>+ <span class="p-type">string <span class="p-hint">(≤ 4000 chars)</span></span>+ <span class="p-desc">Anything the profile wants the Coach to know this time round. Cut to the instance's <code>maxMessageLen</code> (1000 unless the admin changed it; 200–4000).</span></div></div><p class="ep-h">Responses</p>@@ -1871,7 +1873,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<div class="prow"><span class="p-name">baseUrl</span><span class="p-type">string</span>- <span class="p-desc">Only for a provider with a configurable endpoint; validated before it is stored.</span>+ <span class="p-desc">Only for a provider with a configurable endpoint; validated before it is stored. Empty means "back to the default", so it is refused for a provider that has none.</span></div><div class="prow"><span class="p-name">community</span>@@ -1893,6 +1895,11 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<span class="p-type">integer <span class="p-hint">(0–5000)</span></span><span class="p-desc">0 = no cap.</span></div>+ <div class="prow">+ <span class="p-name">maxMessageLen</span>+ <span class="p-type">integer <span class="p-hint">(200–4000)</span></span>+ <span class="p-desc">How long a chat message, refinement or review note can be. Clamped into the range; not a number keeps the current value.</span>+ </div></div><pre><code>{"enabled": true,@@ -1911,7 +1918,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon</div><div class="prow rrow"><span class="r-code s4">400</span>- <span class="p-desc">Unknown provider, an endpoint set on a provider that has a fixed one, or a base URL that did not validate.<span class="r-sig"><code>{"error":"unknown provider"}</code></span></span>+ <span class="p-desc">Unknown provider, an endpoint set on a provider that has a fixed one, a base URL that did not validate, or an empty one for a provider with no default endpoint to fall back to (<code>compatible</code>).<span class="r-sig"><code>{"error":"unknown provider"}</code></span></span></div><div class="prow rrow"><span class="r-code s4">401</span>@@ -3054,6 +3061,11 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<span class="p-type"><a href="#schema-CoachCap">CoachCap</a></span><span class="p-desc"></span></div>+ <div class="prow">+ <span class="p-name">maxMessageLen</span>+ <span class="p-type">integer <span class="p-hint">(200–4000)</span></span>+ <span class="p-desc">The longest note or refinement this instance keeps, in characters. It rides on the poll so a chat that is already open follows an admin's change.</span>+ </div><div class="prow"><span class="p-name">last</span><span class="p-type">object | null</span>@@ -3496,6 +3508,11 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon<span class="p-type">integer</span><span class="p-desc"></span></div>+ <div class="prow">+ <span class="p-name">maxMessageLen</span>+ <span class="p-type">integer</span>+ <span class="p-desc">How long a chat message, refinement or review note can be (200–4000, default 1000).</span>+ </div><div class="prow"><span class="p-name">community</span><span class="p-type">boolean</span>