Mirrors/mealie
1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-11-01 02:33:22 -04:00
Code Issues Packages Projects Releases Wiki Activity

documentation updates

Browse Source
This commit is contained in:
Hayden
2021-01-08 22:57:59 -09:00
parent 7b6fdc7619
commit 79f957eb8c
12 changed files with 82 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/api/api-examples.md
View File

@@ -1,5 +0,0 @@
# API Examples
TODO
Have Ideas? Submit a PR!

14
docs/docs/api/api-usage.md Normal file
View File

@@ -0,0 +1,14 @@
# Usage
## Key Components
### Recipe Extras
Recipes extras are a key feature of the Mealie API. They allow you to create custom json key/value pairs within a recipe to reference from 3rd part applications. You can use these keys to contain information to trigger automation or custom messages to relay to your desired device.
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.
![api-extras-gif](/gifs/api-extras.gif)
## Examples
Have Ideas? Submit a PR!