From 6255c71609caf52a8e45e365919e7d998ccd56e9 Mon Sep 17 00:00:00 2001 From: Michael Genson <71845777+michael-genson@users.noreply.github.com> Date: Mon, 2 Feb 2026 10:47:23 -0600 Subject: [PATCH] docs: Misc. cleanup (#6988) --- docs/docs/contributors/developers-guide/migration-guide.md | 2 +- docs/docs/documentation/getting-started/api-usage.md | 7 +++++-- docs/docs/overrides/api.html | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/docs/contributors/developers-guide/migration-guide.md b/docs/docs/contributors/developers-guide/migration-guide.md index 278bca04e..87c7bc7dc 100644 --- a/docs/docs/contributors/developers-guide/migration-guide.md +++ b/docs/docs/contributors/developers-guide/migration-guide.md @@ -6,7 +6,7 @@ While this guide aims to simplify the migration process for developers, it's not ## V1 → V2 -The biggest change between V1 and V2 is the introduction of Households. For more information on how households work in relation to groups/users, check out the [Groups and Households](./features.md#groups-and-households) section in the Features guide. +The biggest change between V1 and V2 is the introduction of Households. For more information on how households work in relation to groups/users, check out the [Groups and Households](../../documentation/getting-started/features.md#groups-and-households) section in the Features guide. ### `updateAt` is now `updatedAt` diff --git a/docs/docs/documentation/getting-started/api-usage.md b/docs/docs/documentation/getting-started/api-usage.md index 9323776d1..92a11ee16 100644 --- a/docs/docs/documentation/getting-started/api-usage.md +++ b/docs/docs/documentation/getting-started/api-usage.md @@ -16,7 +16,7 @@ Recipes extras are a key feature of the Mealie API. They allow you to create cus For example you could add `{"message": "Remember to thaw the chicken"}` to a recipe and use the webhooks built into mealie to send that message payload to a destination to be processed. #### Shopping List and Food Extras -Similarly to recipes, extras are supported on shopping lists, shopping list items, and foods. At this time they are only accessible through the API. Extras for these objects allow for rich integrations between the Mealie shopping list and your favorite list manager, such as Alexa, ToDoist, Trello, or any other list manager with an API. +Similarly to recipes, extras are supported on shopping lists, shopping list items, and foods. At this time they are only accessible through the API. Extras for these objects allow for rich integrations between the Mealie shopping list and your favorite list manager, such as Todoist, Trello, or any other list manager with an API. To keep shopping lists in sync, for instance, you can store your Trello list id on your Mealie shopping list:
`{"trello_list_id": "5abbe4b7ddc1b351ef961414"}` @@ -52,6 +52,7 @@ Many applications will keep track of the query and adjust the page parameter app Notice that the route does not contain the baseurl (e.g. `https://mymealieapplication.com/api`). There are a few shorthands available to reduce the number of calls for certain common requests: + - if you want to return _all_ results, effectively disabling pagination, set `perPage = -1` (and fetch the first page) - if you want to fetch the _last_ page, set `page = -1` @@ -96,10 +97,12 @@ You can use placeholders to insert dynamic values as opposed to static values. C `lastMade <= "$NOW-30d"` Supported offsets operations include: + - `-` for subtracting a time (i.e. in the past) - `+` for adding a time (i.e. in the future) Supported offset intervals include: + - `y` for years - `m` for months - `d` for days @@ -116,7 +119,7 @@ When querying tables with relationships, you can filter properties on related ta This timeline event filter will return all timeline events for recipes that were created after a particular date:
`recipe.createdAt >= "2023-02-25"` -This recipe filter will return all recipes that contains a particular set of tags:
+This recipe filter will return all recipes that contain a particular set of tags:
`tags.name CONTAINS ALL ["Easy", "Cajun"]` ##### Compound Filters diff --git a/docs/docs/overrides/api.html b/docs/docs/overrides/api.html index 61db12ccc..14f1fa43a 100644 --- a/docs/docs/overrides/api.html +++ b/docs/docs/overrides/api.html @@ -14,7 +14,7 @@