Tea journaling on ATProto (alpha) forked from arabica.social/arabica
oolong docs api onboarding.md
1.4 kB · 45 lines
Markdown
at main

Onboarding API #

GET /api/onboarding #

Returns the setup readiness the get-started card renders plus the records that already satisfy each station. Authentication is required.

Response #

{
  "readiness": {
    "has_tea": true,
    "has_vendor": false,
    "has_vessel": false,
    "has_infuser": false
  },
  "teas": [Tea],
  "vendors": [Vendor],
  "vessels": [Vessel],
  "infusers": [Infuser]
}
Field Type Description
readiness object One flag per station: has_tea, has_vendor, has_vessel, has_infuser.
teas Tea[] Existing teas, listed under the tea station.
vendors Vendor[] Existing vendors.
vessels Vessel[] Existing vessels.
infusers Infuser[] Existing infusers.

Arrays are always [] when empty. GET /onboarding returns the same body when the request accepts JSON; it is safe to fetch from the home screen.

Errors #

Status Code When
401 authentication_required No authenticated session, or the session expired.
502 service_unavailable A collection read from the PDS failed; the response is an error rather than "nothing set up yet".
500 internal_error Unexpected local failure.

GET /onboarding fails the same way rather than handing the shell a card that claims no setup progress when the underlying read failed.