Changed
-
Notes, birthdays and quick links check every request against the published API description.
This is about your own API clients; the app sends nothing that changes. Under
/api/v1/notes,/api/v1/birthdaysand/api/v1/quick-links, input that used to be
quietly accepted or reinterpreted is now refused with a 400:- a path id that is not plain digits, such as
12abc(it was read as 12); pinnedas"false",5or"x", andpinned: nullon a note update;- a number in a text field, such as
"title": 5(it was stored as text); - an id written as text in
category_idsandcontact_id, and anything but whole numbers
incontact_ids(birthday import) andids(quick link order). Note category reordering
still takes digit strings, because the app sends them; - a list instead of an object as the body;
- a quick link
visibilityother thanall,privateor null (it becameallor was
ignored); - an empty
namewhen updating a birthday or a quick link.
Such a refusal reads
{ "error": "The request does not match the documented schema.", "code": 400, "reason": "validation", "fields": [{ "path": "body/title", "rule": "type" }] }.
fieldsnames the place and the JSON Schema rule, never the value you sent. Input that was
already refused before can now get this form instead of the old sentence. The check runs
before the entry is looked up, so a bad request for a missing or locked entry is now a 400,
not a 404 or 403, and a missing body where one is required is a 400. Text lengths count the
value as sent, before surrounding spaces are trimmed. Unknown fields are still ignored, and
what stays allowed is in the description too: null or""for "no value", the note
visibilitiesfamilyandshared,year_unknown: null, a pin toggle without a body, and
reminder fields as text or number. - a path id that is not plain digits, such as
-
Birthdays answer an unexpected failure with the same sentence as the rest of the API. The
seven routes under/api/v1/birthdays(list, upcoming, create, import candidates, import,
update, delete) said"Internal error."on a server-side failure; they now say
"Internal server error."like every other module. Status 500 andcodeare unchanged. -
Reminders, notification channels, modules, permissions, e-mail and weather check every
request against the published API description. This is about your own API clients; the app
sends nothing that is refused now (a task reminder now goes out with its id as a number).
Under these six prefixes, input that used to be quietly accepted or reinterpreted is now
refused with a 400:- everywhere: a path id that is not plain digits, such as
12abc,5.0,1e2or0x10
(it was read as another number or looked up as 12), and a query value given twice where
one is expected (audience,admin,city,lang,entity_id); /api/v1/reminders:entity_idas1abcor1.9(it was read as 1), an unknown
entity_type,remind_atas a list, and a time the route never read - a lowercaset
orz, a space instead ofT, an offset of hours only (+02). A body that is not an
object or aremind_atsthat is not a list is refused before the entry is looked up;/api/v1/notifications: a provider that is not exactlygotify,ntfy,webhookor
email(" NTFY "was accepted), a number asname,enabledas"false"(it switched
the channel ON),configorsecretsas null, andclearSecretsthat is not a list of
names (a number was a 500). Aprovidersent with an update must be a known one, too;/api/v1/modules:overwriteastrueoryeson a ZIP install (truereplaced,yes
was ignored),overwrite: "1"on a GitHub install, apathover 500 characters as sent,
reforpaththat is not text, and an asset address without a file path (it was a 404);/api/v1/permissions: no body, a list as the body andcapabilities: null(all three
answered 200 and REMOVED the stored rights), a map that is not an object, an access level
other thannone,read,write(modules) ornone,allow(widgets, capabilities),
and a member id such as12abcor1.5;/api/v1/email: a missing body onPUT /config(it was a 200 that saved nothing),port
as text, a truth value, a list or""("587"was stored as text), a number or truth
value ashost,user,fromName,fromAddressorpass,clearPassword: "true", a
securethat is not one of its three values, andto: nullor a number onPOST /test;/api/v1/weather: a place name given twice, and an icon code other than 2 to 4 letters or
digits.
What stays allowed is in the description now too:
entity_idas digit text on
POST /reminders, every time form the reminder routes read (a date alone, no seconds, a
fraction,Z,+02:00or+0200), up to five reminders counted after conversion, a
partial channel update, null to clear an e-mail field, anylangon the weather routes
(de-AT, an unknown code falls back),adminandaudienceas any text. A refusal's
reasoncan now be the route's own documented reason instead ofvalidation, and an entry
infieldscan carry it asreason:bad_url(GitHub URL missing, not text or too long),
email_port_invalid,email_from_invalid(a sender that is neither text nor null) and
name_too_short(a place name that is missing, empty or given twice) keep the reason they
had. The check runs after the admin, session and rate-limit checks, so a member still gets
403, and before the entry is looked up, so a bad request for a missing channel, member or
reminder target is now a 400, not a 404. - everywhere: a path id that is not plain digits, such as
-
Family, profile pictures, search, kitchen, screensaver and wall displays check every request
against the published API description. This is about your own API clients; the app sends
nothing that is refused now. Under these prefixes, input that used to be quietly accepted,
reinterpreted or answered later is now refused with a 400:- everywhere: a path id that is not plain digits, such as
12abc,5.0,1e2or0x10
(5.0and1e2were read as 5 and 100), and a query value given twice where one is
expected (qon/api/v1/searchsearched fora,b,todayon/api/v1/kitchen/summary); /api/v1/family/members/reorder: the order is checked before the members are looked up.
It keeps its reasonsinvalid_orderandduplicate_member, now withfields. A member who
is not an administrator gets 403 for any body, as before;/api/v1/people/{id}/avatar: a missingv, one that is not 32 lowercase hex characters,
or one given twice (it was a 404). A well-formed key that does not match is still a 404;/api/v1/kitchen/summary:todaythat is neitherYYYY-MM-DDnor empty (it fell back
to the household day). An empty or missingtodaystill means the household day;/api/v1/screensaver: no body or a list onPUT /config(it was a 200 that saved
nothing),urloralbumIdthat is not text (they were read throughString(), so a
list with one URL was stored), aurlover 2048 or anapiKeyover 1000 characters as
sent, anapiKeythat is not text (it was ignored),clearApiKey: "true", and a photo id
that is not a UUID - also when Immich is not set up (that was a 404).url,albumIdand
the key length keepimmich_url_invalid,immich_album_id_invalidand
immich_api_key_invalid, and a refused body stores no field at all;/api/v1/displays: adisplay_namethat is a number, a truth value, a list (they were
stored as text) or empty, or longer than 128 characters as sent;show_screensaveras
text; onPOST /displays/paira missingcode, acodeorlabelthat is not text and a
labelover 120 characters (it was cut). A refused pairing counts against the rate limit
like any attempt and leaves a signed-in session in place.
What stays allowed is in the description now too:
qof any length, an emptytoday, a
day of the right shape that does not exist (compared as text, as before),""to clear the
Immich URL and album, a photo id in either letter case,label: nullor"". Rules the
description cannot carry stay with the routes and their sentences: a member order that is
incomplete or names someone outside the household, the Immich URL scheme and album UUID
after trimming, a display name of spaces only, equal night hours. The check runs after the
admin check and the pairing rate limit, so a member still gets 403. - everywhere: a path id that is not plain digits, such as
-
Recipes, recipe providers and the pantry check every request against the published API
description. This is about your own API clients; the app sends nothing that is refused now
(it sends storage location ids as numbers from this release on). Under/api/v1/recipes,
/api/v1/recipe-providersand/api/v1/pantry, input that used to be quietly accepted,
reinterpreted or answered later is now refused with a 400:- everywhere: a path id that is not plain digits, such as
12abc,5.0,1e2or0x10
(DELETE /recipes/42abcdeleted recipe 42, and0x1eor31.0deleted provider account
30 or 31), a query value given twice, a number, truth value, list or object in a text
field (it was stored as text), and a number written as text ("5",trueand[5]were
read as numbers); /api/v1/recipes:ingredientsthat is null, not a list, or holds entries that are not
objects (null emptied the list, odd entries were skipped),servingsoutside 1 to 99 or as
text or"",meal_typesthat is neither a list of texts, a text nor null,listIdand
ingredientIdsof the transfer to a shopping list as text, andpantryItemId: ""on an
ingredient match (it cleared the match;nullor leaving it out still does);/api/v1/recipe-providers(admin only): aproviderother thanmealieortandoor
(an unknown one was stored asmealie; left out it still is),enabledthat is not a
real truth value ("false"switched an account ON,nulland0OFF), and aPATCH
without a body. A base or external address that does not start withhttp://or
https://keeps its reasonrecipe_providers_url_invalidor
recipe_providers_external_url_invalid, now withfields;/api/v1/pantry: aunitoutside the unit list (it becamepcs, and onPATCHit
overwrote the stored unit), a quantity or minimum as text or below zero,min_quantity: ""
(use null to clear),expires_onthat is notYYYY-MM-DD, empty or null, a storage
location id that is neither a whole number nor digit text, aPATCHwithout a body,
itemsorchangesthat is not a list (null or text took over or undid nothing), an
orderof storage locations with entries that are not ids ([{}]and[true]were a
500, other entries were skipped), and undo entries that are not the shape the take-over
answered with.
What stays allowed is in the description now too: null or
""for "no value" where the
routes read it so,meal_typesas comma text, unknown recipe meal types (dropped), an
address in upper case or with leading spaces,""for no external address, digit text for a
storage location id (older app versions send it), null to keep a pantry item's unit or
category on a change,{}on a partial update and on the provider test and sync. APUT
replaces the whole recipe or pantry item, as before: left-out fields are cleared, and only
the name is required. Rules the description cannot carry stay with the routes and their
sentences: an empty name after trimming, a day that does not exist, a category or storage
location that does not exist, the image content, a provider address in a private network.
The admin check of the providers and the second module right of the recipe transfer, the
ingredient match and the shopping-list take-over run first, so a caller without them still
gets 403 for any body; the check then runs before the entry is looked up, so a bad request
for a missing entry is a 400, not a 404 or 409. Text lengths count the value as sent. - everywhere: a path id that is not plain digits, such as
-
Reminders, notification channels, modules and e-mail answer an unexpected failure with the
same sentence as the rest of the API. Their routes said"Internal error."(reminders,
notification channels including a failed channel test, e-mail) or"Module install failed.",
"Module delete failed.","Module install info failed.","Module list failed.",
"Module update failed."and"Module asset failed."(modules) on a server-side failure;
they now say"Internal server error."like every other module. Status 500 andcodeare
unchanged, a failed channel test still stores its error on the channel, and every answer
that names a known cause (a refused input,busy,not_writable, an install refusal with
itsreason) stays as it was. Permissions and weather answered this way already. -
Recipes answer an unexpected failure with the same sentence as the rest of the API. The
recipe routes (list, create, update, delete, own image, transfer to the shopping list,
ingredient match) said"Internal error"on a server-side failure; they now say
"Internal server error."like every other module. Status 500 andcodeare unchanged. The
image proxy of imported recipes keeps its own answers (404,502). Recipe providers and the
pantry answered this way already.
Fixed
- The calendar search no longer loses upcoming events behind old ones. With more than 100
matching events it kept the oldest, so an old series or a year of past events pushed the
upcoming ones out of the result. It now keeps upcoming events and series first, then past
events from the newest - like the global search. The order of the result is unchanged. - Search and the overview show rows that tie in the same order on every load. Lists that
sort by date or title had no unique last sort key, so entries with the same date or the same
title could swap places between two loads, and the global search could drop exactly the newest
of several past events with the same start when it cut its candidates. Ties now follow the
direction of the list: newest first breaks them with the newer entry, all others with the
older; two recipes with the same title stand in the order they were created. - Confirming which pantry row a recipe ingredient means names the ingredient in English.
PUT /api/v1/recipes/{id}/ingredient-matchwith an empty, blank or too longnameanswered
"Zutat is required.","Zutat must not be empty."or"Zutat may be at most 200 characters long."- a German word in an English message. It now says"Ingredient ...". Status and
codeare unchanged. - Taking checked shopping items into the pantry no longer fails with a server error when a
storage location was deleted meanwhile. If one of the chosen locations no longer exists -
for example removed in another session while the dialog was open - the take-over now answers
400Location not found.like adding a pantry item does, and nothing is taken over. Before,
the whole take-over ended as a 500. - The API description marks every value that may be null in the OpenAPI 3.1 way. 36 places - the
fasting and nutrition bodies, the household setup, the waste calendar feed - said so with the
OpenAPI 3.0 keywordnullable, which a 3.1 client generator ignores, so a generated client treated
them as never null. They now carrynullin their type. Four sample values moved fromexampleto
examples, and two "one of these fields" rules are spelled so that a strict JSON Schema validator
accepts them. The API itself did not change.