mirror of
https://github.com/mealie-recipes/mealie.git
synced 2025-12-13 22:05:15 -05:00
25 lines
155 KiB
HTML
25 lines
155 KiB
HTML
<!-- Custom HTML site displayed as the Home chapter -->
|
|
{% extends "main.html" %}
|
|
{% block tabs %}
|
|
{{ super() }}
|
|
|
|
<style>
|
|
body {
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
</style>
|
|
|
|
|
|
<div id="redoc-container"></div>
|
|
<script src="https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js"> </script>
|
|
<script>
|
|
var spec = {"openapi": "3.0.2", "info": {"title": "Mealie", "description": "A place for all your recipes", "version": "v1.0.0b"}, "paths": {"/api/app/about": {"get": {"tags": ["App: About"], "summary": "Get App Info", "description": "Get general application information", "operationId": "get_app_info_api_app_about_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AppInfo"}}}}}}}, "/api/auth/token": {"post": {"tags": ["Users: Authentication"], "summary": "Get Token", "operationId": "get_token_api_auth_token_post", "requestBody": {"content": {"application/x-www-form-urlencoded": {"schema": {"$ref": "#/components/schemas/Body_get_token_api_auth_token_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/auth/refresh": {"get": {"tags": ["Users: Authentication"], "summary": "Refresh Token", "description": "Use a valid token to get another token", "operationId": "refresh_token_api_auth_refresh_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/register": {"post": {"tags": ["Users: Registration"], "summary": "Register New User", "operationId": "register_new_user_api_users_register_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateUserRegistration"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/self": {"get": {"tags": ["Users: CRUD"], "summary": "Get Logged In User", "operationId": "get_logged_in_user_api_users_self_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/{id}": {"get": {"tags": ["Users: CRUD"], "summary": "Get User", "operationId": "get_user_api_users__id__get", "parameters": [{"required": true, "schema": {"title": "Id", "type": "string", "format": "uuid4"}, "name": "id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Users: CRUD"], "summary": "Update User", "operationId": "update_user_api_users__id__put", "parameters": [{"required": true, "schema": {"title": "Id", "type": "string", "format": "uuid4"}, "name": "id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/mealie__schema__user__user__UserBase"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Users: CRUD"], "summary": "Delete User", "description": "Removes a user from the database. Must be the current user or a super user", "operationId": "delete_user_api_users__id__delete", "parameters": [{"required": true, "schema": {"title": "Id", "type": "string", "format": "uuid4"}, "name": "id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users": {"get": {"tags": ["Users: CRUD"], "summary": "Get All Users", "operationId": "get_all_users_api_users_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Users Api Users Get", "type": "array", "items": {"$ref": "#/components/schemas/UserOut"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Users: CRUD"], "summary": "Create User", "operationId": "create_user_api_users_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserIn"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/{id}/reset-password": {"put": {"tags": ["Users: Passwords"], "summary": "Reset User Password", "operationId": "reset_user_password_api_users__id__reset_password_put", "parameters": [{"required": true, "schema": {"title": "Id", "type": "integer"}, "name": "id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/{item_id}/password": {"put": {"tags": ["Users: Passwords"], "summary": "Update Password", "description": "Resets the User Password", "operationId": "update_password_api_users__item_id__password_put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ChangePassword"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/forgot-password": {"post": {"tags": ["Users: Passwords"], "summary": "Forgot Password", "description": "Sends an email with a reset link to the user", "operationId": "forgot_password_api_users_forgot_password_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ForgotPassword"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/users/reset-password": {"post": {"tags": ["Users: Passwords"], "summary": "Reset Password", "description": "Resets the user password", "operationId": "reset_password_api_users_reset_password_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ResetPassword"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/users/{id}/image": {"post": {"tags": ["Users: Images", "Users: Images"], "summary": "Update User Image", "description": "Updates a User Image", "operationId": "update_user_image_api_users__id__image_post", "parameters": [{"required": true, "schema": {"title": "Id", "type": "string", "format": "uuid4"}, "name": "id", "in": "path"}], "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_update_user_image_api_users__id__image_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/api-tokens": {"post": {"tags": ["Users: Tokens"], "summary": "Create Api Token", "description": "Create api_token in the Database", "operationId": "create_api_token_api_users_api_tokens_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/LoingLiveTokenIn"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/api-tokens/{token_id}": {"delete": {"tags": ["Users: Tokens"], "summary": "Delete Api Token", "description": "Delete api_token from the Database", "operationId": "delete_api_token_api_users_api_tokens__token_id__delete", "parameters": [{"required": true, "schema": {"title": "Token Id", "type": "integer"}, "name": "token_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/{id}/favorites": {"get": {"tags": ["Users: Favorites"], "summary": "Get Favorites", "description": "Get user's favorite recipes", "operationId": "get_favorites_api_users__id__favorites_get", "parameters": [{"required": true, "schema": {"title": "Id", "type": "string"}, "name": "id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserFavorites"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/users/{id}/favorites/{slug}": {"post": {"tags": ["Users: Favorites"], "summary": "Add Favorite", "description": "Adds a Recipe to the users favorites", "operationId": "add_favorite_api_users__id__favorites__slug__post", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Users: Favorites"], "summary": "Remove Favorite", "description": "Adds a Recipe to the users favorites", "operationId": "remove_favorite_api_users__id__favorites__slug__delete", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/self": {"get": {"tags": ["Groups: Self Service"], "summary": "Get Logged In User Group", "description": "Returns the Group Data for the Current User", "operationId": "get_logged_in_user_group_api_groups_self_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInDB"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/members": {"get": {"tags": ["Groups: Self Service"], "summary": "Get Group Members", "description": "Returns the Group of user lists", "operationId": "get_group_members_api_groups_members_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Group Members Api Groups Members Get", "type": "array", "items": {"$ref": "#/components/schemas/UserOut"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/permissions": {"put": {"tags": ["Groups: Self Service"], "summary": "Set Member Permissions", "operationId": "set_member_permissions_api_groups_permissions_put", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/SetPermissions"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/mealplans/today": {"get": {"tags": ["Groups: Mealplans"], "summary": "Get Todays Meals", "operationId": "get_todays_meals_api_groups_mealplans_today_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/cookbooks": {"get": {"tags": ["Groups: Cookbooks"], "summary": "Get All", "operationId": "route_api_groups_cookbooks_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Groups Cookbooks Get", "type": "array", "items": {"$ref": "#/components/schemas/ReadCookBook"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Groups: Cookbooks"], "summary": "Update Many", "operationId": "route_api_groups_cookbooks_put", "requestBody": {"content": {"application/json": {"schema": {"title": "Data", "type": "array", "items": {"$ref": "#/components/schemas/UpdateCookBook"}}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Groups Cookbooks Put", "type": "array", "items": {"$ref": "#/components/schemas/ReadCookBook"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Groups: Cookbooks"], "summary": "Create One", "operationId": "route_api_groups_cookbooks_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateCookBook"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadCookBook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/cookbooks/{item_id}": {"get": {"tags": ["Groups: Cookbooks"], "summary": "Get One", "operationId": "route_api_groups_cookbooks__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCookBook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Groups: Cookbooks"], "summary": "Update One", "operationId": "route_api_groups_cookbooks__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateCookBook"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadCookBook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Groups: Cookbooks"], "summary": "Delete One", "operationId": "route_api_groups_cookbooks__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadCookBook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/mealplans": {"get": {"tags": ["Groups: Mealplans"], "summary": "Get All", "operationId": "get_all_api_groups_mealplans_get", "parameters": [{"required": false, "schema": {"title": "Start", "type": "string", "format": "date"}, "name": "start", "in": "query"}, {"required": false, "schema": {"title": "Limit", "type": "string", "format": "date"}, "name": "limit", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Groups: Mealplans"], "summary": "Create One", "operationId": "route_api_groups_mealplans_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreatePlanEntry"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadPlanEntry"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/mealplans/{item_id}": {"get": {"tags": ["Groups: Mealplans"], "summary": "Get One", "operationId": "route_api_groups_mealplans__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadPlanEntry"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Groups: Mealplans"], "summary": "Update One", "operationId": "route_api_groups_mealplans__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdatePlanEntry"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadPlanEntry"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Groups: Mealplans"], "summary": "Delete One", "operationId": "route_api_groups_mealplans__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadPlanEntry"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/categories": {"get": {"tags": ["Groups: Mealplan Categories"], "summary": "Get Mealplan Categories", "operationId": "get_mealplan_categories_api_groups_categories_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Mealplan Categories Api Groups Categories Get", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Groups: Mealplan Categories"], "summary": "Update Mealplan Categories", "operationId": "update_mealplan_categories_api_groups_categories_put", "requestBody": {"content": {"application/json": {"schema": {"title": "New Categories", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Update Mealplan Categories Api Groups Categories Put", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/webhooks": {"get": {"tags": ["Groups: Webhooks"], "summary": "Get All", "operationId": "route_api_groups_webhooks_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Groups Webhooks Get", "type": "array", "items": {"$ref": "#/components/schemas/ReadWebhook"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Groups: Webhooks"], "summary": "Create One", "operationId": "route_api_groups_webhooks_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateWebhook"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadWebhook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/webhooks/{item_id}": {"get": {"tags": ["Groups: Webhooks"], "summary": "Get One", "operationId": "route_api_groups_webhooks__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadWebhook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Groups: Webhooks"], "summary": "Update One", "operationId": "route_api_groups_webhooks__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateWebhook"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadWebhook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Groups: Webhooks"], "summary": "Delete One", "operationId": "route_api_groups_webhooks__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadWebhook"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/invitations": {"get": {"tags": ["Groups: Invitations"], "summary": "Get Invite Tokens", "operationId": "get_invite_tokens_api_groups_invitations_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Invite Tokens Api Groups Invitations Get", "type": "array", "items": {"$ref": "#/components/schemas/ReadInviteToken"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Groups: Invitations"], "summary": "Create Invite Token", "operationId": "create_invite_token_api_groups_invitations_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateInviteToken"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadInviteToken"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/invitations/email": {"post": {"tags": ["Groups: Invitations"], "summary": "Email Invitation", "operationId": "email_invitation_api_groups_invitations_email_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/EmailInvitation"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EmailInitationResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/preferences": {"get": {"tags": ["Group: Preferences"], "summary": "Get Group Preferences", "operationId": "get_group_preferences_api_groups_preferences_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadGroupPreferences"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Group: Preferences"], "summary": "Update Group Preferences", "operationId": "update_group_preferences_api_groups_preferences_put", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UpdateGroupPreferences"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReadGroupPreferences"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/migrations": {"post": {"tags": ["Group: Migrations"], "summary": "Start Data Migration", "operationId": "start_data_migration_api_groups_migrations_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_start_data_migration_api_groups_migrations_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReportSummary"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/reports/{item_id}": {"get": {"tags": ["Groups: Reports"], "summary": "Get One", "operationId": "route_api_groups_reports__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReportOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Groups: Reports"], "summary": "Delete One", "operationId": "route_api_groups_reports__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ReportOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/reports": {"get": {"tags": ["Groups: Reports"], "summary": "Get All Reports", "operationId": "get_all_reports_api_groups_reports_get", "parameters": [{"required": false, "schema": {"$ref": "#/components/schemas/ReportCategory"}, "name": "report_type", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/shopping/lists": {"get": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Get All", "operationId": "get_all_api_groups_shopping_lists_get", "parameters": [{"required": false, "schema": {"title": "Start", "type": "integer", "default": 0}, "name": "start", "in": "query"}, {"required": false, "schema": {"title": "Limit", "type": "integer", "default": 999}, "name": "limit", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Api Groups Shopping Lists Get", "type": "array", "items": {"$ref": "#/components/schemas/ShoppingListSummary"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Create One", "operationId": "create_one_api_groups_shopping_lists_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/shopping/lists/{item_id}": {"get": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Get One", "operationId": "get_one_api_groups_shopping_lists__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Update One", "operationId": "update_one_api_groups_shopping_lists__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListUpdate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Delete One", "operationId": "delete_one_api_groups_shopping_lists__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/shopping/lists/{item_id}/recipe/{recipe_id}": {"post": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Add Recipe Ingredients To List", "operationId": "add_recipe_ingredients_to_list_api_groups_shopping_lists__item_id__recipe__recipe_id__post", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}, {"required": true, "schema": {"title": "Recipe Id", "type": "integer"}, "name": "recipe_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Group: Shopping Lists", "Group: Shopping Lists"], "summary": "Remove Recipe Ingredients From List", "operationId": "remove_recipe_ingredients_from_list_api_groups_shopping_lists__item_id__recipe__recipe_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}, {"required": true, "schema": {"title": "Recipe Id", "type": "integer"}, "name": "recipe_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ShoppingListOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/labels": {"get": {"tags": ["Group: Multi Purpose Labels", "Group: Multi Purpose Labels"], "summary": "Get All", "operationId": "get_all_api_groups_labels_get", "parameters": [{"required": false, "schema": {"title": "Start", "type": "integer", "default": 0}, "name": "start", "in": "query"}, {"required": false, "schema": {"title": "Limit", "type": "integer", "default": 999}, "name": "limit", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Api Groups Labels Get", "type": "array", "items": {"$ref": "#/components/schemas/MultiPurposeLabelSummary"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Group: Multi Purpose Labels", "Group: Multi Purpose Labels"], "summary": "Create One", "operationId": "create_one_api_groups_labels_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/MultiPurposeLabelCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MultiPurposeLabelOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/labels/{item_id}": {"get": {"tags": ["Group: Multi Purpose Labels", "Group: Multi Purpose Labels"], "summary": "Get One", "operationId": "get_one_api_groups_labels__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MultiPurposeLabelOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Group: Multi Purpose Labels", "Group: Multi Purpose Labels"], "summary": "Update One", "operationId": "update_one_api_groups_labels__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/MultiPurposeLabelUpdate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MultiPurposeLabelOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Group: Multi Purpose Labels", "Group: Multi Purpose Labels"], "summary": "Delete One", "operationId": "delete_one_api_groups_labels__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/MultiPurposeLabelOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/events/notifications": {"get": {"tags": ["Group: Event Notifications", "Group: Event Notifications"], "summary": "Get All", "operationId": "get_all_api_groups_events_notifications_get", "parameters": [{"required": false, "schema": {"title": "Start", "type": "integer", "default": 0}, "name": "start", "in": "query"}, {"required": false, "schema": {"title": "Limit", "type": "integer", "default": 999}, "name": "limit", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Api Groups Events Notifications Get", "type": "array", "items": {"$ref": "#/components/schemas/GroupEventNotifierOut"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Group: Event Notifications", "Group: Event Notifications"], "summary": "Create One", "operationId": "create_one_api_groups_events_notifications_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupEventNotifierCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupEventNotifierOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/events/notifications/{item_id}": {"get": {"tags": ["Group: Event Notifications", "Group: Event Notifications"], "summary": "Get One", "operationId": "get_one_api_groups_events_notifications__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupEventNotifierOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Group: Event Notifications", "Group: Event Notifications"], "summary": "Update One", "operationId": "update_one_api_groups_events_notifications__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupEventNotifierUpdate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupEventNotifierOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Group: Event Notifications", "Group: Event Notifications"], "summary": "Delete One", "operationId": "delete_one_api_groups_events_notifications__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/groups/events/notifications/{item_id}/test": {"post": {"tags": ["Group: Event Notifications", "Group: Event Notifications"], "summary": "Test Notification", "operationId": "test_notification_api_groups_events_notifications__item_id__test_post", "parameters": [{"required": true, "schema": {"title": "Item Id", "type": "string", "format": "uuid4"}, "name": "item_id", "in": "path"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/summary/untagged": {"get": {"tags": ["Recipe: Query All"], "summary": "Get Untagged Recipes", "operationId": "get_untagged_recipes_api_recipes_summary_untagged_get", "parameters": [{"required": false, "schema": {"title": "Count", "type": "boolean", "default": false}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Untagged Recipes Api Recipes Summary Untagged Get", "type": "array", "items": {"$ref": "#/components/schemas/RecipeSummary"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/recipes/summary/uncategorized": {"get": {"tags": ["Recipe: Query All"], "summary": "Get Uncategorized Recipes", "operationId": "get_uncategorized_recipes_api_recipes_summary_uncategorized_get", "parameters": [{"required": false, "schema": {"title": "Count", "type": "boolean", "default": false}, "name": "count", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Uncategorized Recipes Api Recipes Summary Uncategorized Get", "type": "array", "items": {"$ref": "#/components/schemas/RecipeSummary"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/recipes/exports": {"get": {"tags": ["Recipe: Exports"], "summary": "Get Recipe Formats And Templates", "operationId": "get_recipe_formats_and_templates_api_recipes_exports_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FormatResponse"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/{slug}/exports": {"get": {"tags": ["Recipe: Exports"], "summary": "Get Recipe As Format", "description": "## Parameters\n`template_name`: The name of the template to use to use in the exports listed. Template type will automatically\nbe set on the backend. Because of this, it's important that your templates have unique names. See available\nnames and formats in the /api/recipes/exports endpoint.", "operationId": "get_recipe_as_format_api_recipes__slug__exports_get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}, {"required": true, "schema": {"title": "Template Name", "type": "string"}, "name": "template_name", "in": "query"}], "responses": {"200": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipe: Exports"], "summary": "Get Recipe Zip Token", "description": "Generates a recipe zip token to be used to download a recipe as a zip file", "operationId": "get_recipe_zip_token_api_recipes__slug__exports_post", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/{slug}/exports/zip": {"get": {"tags": ["Recipe: Exports"], "summary": "Get Recipe As Zip", "description": "Get a Recipe and It's Original Image as a Zip File", "operationId": "get_recipe_as_zip_api_recipes__slug__exports_zip_get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}, {"required": true, "schema": {"title": "Token", "type": "string"}, "name": "token", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/recipes": {"get": {"tags": ["Recipe: CRUD"], "summary": "Get All", "operationId": "get_all_api_recipes_get", "parameters": [{"required": false, "schema": {"title": "Start", "type": "integer", "default": 0}, "name": "start", "in": "query"}, {"required": false, "schema": {"title": "Limit", "type": "integer"}, "name": "limit", "in": "query"}, {"required": false, "schema": {"title": "Load Foods", "type": "boolean", "default": false}, "name": "load_foods", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Api Recipes Get", "type": "array", "items": {"$ref": "#/components/schemas/RecipeSummary"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipe: CRUD"], "summary": "Create From Name", "description": "Takes in a JSON string and loads data into the database as a new entry", "operationId": "create_from_name_api_recipes_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateRecipe"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Create From Name Api Recipes Post", "type": "string"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/create-url": {"post": {"tags": ["Recipe: CRUD"], "summary": "Parse Recipe Url", "description": "Takes in a URL and attempts to scrape data and load it into the database", "operationId": "parse_recipe_url_api_recipes_create_url_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateRecipeByUrl"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Parse Recipe Url Api Recipes Create Url Post", "type": "string"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/create-url/bulk": {"post": {"tags": ["Recipe: CRUD"], "summary": "Parse Recipe Url Bulk", "description": "Takes in a URL and attempts to scrape data and load it into the database", "operationId": "parse_recipe_url_bulk_api_recipes_create_url_bulk_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateRecipeByUrlBulk"}}}, "required": true}, "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/test-scrape-url": {"post": {"tags": ["Recipe: CRUD"], "summary": "Test Parse Recipe Url", "operationId": "test_parse_recipe_url_api_recipes_test_scrape_url_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateRecipeByUrl"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/create-from-zip": {"post": {"tags": ["Recipe: CRUD"], "summary": "Create Recipe From Zip", "description": "Create recipe from archive", "operationId": "create_recipe_from_zip_api_recipes_create_from_zip_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_create_recipe_from_zip_api_recipes_create_from_zip_post"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/{slug}": {"get": {"tags": ["Recipe: CRUD"], "summary": "Get Recipe", "description": "Takes in a recipe slug, returns all data for a recipe", "operationId": "get_recipe_api_recipes__slug__get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Recipe"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Recipe: CRUD"], "summary": "Update Recipe", "description": "Updates a recipe by existing slug and data.", "operationId": "update_recipe_api_recipes__slug__put", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Recipe"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Recipe: CRUD"], "summary": "Delete Recipe", "description": "Deletes a recipe by slug", "operationId": "delete_recipe_api_recipes__slug__delete", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "patch": {"tags": ["Recipe: CRUD"], "summary": "Patch Recipe", "description": "Updates a recipe by existing slug and data.", "operationId": "patch_recipe_api_recipes__slug__patch", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Recipe"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/{slug}/image": {"put": {"tags": ["Recipe: Images and Assets"], "summary": "Update Recipe Image", "description": "Removes an existing image and replaces it with the incoming file.", "operationId": "update_recipe_image_api_recipes__slug__image_put", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_update_recipe_image_api_recipes__slug__image_put"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipe: Images and Assets"], "summary": "Scrape Image Url", "description": "Removes an existing image and replaces it with the incoming file.", "operationId": "scrape_image_url_api_recipes__slug__image_post", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateRecipeByUrl"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/{slug}/assets": {"post": {"tags": ["Recipe: Images and Assets"], "summary": "Upload Recipe Asset", "description": "Upload a file to store as a recipe asset", "operationId": "upload_recipe_asset_api_recipes__slug__assets_post", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_upload_recipe_asset_api_recipes__slug__assets_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeAsset"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/{slug}/comments": {"get": {"tags": ["Recipe: Comments"], "summary": "Get Recipe Comments", "description": "Get all comments for a recipe", "operationId": "get_recipe_comments_api_recipes__slug__comments_get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Recipe Comments Api Recipes Slug Comments Get", "type": "array", "items": {"$ref": "#/components/schemas/RecipeCommentOut"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/bulk-actions/tag": {"post": {"tags": ["Recipe: Bulk Actions"], "summary": "Bulk Tag Recipes", "operationId": "bulk_tag_recipes_api_recipes_bulk_actions_tag_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AssignTags"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BulkActionsResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/bulk-actions/categorize": {"post": {"tags": ["Recipe: Bulk Actions"], "summary": "Bulk Categorize Recipes", "operationId": "bulk_categorize_recipes_api_recipes_bulk_actions_categorize_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AssignCategories"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BulkActionsResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/bulk-actions/delete": {"post": {"tags": ["Recipe: Bulk Actions"], "summary": "Bulk Delete Recipes", "operationId": "bulk_delete_recipes_api_recipes_bulk_actions_delete_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeleteRecipes"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BulkActionsResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/bulk-actions/export": {"get": {"tags": ["Recipe: Bulk Exports"], "summary": "Get Exported Data", "operationId": "get_exported_data_api_recipes_bulk_actions_export_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get Exported Data Api Recipes Bulk Actions Export Get", "type": "array", "items": {"$ref": "#/components/schemas/GroupDataExport"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipe: Bulk Exports"], "summary": "Bulk Export Recipes", "operationId": "bulk_export_recipes_api_recipes_bulk_actions_export_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ExportRecipes"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/bulk-actions/export/download": {"get": {"tags": ["Recipe: Bulk Exports"], "summary": "Get Exported Data Token", "description": "Returns a token to download a file", "operationId": "get_exported_data_token_api_recipes_bulk_actions_export_download_get", "parameters": [{"required": true, "schema": {"title": "Path", "type": "string", "format": "path"}, "name": "path", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/bulk-actions/export/purge": {"delete": {"tags": ["Recipe: Bulk Exports"], "summary": "Purge Export Data", "description": "Remove all exports data, including items on disk without database entry", "operationId": "purge_export_data_api_recipes_bulk_actions_export_purge_delete", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/recipes/shared/{token_id}": {"get": {"tags": ["Recipe: Shared"], "summary": "Get Shared Recipe", "operationId": "get_shared_recipe_api_recipes_shared__token_id__get", "parameters": [{"required": true, "schema": {"title": "Token Id", "type": "string", "format": "uuid4"}, "name": "token_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Recipe"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/shared/recipes": {"get": {"tags": ["Shared: Recipes"], "summary": "Get All Shared", "description": "Get all shared recipes", "operationId": "get_all_shared_api_shared_recipes_get", "parameters": [{"required": false, "schema": {"title": "Recipe Id", "type": "integer"}, "name": "recipe_id", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Shared Api Shared Recipes Get", "type": "array", "items": {"$ref": "#/components/schemas/RecipeShareTokenSummary"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Shared: Recipes"], "summary": "Create One", "operationId": "route_api_shared_recipes_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeShareTokenCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeShareToken"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/shared/recipes/{item_id}": {"get": {"tags": ["Shared: Recipes"], "summary": "Get One", "operationId": "route_api_shared_recipes__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeShareToken"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Shared: Recipes"], "summary": "Delete One", "operationId": "route_api_shared_recipes__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeShareToken"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/comments": {"get": {"tags": ["Recipe: Comments"], "summary": "Get All", "operationId": "route_api_comments_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Comments Get", "type": "array", "items": {"$ref": "#/components/schemas/RecipeCommentOut"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipe: Comments"], "summary": "Create One", "operationId": "route_api_comments_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCommentCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCommentOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/comments/{item_id}": {"get": {"tags": ["Recipe: Comments"], "summary": "Get One", "operationId": "route_api_comments__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCommentOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Recipe: Comments"], "summary": "Update One", "operationId": "route_api_comments__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCommentUpdate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCommentOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Recipe: Comments"], "summary": "Delete One", "operationId": "route_api_comments__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCommentOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/parser/ingredients": {"post": {"tags": ["Recipe: Ingredient Parser"], "summary": "Parse Ingredients", "operationId": "parse_ingredients_api_parser_ingredients_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientsRequest"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Parse Ingredients Api Parser Ingredients Post", "type": "array", "items": {"$ref": "#/components/schemas/ParsedIngredient"}}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/parser/ingredient": {"post": {"tags": ["Recipe: Ingredient Parser"], "summary": "Parse Ingredient", "operationId": "parse_ingredient_api_parser_ingredient_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientRequest"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ParsedIngredient"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/foods": {"get": {"tags": ["Recipes: Foods"], "summary": "Get All", "operationId": "route_api_foods_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Foods Get", "type": "array", "items": {"$ref": "#/components/schemas/IngredientFood"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipes: Foods"], "summary": "Create One", "operationId": "route_api_foods_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateIngredientFood"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientFood"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/foods/{item_id}": {"get": {"tags": ["Recipes: Foods"], "summary": "Get One", "operationId": "route_api_foods__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientFood"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Recipes: Foods"], "summary": "Update One", "operationId": "route_api_foods__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientFood"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientFood"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Recipes: Foods"], "summary": "Delete One", "operationId": "route_api_foods__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientFood"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/units": {"get": {"tags": ["Recipes: Units"], "summary": "Get All", "operationId": "route_api_units_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Units Get", "type": "array", "items": {"$ref": "#/components/schemas/IngredientUnit"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipes: Units"], "summary": "Create One", "operationId": "route_api_units_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateIngredientUnit"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientUnit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/units/{item_id}": {"get": {"tags": ["Recipes: Units"], "summary": "Get One", "operationId": "route_api_units__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientUnit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Recipes: Units"], "summary": "Update One", "operationId": "route_api_units__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientUnit"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientUnit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Recipes: Units"], "summary": "Delete One", "operationId": "route_api_units__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/IngredientUnit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/tools": {"get": {"tags": ["Recipes: Tools"], "summary": "Get All", "operationId": "route_api_tools_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Tools Get", "type": "array", "items": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_tool__RecipeTool"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Recipes: Tools"], "summary": "Create One", "operationId": "route_api_tools_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeToolCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_tool__RecipeTool"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/tools/{item_id}": {"get": {"tags": ["Recipes: Tools"], "summary": "Get One", "operationId": "route_api_tools__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_tool__RecipeTool"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Recipes: Tools"], "summary": "Update One", "operationId": "route_api_tools__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_tool__RecipeTool"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_tool__RecipeTool"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Recipes: Tools"], "summary": "Delete One", "operationId": "route_api_tools__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_tool__RecipeTool"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/tools/slug/{slug}": {"get": {"tags": ["Recipes: Tools"], "summary": "Func", "description": "Returns a recipe by slug.", "operationId": "Func_api_tools_slug__slug__get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/categories": {"get": {"tags": ["Categories: CRUD"], "summary": "Get All Recipe Categories", "description": "Returns a list of available categories in the database", "operationId": "get_all_recipe_categories_api_categories_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}, "post": {"tags": ["Categories: CRUD"], "summary": "Create Recipe Category", "description": "Creates a Category in the database", "operationId": "create_recipe_category_api_categories_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CategoryIn"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/categories/empty": {"get": {"tags": ["Categories: CRUD"], "summary": "Get Empty Categories", "description": "Returns a list of categories that do not contain any recipes", "operationId": "get_empty_categories_api_categories_empty_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/categories/{category}": {"get": {"tags": ["Categories: CRUD"], "summary": "Get All Recipes By Category", "description": "Returns a list of recipes associated with the provided category.", "operationId": "get_all_recipes_by_category_api_categories__category__get", "parameters": [{"required": true, "schema": {"title": "Category", "type": "string"}, "name": "category", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCategoryResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Categories: CRUD"], "summary": "Update Recipe Category", "description": "Updates an existing Tag in the database", "operationId": "update_recipe_category_api_categories__category__put", "parameters": [{"required": true, "schema": {"title": "Category", "type": "string"}, "name": "category", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CategoryIn"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeCategoryResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Categories: CRUD"], "summary": "Delete Recipe Category", "description": "Removes a recipe category from the database. Deleting a\ncategory does not impact a recipe. The category will be removed\nfrom any recipes that contain it", "operationId": "delete_recipe_category_api_categories__category__delete", "parameters": [{"required": true, "schema": {"title": "Category", "type": "string"}, "name": "category", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/tags": {"get": {"tags": ["Tags: CRUD"], "summary": "Get All Recipe Tags", "description": "Returns a list of available tags in the database", "operationId": "get_all_recipe_tags_api_tags_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}, "post": {"tags": ["Tags: CRUD"], "summary": "Create Recipe Tag", "description": "Creates a Tag in the database", "operationId": "create_recipe_tag_api_tags_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TagIn"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/tags/empty": {"get": {"tags": ["Tags: CRUD"], "summary": "Get Empty Tags", "description": "Returns a list of tags that do not contain any recipes", "operationId": "get_empty_tags_api_tags_empty_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/tags/{tag}": {"get": {"tags": ["Tags: CRUD"], "summary": "Get All Recipes By Tag", "description": "Returns a list of recipes associated with the provided tag.", "operationId": "get_all_recipes_by_tag_api_tags__tag__get", "parameters": [{"required": true, "schema": {"title": "Tag", "type": "string"}, "name": "tag", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeTagResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Tags: CRUD"], "summary": "Update Recipe Tag", "description": "Updates an existing Tag in the database", "operationId": "update_recipe_tag_api_tags__tag__put", "parameters": [{"required": true, "schema": {"title": "Tag", "type": "string"}, "name": "tag", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TagIn"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/RecipeTagResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Tags: CRUD"], "summary": "Delete Recipe Tag", "description": "Removes a recipe tag from the database. Deleting a\ntag does not impact a recipe. The tag will be removed\nfrom any recipes that contain it", "operationId": "delete_recipe_tag_api_tags__tag__delete", "parameters": [{"required": true, "schema": {"title": "Tag", "type": "string"}, "name": "tag", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/about": {"get": {"tags": ["Admin: About"], "summary": "Get App Info", "description": "Get general application information", "operationId": "get_app_info_api_admin_about_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AdminAboutInfo"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/about/statistics": {"get": {"tags": ["Admin: About"], "summary": "Get App Statistics", "operationId": "get_app_statistics_api_admin_about_statistics_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AppStatistics"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/about/check": {"get": {"tags": ["Admin: About"], "summary": "Check App Config", "operationId": "check_app_config_api_admin_about_check_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CheckAppConfig"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/logs/{num}": {"get": {"tags": ["Admin: Log"], "summary": "Get Log", "description": "Doc Str", "operationId": "get_log_api_admin_logs__num__get", "parameters": [{"required": true, "schema": {"title": "Num", "type": "integer"}, "name": "num", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/logs": {"get": {"tags": ["Admin: Log"], "summary": "Get Log File", "description": "Returns a token to download a file", "operationId": "get_log_file_api_admin_logs_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/users": {"get": {"tags": ["Admin: Users"], "summary": "Get All", "operationId": "route_api_admin_users_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Admin Users Get", "type": "array", "items": {"$ref": "#/components/schemas/UserOut"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Admin: Users"], "summary": "Create One", "operationId": "route_api_admin_users_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserIn"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/users/{item_id}": {"get": {"tags": ["Admin: Users"], "summary": "Get One", "operationId": "route_api_admin_users__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Admin: Users"], "summary": "Update One", "operationId": "route_api_admin_users__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Admin: Users"], "summary": "Delete One", "operationId": "route_api_admin_users__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/UserOut"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/groups": {"get": {"tags": ["Admin: Groups"], "summary": "Get All", "operationId": "route_api_admin_groups_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Route Api Admin Groups Get", "type": "array", "items": {"$ref": "#/components/schemas/GroupInDB"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Admin: Groups"], "summary": "Create One", "operationId": "route_api_admin_groups_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupBase"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInDB"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/groups/{item_id}": {"get": {"tags": ["Admin: Groups"], "summary": "Get One", "operationId": "route_api_admin_groups__item_id__get", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInDB"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "put": {"tags": ["Admin: Groups"], "summary": "Update One", "operationId": "route_api_admin_groups__item_id__put", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupAdminUpdate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInDB"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Admin: Groups"], "summary": "Delete One", "operationId": "route_api_admin_groups__item_id__delete", "parameters": [{"required": true, "schema": {"title": "Item Id"}, "name": "item_id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/GroupInDB"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/email": {"get": {"tags": ["Admin: Email"], "summary": "Check Email Config", "description": "Get general application information", "operationId": "check_email_config_api_admin_email_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EmailReady"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Admin: Email"], "summary": "Send Test Email", "operationId": "send_test_email_api_admin_email_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/EmailTest"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EmailSuccess"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/admin/server-tasks": {"get": {"tags": ["Admin: Server Tasks"], "summary": "Get All Tasks", "operationId": "get_all_tasks_api_admin_server_tasks_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"title": "Response Get All Tasks Api Admin Server Tasks Get", "type": "array", "items": {"$ref": "#/components/schemas/ServerTask"}}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "post": {"tags": ["Admin: Server Tasks"], "summary": "Create Test Tasks", "operationId": "create_test_tasks_api_admin_server_tasks_post", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ServerTask"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/media/recipes/{slug}/images/{file_name}": {"get": {"tags": ["Recipe: Images and Assets"], "summary": "Get Recipe Img", "description": "Takes in a recipe slug, returns the static image. This route is proxied in the docker image\nand should not hit the API in production", "operationId": "get_recipe_img_api_media_recipes__slug__images__file_name__get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}, {"required": true, "schema": {"$ref": "#/components/schemas/ImageType"}, "name": "file_name", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/media/recipes/{slug}/assets/{file_name}": {"get": {"tags": ["Recipe: Images and Assets"], "summary": "Get Recipe Asset", "description": "Returns a recipe asset", "operationId": "get_recipe_asset_api_media_recipes__slug__assets__file_name__get", "parameters": [{"required": true, "schema": {"title": "Slug", "type": "string"}, "name": "slug", "in": "path"}, {"required": true, "schema": {"title": "File Name", "type": "string"}, "name": "file_name", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/media/users/{user_id}/{file_name}": {"get": {"tags": ["Recipe: Images and Assets"], "summary": "Get User Image", "description": "Takes in a recipe slug, returns the static image. This route is proxied in the docker image\nand should not hit the API in production", "operationId": "get_user_image_api_media_users__user_id___file_name__get", "parameters": [{"required": true, "schema": {"title": "User Id", "type": "string", "format": "uuid4"}, "name": "user_id", "in": "path"}, {"required": true, "schema": {"title": "File Name", "type": "string"}, "name": "file_name", "in": "path"}], "responses": {"200": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/about/events": {"get": {"tags": ["Events: CRUD"], "summary": "Get Events", "description": "Get event from the Database", "operationId": "get_events_api_about_events_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/EventsOut"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}, "delete": {"tags": ["Events: CRUD"], "summary": "Delete Events", "description": "Get event from the Database", "operationId": "delete_events_api_about_events_delete", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/about/events/{id}": {"delete": {"tags": ["Events: CRUD"], "summary": "Delete Event", "description": "Delete event from the Database", "operationId": "delete_event_api_about_events__id__delete", "parameters": [{"required": true, "schema": {"title": "Id", "type": "integer"}, "name": "id", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/site-settings": {"get": {"tags": ["Settings"], "summary": "Get Main Settings", "description": "Returns basic site settings", "operationId": "get_main_settings_api_site_settings_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/site-settings/webhooks/test": {"post": {"tags": ["Settings"], "summary": "Test Webhooks", "description": "Run the function to test your webhooks", "operationId": "test_webhooks_api_site_settings_webhooks_test_post", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/backups/available": {"get": {"tags": ["Backups"], "summary": "Available Imports", "description": "Returns a list of avaiable .zip files for import into Mealie.", "operationId": "available_imports_api_backups_available_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/AllBackups"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/backups/export/database": {"post": {"tags": ["Backups"], "summary": "Export Database", "description": "Generates a backup of the recipe database in json format.", "operationId": "export_database_api_backups_export_database_post", "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CreateBackup"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/backups/upload": {"post": {"tags": ["Backups"], "summary": "Upload Backup File", "description": "Upload a .zip File to later be imported into Mealie", "operationId": "upload_backup_file_api_backups_upload_post", "requestBody": {"content": {"multipart/form-data": {"schema": {"$ref": "#/components/schemas/Body_upload_backup_file_api_backups_upload_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/backups/{file_name}/download": {"get": {"tags": ["Backups"], "summary": "Download Backup File", "description": "Returns a token to download a file", "operationId": "download_backup_file_api_backups__file_name__download_get", "parameters": [{"required": true, "schema": {"title": "File Name", "type": "string"}, "name": "file_name", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/backups/{file_name}/import": {"post": {"tags": ["Backups"], "summary": "Import Database", "description": "Import a database backup file generated from Mealie.", "operationId": "import_database_api_backups__file_name__import_post", "parameters": [{"required": true, "schema": {"title": "File Name", "type": "string"}, "name": "file_name", "in": "path"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ImportJob"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/backups/{file_name}/delete": {"delete": {"tags": ["Backups"], "summary": "Delete Backup", "description": "Removes a database backup from the file system", "operationId": "delete_backup_api_backups__file_name__delete_delete", "parameters": [{"required": true, "schema": {"title": "File Name", "type": "string"}, "name": "file_name", "in": "path"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "security": [{"OAuth2PasswordBearer": []}]}}, "/api/utils/download": {"get": {"tags": ["Utils"], "summary": "Download File", "description": "Uses a file token obtained by an active user to retrieve a file from the operating\nsystem.", "operationId": "download_file_api_utils_download_get", "parameters": [{"required": false, "schema": {"title": "Token", "type": "string"}, "name": "token", "in": "query"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}}, "components": {"schemas": {"AdminAboutInfo": {"title": "AdminAboutInfo", "required": ["production", "version", "demoStatus", "versionLatest", "apiPort", "apiDocs", "dbType", "dbUrl", "defaultGroup"], "type": "object", "properties": {"production": {"title": "Production", "type": "boolean"}, "version": {"title": "Version", "type": "string"}, "demoStatus": {"title": "Demostatus", "type": "boolean"}, "versionLatest": {"title": "Versionlatest", "type": "string"}, "apiPort": {"title": "Apiport", "type": "integer"}, "apiDocs": {"title": "Apidocs", "type": "boolean"}, "dbType": {"title": "Dbtype", "type": "string"}, "dbUrl": {"title": "Dburl", "type": "string", "format": "path"}, "defaultGroup": {"title": "Defaultgroup", "type": "string"}}}, "AllBackups": {"title": "AllBackups", "required": ["imports", "templates"], "type": "object", "properties": {"imports": {"title": "Imports", "type": "array", "items": {"$ref": "#/components/schemas/BackupFile"}}, "templates": {"title": "Templates", "type": "array", "items": {"type": "string"}}}, "example": {"imports": [{"name": "AutoBackup_12-1-2020.zip", "date": "2022-01-10T09:50:58.793321"}], "templates": ["recipes.md", "custom_template.md"]}}, "AppInfo": {"title": "AppInfo", "required": ["production", "version", "demoStatus"], "type": "object", "properties": {"production": {"title": "Production", "type": "boolean"}, "version": {"title": "Version", "type": "string"}, "demoStatus": {"title": "Demostatus", "type": "boolean"}}}, "AppStatistics": {"title": "AppStatistics", "required": ["totalRecipes", "totalUsers", "totalGroups", "uncategorizedRecipes", "untaggedRecipes"], "type": "object", "properties": {"totalRecipes": {"title": "Totalrecipes", "type": "integer"}, "totalUsers": {"title": "Totalusers", "type": "integer"}, "totalGroups": {"title": "Totalgroups", "type": "integer"}, "uncategorizedRecipes": {"title": "Uncategorizedrecipes", "type": "integer"}, "untaggedRecipes": {"title": "Untaggedrecipes", "type": "integer"}}}, "AssignCategories": {"title": "AssignCategories", "required": ["recipes", "categories"], "type": "object", "properties": {"recipes": {"title": "Recipes", "type": "array", "items": {"type": "string"}}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}}}}, "AssignTags": {"title": "AssignTags", "required": ["recipes", "tags"], "type": "object", "properties": {"recipes": {"title": "Recipes", "type": "array", "items": {"type": "string"}}, "tags": {"title": "Tags", "type": "array", "items": {"$ref": "#/components/schemas/TagBase"}}}}, "BackupFile": {"title": "BackupFile", "required": ["name", "date", "size"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "date": {"title": "Date", "type": "string", "format": "date-time"}, "size": {"title": "Size", "type": "string"}}}, "BackupOptions": {"title": "BackupOptions", "type": "object", "properties": {"recipes": {"title": "Recipes", "type": "boolean", "default": true}, "settings": {"title": "Settings", "type": "boolean", "default": true}, "themes": {"title": "Themes", "type": "boolean", "default": true}, "groups": {"title": "Groups", "type": "boolean", "default": true}, "users": {"title": "Users", "type": "boolean", "default": true}, "notifications": {"title": "Notifications", "type": "boolean", "default": true}}, "example": {"recipes": true, "settings": true, "themes": true, "groups": true, "users": true}}, "Body_create_recipe_from_zip_api_recipes_create_from_zip_post": {"title": "Body_create_recipe_from_zip_api_recipes_create_from_zip_post", "required": ["archive"], "type": "object", "properties": {"archive": {"title": "Archive", "type": "string", "format": "binary"}}}, "Body_get_token_api_auth_token_post": {"title": "Body_get_token_api_auth_token_post", "required": ["username", "password"], "type": "object", "properties": {"grant_type": {"title": "Grant Type", "pattern": "password", "type": "string"}, "username": {"title": "Username", "type": "string"}, "password": {"title": "Password", "type": "string"}, "remember_me": {"title": "Remember Me", "type": "boolean", "default": false}, "scope": {"title": "Scope", "type": "string", "default": ""}, "client_id": {"title": "Client Id", "type": "string"}, "client_secret": {"title": "Client Secret", "type": "string"}}}, "Body_start_data_migration_api_groups_migrations_post": {"title": "Body_start_data_migration_api_groups_migrations_post", "required": ["migration_type", "archive"], "type": "object", "properties": {"add_migration_tag": {"title": "Add Migration Tag", "type": "boolean", "default": false}, "migration_type": {"$ref": "#/components/schemas/SupportedMigrations"}, "archive": {"title": "Archive", "type": "string", "format": "binary"}}}, "Body_update_recipe_image_api_recipes__slug__image_put": {"title": "Body_update_recipe_image_api_recipes__slug__image_put", "required": ["image", "extension"], "type": "object", "properties": {"image": {"title": "Image", "type": "string", "format": "binary"}, "extension": {"title": "Extension", "type": "string"}}}, "Body_update_user_image_api_users__id__image_post": {"title": "Body_update_user_image_api_users__id__image_post", "required": ["profile"], "type": "object", "properties": {"profile": {"title": "Profile", "type": "string", "format": "binary"}}}, "Body_upload_backup_file_api_backups_upload_post": {"title": "Body_upload_backup_file_api_backups_upload_post", "required": ["archive"], "type": "object", "properties": {"archive": {"title": "Archive", "type": "string", "format": "binary"}}}, "Body_upload_recipe_asset_api_recipes__slug__assets_post": {"title": "Body_upload_recipe_asset_api_recipes__slug__assets_post", "required": ["name", "icon", "extension", "file"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "icon": {"title": "Icon", "type": "string"}, "extension": {"title": "Extension", "type": "string"}, "file": {"title": "File", "type": "string", "format": "binary"}}}, "BulkActionError": {"title": "BulkActionError", "required": ["recipe", "error"], "type": "object", "properties": {"recipe": {"title": "Recipe", "type": "string"}, "error": {"title": "Error", "type": "string"}}}, "BulkActionsResponse": {"title": "BulkActionsResponse", "required": ["success", "message"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}, "message": {"title": "Message", "type": "string"}, "errors": {"title": "Errors", "type": "array", "items": {"$ref": "#/components/schemas/BulkActionError"}, "default": []}}}, "CategoryBase": {"title": "CategoryBase", "required": ["name", "id", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "integer"}, "slug": {"title": "Slug", "type": "string"}}}, "CategoryIn": {"title": "CategoryIn", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}}, "ChangePassword": {"title": "ChangePassword", "required": ["currentPassword", "newPassword"], "type": "object", "properties": {"currentPassword": {"title": "Currentpassword", "type": "string"}, "newPassword": {"title": "Newpassword", "type": "string"}}}, "CheckAppConfig": {"title": "CheckAppConfig", "type": "object", "properties": {"emailReady": {"title": "Emailready", "type": "boolean", "default": false}, "ldapReady": {"title": "Ldapready", "type": "boolean", "default": false}, "baseUrlSet": {"title": "Baseurlset", "type": "boolean", "default": false}}}, "CreateBackup": {"title": "CreateBackup", "required": ["options"], "type": "object", "properties": {"tag": {"title": "Tag", "type": "string"}, "options": {"$ref": "#/components/schemas/BackupOptions"}, "templates": {"title": "Templates", "type": "array", "items": {"type": "string"}}}, "example": {"tag": "July 23rd 2021", "options": {"recipes": true, "settings": true, "themes": true, "groups": true, "users": true, "notifications": true}, "template": ["recipes.md"]}}, "CreateCookBook": {"title": "CreateCookBook", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "slug": {"title": "Slug", "type": "string"}, "position": {"title": "Position", "type": "integer", "default": 1}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}, "default": []}}}, "CreateIngredientFood": {"title": "CreateIngredientFood", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}}}, "CreateIngredientUnit": {"title": "CreateIngredientUnit", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "fraction": {"title": "Fraction", "type": "boolean", "default": true}, "abbreviation": {"title": "Abbreviation", "type": "string", "default": ""}}}, "CreateInviteToken": {"title": "CreateInviteToken", "required": ["uses"], "type": "object", "properties": {"uses": {"title": "Uses", "type": "integer"}}}, "CreatePlanEntry": {"title": "CreatePlanEntry", "required": ["date"], "type": "object", "properties": {"date": {"title": "Date", "type": "string", "format": "date"}, "entryType": {"allOf": [{"$ref": "#/components/schemas/PlanEntryType"}], "default": "breakfast"}, "title": {"title": "Title", "type": "string", "default": ""}, "text": {"title": "Text", "type": "string", "default": ""}, "recipeId": {"title": "Recipeid", "type": "integer"}}}, "CreateRecipe": {"title": "CreateRecipe", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}}, "CreateRecipeBulk": {"title": "CreateRecipeBulk", "required": ["url"], "type": "object", "properties": {"url": {"title": "Url", "type": "string"}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/RecipeCategory"}}, "tags": {"title": "Tags", "type": "array", "items": {"$ref": "#/components/schemas/RecipeTag"}}}}, "CreateRecipeByUrl": {"title": "CreateRecipeByUrl", "required": ["url"], "type": "object", "properties": {"url": {"title": "Url", "type": "string"}}, "example": {"url": "https://myfavoriterecipes.com/recipes"}}, "CreateRecipeByUrlBulk": {"title": "CreateRecipeByUrlBulk", "required": ["imports"], "type": "object", "properties": {"imports": {"title": "Imports", "type": "array", "items": {"$ref": "#/components/schemas/CreateRecipeBulk"}}}}, "CreateUserRegistration": {"title": "CreateUserRegistration", "required": ["email", "username", "password", "passwordConfirm"], "type": "object", "properties": {"group": {"title": "Group", "type": "string"}, "groupToken": {"title": "Grouptoken", "type": "string"}, "email": {"title": "Email", "type": "string"}, "username": {"title": "Username", "type": "string"}, "password": {"title": "Password", "type": "string"}, "passwordConfirm": {"title": "Passwordconfirm", "type": "string"}, "advanced": {"title": "Advanced", "type": "boolean", "default": false}, "private": {"title": "Private", "type": "boolean", "default": false}}}, "CreateWebhook": {"title": "CreateWebhook", "type": "object", "properties": {"enabled": {"title": "Enabled", "type": "boolean", "default": true}, "name": {"title": "Name", "type": "string", "default": ""}, "url": {"title": "Url", "type": "string", "default": ""}, "time": {"title": "Time", "type": "string", "default": "00:00"}}}, "DeleteRecipes": {"title": "DeleteRecipes", "required": ["recipes"], "type": "object", "properties": {"recipes": {"title": "Recipes", "type": "array", "items": {"type": "string"}}}}, "EmailInitationResponse": {"title": "EmailInitationResponse", "required": ["success"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}, "error": {"title": "Error", "type": "string"}}}, "EmailInvitation": {"title": "EmailInvitation", "required": ["email", "token"], "type": "object", "properties": {"email": {"title": "Email", "type": "string"}, "token": {"title": "Token", "type": "string"}}}, "EmailReady": {"title": "EmailReady", "required": ["ready"], "type": "object", "properties": {"ready": {"title": "Ready", "type": "boolean"}}}, "EmailSuccess": {"title": "EmailSuccess", "required": ["success"], "type": "object", "properties": {"success": {"title": "Success", "type": "boolean"}, "error": {"title": "Error", "type": "string"}}}, "EmailTest": {"title": "EmailTest", "required": ["email"], "type": "object", "properties": {"email": {"title": "Email", "type": "string"}}}, "Event": {"title": "Event", "required": ["title", "text"], "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "title": {"title": "Title", "type": "string"}, "text": {"title": "Text", "type": "string"}, "timeStamp": {"title": "Timestamp", "type": "string", "format": "date-time"}, "category": {"allOf": [{"$ref": "#/components/schemas/EventCategory"}], "default": "general"}}}, "EventCategory": {"title": "EventCategory", "enum": ["general", "recipe", "backup", "scheduled", "migration", "group", "user"], "type": "string", "description": "An enumeration."}, "EventsOut": {"title": "EventsOut", "required": ["total", "events"], "type": "object", "properties": {"total": {"title": "Total", "type": "integer"}, "events": {"title": "Events", "type": "array", "items": {"$ref": "#/components/schemas/Event"}}}}, "ExportRecipes": {"title": "ExportRecipes", "required": ["recipes"], "type": "object", "properties": {"recipes": {"title": "Recipes", "type": "array", "items": {"type": "string"}}, "exportType": {"allOf": [{"$ref": "#/components/schemas/ExportTypes"}], "default": "json"}}}, "ExportTypes": {"title": "ExportTypes", "enum": ["json"], "type": "string", "description": "An enumeration."}, "ForgotPassword": {"title": "ForgotPassword", "required": ["email"], "type": "object", "properties": {"email": {"title": "Email", "type": "string"}}}, "FormatResponse": {"title": "FormatResponse", "required": ["json", "zip", "jinja2"], "type": "object", "properties": {"json": {"title": "Json", "type": "array", "items": {"type": "string"}}, "zip": {"title": "Zip", "type": "array", "items": {"type": "string"}}, "jinja2": {"title": "Jinja2", "type": "array", "items": {"type": "string"}}}}, "GroupAdminUpdate": {"title": "GroupAdminUpdate", "required": ["id", "name", "preferences"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "preferences": {"$ref": "#/components/schemas/UpdateGroupPreferences"}}}, "GroupBase": {"title": "GroupBase", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}}, "GroupDataExport": {"title": "GroupDataExport", "required": ["id", "groupId", "name", "filename", "path", "size", "expires"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid4"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "filename": {"title": "Filename", "type": "string"}, "path": {"title": "Path", "type": "string"}, "size": {"title": "Size", "type": "string"}, "expires": {"title": "Expires", "type": "string", "format": "date-time"}}}, "GroupEventNotifierCreate": {"title": "GroupEventNotifierCreate", "required": ["name", "appriseUrl"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "appriseUrl": {"title": "Appriseurl", "type": "string"}}}, "GroupEventNotifierOptions": {"title": "GroupEventNotifierOptions", "type": "object", "properties": {"recipeCreated": {"title": "Recipecreated", "type": "boolean", "default": false}, "recipeUpdated": {"title": "Recipeupdated", "type": "boolean", "default": false}, "recipeDeleted": {"title": "Recipedeleted", "type": "boolean", "default": false}, "userSignup": {"title": "Usersignup", "type": "boolean", "default": false}, "dataMigrations": {"title": "Datamigrations", "type": "boolean", "default": false}, "dataExport": {"title": "Dataexport", "type": "boolean", "default": false}, "dataImport": {"title": "Dataimport", "type": "boolean", "default": false}, "mealplanEntryCreated": {"title": "Mealplanentrycreated", "type": "boolean", "default": false}, "shoppingListCreated": {"title": "Shoppinglistcreated", "type": "boolean", "default": false}, "shoppingListUpdated": {"title": "Shoppinglistupdated", "type": "boolean", "default": false}, "shoppingListDeleted": {"title": "Shoppinglistdeleted", "type": "boolean", "default": false}, "cookbookCreated": {"title": "Cookbookcreated", "type": "boolean", "default": false}, "cookbookUpdated": {"title": "Cookbookupdated", "type": "boolean", "default": false}, "cookbookDeleted": {"title": "Cookbookdeleted", "type": "boolean", "default": false}, "tagCreated": {"title": "Tagcreated", "type": "boolean", "default": false}, "tagUpdated": {"title": "Tagupdated", "type": "boolean", "default": false}, "tagDeleted": {"title": "Tagdeleted", "type": "boolean", "default": false}, "categoryCreated": {"title": "Categorycreated", "type": "boolean", "default": false}, "categoryUpdated": {"title": "Categoryupdated", "type": "boolean", "default": false}, "categoryDeleted": {"title": "Categorydeleted", "type": "boolean", "default": false}}, "description": "These events are in-sync with the EventTypes found in the EventBusService.\nIf you modify this, make sure to update the EventBusService as well."}, "GroupEventNotifierOptionsOut": {"title": "GroupEventNotifierOptionsOut", "required": ["id"], "type": "object", "properties": {"recipeCreated": {"title": "Recipecreated", "type": "boolean", "default": false}, "recipeUpdated": {"title": "Recipeupdated", "type": "boolean", "default": false}, "recipeDeleted": {"title": "Recipedeleted", "type": "boolean", "default": false}, "userSignup": {"title": "Usersignup", "type": "boolean", "default": false}, "dataMigrations": {"title": "Datamigrations", "type": "boolean", "default": false}, "dataExport": {"title": "Dataexport", "type": "boolean", "default": false}, "dataImport": {"title": "Dataimport", "type": "boolean", "default": false}, "mealplanEntryCreated": {"title": "Mealplanentrycreated", "type": "boolean", "default": false}, "shoppingListCreated": {"title": "Shoppinglistcreated", "type": "boolean", "default": false}, "shoppingListUpdated": {"title": "Shoppinglistupdated", "type": "boolean", "default": false}, "shoppingListDeleted": {"title": "Shoppinglistdeleted", "type": "boolean", "default": false}, "cookbookCreated": {"title": "Cookbookcreated", "type": "boolean", "default": false}, "cookbookUpdated": {"title": "Cookbookupdated", "type": "boolean", "default": false}, "cookbookDeleted": {"title": "Cookbookdeleted", "type": "boolean", "default": false}, "tagCreated": {"title": "Tagcreated", "type": "boolean", "default": false}, "tagUpdated": {"title": "Tagupdated", "type": "boolean", "default": false}, "tagDeleted": {"title": "Tagdeleted", "type": "boolean", "default": false}, "categoryCreated": {"title": "Categorycreated", "type": "boolean", "default": false}, "categoryUpdated": {"title": "Categoryupdated", "type": "boolean", "default": false}, "categoryDeleted": {"title": "Categorydeleted", "type": "boolean", "default": false}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}, "description": "These events are in-sync with the EventTypes found in the EventBusService.\nIf you modify this, make sure to update the EventBusService as well."}, "GroupEventNotifierOut": {"title": "GroupEventNotifierOut", "required": ["id", "name", "enabled", "groupId", "options"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "enabled": {"title": "Enabled", "type": "boolean"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "options": {"$ref": "#/components/schemas/GroupEventNotifierOptionsOut"}}}, "GroupEventNotifierUpdate": {"title": "GroupEventNotifierUpdate", "required": ["name", "groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "appriseUrl": {"title": "Appriseurl", "type": "string"}, "enabled": {"title": "Enabled", "type": "boolean", "default": true}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "options": {"title": "Options", "allOf": [{"$ref": "#/components/schemas/GroupEventNotifierOptions"}], "default": {"recipe_created": false, "recipe_updated": false, "recipe_deleted": false, "user_signup": false, "data_migrations": false, "data_export": false, "data_import": false, "mealplan_entry_created": false, "shopping_list_created": false, "shopping_list_updated": false, "shopping_list_deleted": false, "cookbook_created": false, "cookbook_updated": false, "cookbook_deleted": false, "tag_created": false, "tag_updated": false, "tag_deleted": false, "category_created": false, "category_updated": false, "category_deleted": false}}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}}, "GroupInDB": {"title": "GroupInDB", "required": ["name", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}, "default": []}, "webhooks": {"title": "Webhooks", "type": "array", "items": {}, "default": []}, "users": {"title": "Users", "type": "array", "items": {"$ref": "#/components/schemas/UserOut"}}, "preferences": {"$ref": "#/components/schemas/ReadGroupPreferences"}}}, "HTTPValidationError": {"title": "HTTPValidationError", "type": "object", "properties": {"detail": {"title": "Detail", "type": "array", "items": {"$ref": "#/components/schemas/ValidationError"}}}}, "ImageType": {"title": "ImageType", "enum": ["original.webp", "min-original.webp", "tiny-original.webp"], "type": "string", "description": "An enumeration."}, "ImportJob": {"title": "ImportJob", "required": ["name"], "type": "object", "properties": {"recipes": {"title": "Recipes", "type": "boolean", "default": true}, "settings": {"title": "Settings", "type": "boolean", "default": true}, "themes": {"title": "Themes", "type": "boolean", "default": true}, "groups": {"title": "Groups", "type": "boolean", "default": true}, "users": {"title": "Users", "type": "boolean", "default": true}, "notifications": {"title": "Notifications", "type": "boolean", "default": true}, "name": {"title": "Name", "type": "string"}, "force": {"title": "Force", "type": "boolean", "default": false}, "rebase": {"title": "Rebase", "type": "boolean", "default": false}}, "example": {"name": "my_local_backup.zip", "recipes": true, "settings": true, "themes": true, "groups": true, "users": true}}, "IngredientConfidence": {"title": "IngredientConfidence", "type": "object", "properties": {"average": {"title": "Average", "type": "number"}, "comment": {"title": "Comment", "type": "number"}, "name": {"title": "Name", "type": "number"}, "unit": {"title": "Unit", "type": "number"}, "quantity": {"title": "Quantity", "type": "number"}, "food": {"title": "Food", "type": "number"}}}, "IngredientFood": {"title": "IngredientFood", "required": ["name", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "id": {"title": "Id", "type": "integer"}}}, "IngredientReferences": {"title": "IngredientReferences", "type": "object", "properties": {"referenceId": {"title": "Referenceid", "type": "string", "format": "uuid"}}, "description": "A list of ingredient references."}, "IngredientRequest": {"title": "IngredientRequest", "required": ["ingredient"], "type": "object", "properties": {"parser": {"allOf": [{"$ref": "#/components/schemas/RegisteredParser"}], "default": "nlp"}, "ingredient": {"title": "Ingredient", "type": "string"}}}, "IngredientUnit": {"title": "IngredientUnit", "required": ["name", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "fraction": {"title": "Fraction", "type": "boolean", "default": true}, "abbreviation": {"title": "Abbreviation", "type": "string", "default": ""}, "id": {"title": "Id", "type": "integer"}}}, "IngredientsRequest": {"title": "IngredientsRequest", "required": ["ingredients"], "type": "object", "properties": {"parser": {"allOf": [{"$ref": "#/components/schemas/RegisteredParser"}], "default": "nlp"}, "ingredients": {"title": "Ingredients", "type": "array", "items": {"type": "string"}}}}, "LoingLiveTokenIn": {"title": "LoingLiveTokenIn", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}}, "LongLiveTokenOut": {"title": "LongLiveTokenOut", "required": ["name", "id", "createdAt"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "integer"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}}}, "MultiPurposeLabelCreate": {"title": "MultiPurposeLabelCreate", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}}, "MultiPurposeLabelOut": {"title": "MultiPurposeLabelOut", "required": ["name", "groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "shoppingListItems": {"title": "Shoppinglistitems", "type": "array", "items": {"$ref": "#/components/schemas/ShoppingListItemOut"}, "default": []}, "foods": {"title": "Foods", "type": "array", "items": {"$ref": "#/components/schemas/IngredientFood"}, "default": []}}}, "MultiPurposeLabelSummary": {"title": "MultiPurposeLabelSummary", "required": ["name", "groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}}, "MultiPurposeLabelUpdate": {"title": "MultiPurposeLabelUpdate", "required": ["name", "groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}}, "Nutrition": {"title": "Nutrition", "type": "object", "properties": {"calories": {"title": "Calories", "type": "string"}, "fatContent": {"title": "Fatcontent", "type": "string"}, "proteinContent": {"title": "Proteincontent", "type": "string"}, "carbohydrateContent": {"title": "Carbohydratecontent", "type": "string"}, "fiberContent": {"title": "Fibercontent", "type": "string"}, "sodiumContent": {"title": "Sodiumcontent", "type": "string"}, "sugarContent": {"title": "Sugarcontent", "type": "string"}}}, "ParsedIngredient": {"title": "ParsedIngredient", "required": ["ingredient"], "type": "object", "properties": {"input": {"title": "Input", "type": "string"}, "confidence": {"title": "Confidence", "allOf": [{"$ref": "#/components/schemas/IngredientConfidence"}], "default": {}}, "ingredient": {"$ref": "#/components/schemas/RecipeIngredient"}}}, "PlanEntryType": {"title": "PlanEntryType", "enum": ["breakfast", "lunch", "dinner", "snack"], "type": "string", "description": "An enumeration."}, "ReadCookBook": {"title": "ReadCookBook", "required": ["name", "id", "groupId"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "slug": {"title": "Slug", "type": "string"}, "position": {"title": "Position", "type": "integer", "default": 1}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}, "default": []}, "id": {"title": "Id", "type": "integer"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}}}, "ReadGroupPreferences": {"title": "ReadGroupPreferences", "required": ["groupId", "id"], "type": "object", "properties": {"privateGroup": {"title": "Privategroup", "type": "boolean", "default": false}, "firstDayOfWeek": {"title": "Firstdayofweek", "type": "integer", "default": 0}, "recipePublic": {"title": "Recipepublic", "type": "boolean", "default": true}, "recipeShowNutrition": {"title": "Recipeshownutrition", "type": "boolean", "default": false}, "recipeShowAssets": {"title": "Recipeshowassets", "type": "boolean", "default": false}, "recipeLandscapeView": {"title": "Recipelandscapeview", "type": "boolean", "default": false}, "recipeDisableComments": {"title": "Recipedisablecomments", "type": "boolean", "default": false}, "recipeDisableAmount": {"title": "Recipedisableamount", "type": "boolean", "default": false}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}, "id": {"title": "Id", "type": "integer"}}}, "ReadInviteToken": {"title": "ReadInviteToken", "required": ["token", "usesLeft", "groupId"], "type": "object", "properties": {"token": {"title": "Token", "type": "string"}, "usesLeft": {"title": "Usesleft", "type": "integer"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}}}, "ReadPlanEntry": {"title": "ReadPlanEntry", "required": ["date", "id", "groupId"], "type": "object", "properties": {"date": {"title": "Date", "type": "string", "format": "date"}, "entryType": {"allOf": [{"$ref": "#/components/schemas/PlanEntryType"}], "default": "breakfast"}, "title": {"title": "Title", "type": "string", "default": ""}, "text": {"title": "Text", "type": "string", "default": ""}, "recipeId": {"title": "Recipeid", "type": "integer"}, "id": {"title": "Id", "type": "integer"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}, "recipe": {"$ref": "#/components/schemas/RecipeSummary"}}}, "ReadWebhook": {"title": "ReadWebhook", "required": ["groupId", "id"], "type": "object", "properties": {"enabled": {"title": "Enabled", "type": "boolean", "default": true}, "name": {"title": "Name", "type": "string", "default": ""}, "url": {"title": "Url", "type": "string", "default": ""}, "time": {"title": "Time", "type": "string", "default": "00:00"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}, "id": {"title": "Id", "type": "integer"}}}, "Recipe": {"title": "Recipe", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "userId": {"title": "Userid", "type": "string", "format": "uuid4"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "slug": {"title": "Slug", "type": "string", "default": ""}, "image": {"title": "Image"}, "recipeYield": {"title": "Recipeyield", "type": "string"}, "totalTime": {"title": "Totaltime", "type": "string"}, "prepTime": {"title": "Preptime", "type": "string"}, "cookTime": {"title": "Cooktime", "type": "string"}, "performTime": {"title": "Performtime", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "recipeCategory": {"title": "Recipecategory", "type": "array", "items": {"$ref": "#/components/schemas/RecipeTag"}, "default": []}, "tags": {"title": "Tags", "type": "array", "items": {"$ref": "#/components/schemas/RecipeTag"}, "default": []}, "tools": {"title": "Tools", "type": "array", "items": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe__RecipeTool"}, "default": []}, "rating": {"title": "Rating", "type": "integer"}, "orgURL": {"title": "Orgurl", "type": "string"}, "recipeIngredient": {"title": "Recipeingredient", "type": "array", "items": {"$ref": "#/components/schemas/RecipeIngredient"}, "default": []}, "dateAdded": {"title": "Dateadded", "type": "string", "format": "date"}, "dateUpdated": {"title": "Dateupdated", "type": "string", "format": "date-time"}, "recipeInstructions": {"title": "Recipeinstructions", "type": "array", "items": {"$ref": "#/components/schemas/RecipeStep"}, "default": []}, "nutrition": {"$ref": "#/components/schemas/Nutrition"}, "settings": {"title": "Settings", "allOf": [{"$ref": "#/components/schemas/RecipeSettings"}], "default": {"public": false, "show_nutrition": false, "show_assets": false, "landscape_view": false, "disable_comments": true, "disable_amount": true, "locked": false}}, "assets": {"title": "Assets", "type": "array", "items": {"$ref": "#/components/schemas/RecipeAsset"}, "default": []}, "notes": {"title": "Notes", "type": "array", "items": {"$ref": "#/components/schemas/RecipeNote"}, "default": []}, "extras": {"title": "Extras", "type": "object", "default": {}}, "comments": {"title": "Comments", "type": "array", "items": {"$ref": "#/components/schemas/RecipeCommentOut"}, "default": []}}}, "RecipeAsset": {"title": "RecipeAsset", "required": ["name", "icon"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "icon": {"title": "Icon", "type": "string"}, "fileName": {"title": "Filename", "type": "string"}}}, "RecipeCategory": {"title": "RecipeCategory", "required": ["name", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "slug": {"title": "Slug", "type": "string"}}}, "RecipeCategoryResponse": {"title": "RecipeCategoryResponse", "required": ["name", "id", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "integer"}, "slug": {"title": "Slug", "type": "string"}, "recipes": {"title": "Recipes", "type": "array", "items": {"$ref": "#/components/schemas/Recipe"}, "default": []}}, "example": {"id": 1, "name": "dinner", "recipes": [{}]}}, "RecipeCommentCreate": {"title": "RecipeCommentCreate", "required": ["recipeId", "text"], "type": "object", "properties": {"recipeId": {"title": "Recipeid", "type": "integer"}, "text": {"title": "Text", "type": "string"}}}, "RecipeCommentOut": {"title": "RecipeCommentOut", "required": ["recipeId", "text", "id", "createdAt", "updateAt", "userId", "user"], "type": "object", "properties": {"recipeId": {"title": "Recipeid", "type": "integer"}, "text": {"title": "Text", "type": "string"}, "id": {"title": "Id", "type": "string", "format": "uuid"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "updateAt": {"title": "Updateat", "type": "string", "format": "date-time"}, "userId": {"title": "Userid", "type": "string", "format": "uuid4"}, "user": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe_comments__UserBase"}}}, "RecipeCommentUpdate": {"title": "RecipeCommentUpdate", "required": ["id", "text"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "text": {"title": "Text", "type": "string"}}}, "RecipeCookBook": {"title": "RecipeCookBook", "required": ["name", "categories", "id", "groupId"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "slug": {"title": "Slug", "type": "string"}, "position": {"title": "Position", "type": "integer", "default": 1}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/RecipeCategoryResponse"}}, "id": {"title": "Id", "type": "integer"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}}}, "RecipeIngredient": {"title": "RecipeIngredient", "type": "object", "properties": {"title": {"title": "Title", "type": "string"}, "note": {"title": "Note", "type": "string"}, "unit": {"title": "Unit", "anyOf": [{"$ref": "#/components/schemas/IngredientUnit"}, {"$ref": "#/components/schemas/CreateIngredientUnit"}]}, "food": {"title": "Food", "anyOf": [{"$ref": "#/components/schemas/IngredientFood"}, {"$ref": "#/components/schemas/CreateIngredientFood"}]}, "disableAmount": {"title": "Disableamount", "type": "boolean", "default": true}, "quantity": {"title": "Quantity", "type": "number", "default": 1}, "referenceId": {"title": "Referenceid", "type": "string", "format": "uuid"}}}, "RecipeNote": {"title": "RecipeNote", "required": ["title", "text"], "type": "object", "properties": {"title": {"title": "Title", "type": "string"}, "text": {"title": "Text", "type": "string"}}}, "RecipeSettings": {"title": "RecipeSettings", "type": "object", "properties": {"public": {"title": "Public", "type": "boolean", "default": false}, "showNutrition": {"title": "Shownutrition", "type": "boolean", "default": false}, "showAssets": {"title": "Showassets", "type": "boolean", "default": false}, "landscapeView": {"title": "Landscapeview", "type": "boolean", "default": false}, "disableComments": {"title": "Disablecomments", "type": "boolean", "default": true}, "disableAmount": {"title": "Disableamount", "type": "boolean", "default": true}, "locked": {"title": "Locked", "type": "boolean", "default": false}}}, "RecipeShareToken": {"title": "RecipeShareToken", "required": ["recipeId", "groupId", "id", "createdAt", "recipe"], "type": "object", "properties": {"recipeId": {"title": "Recipeid", "type": "integer"}, "expiresAt": {"title": "Expiresat", "type": "string", "format": "date-time"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "recipe": {"$ref": "#/components/schemas/Recipe"}}}, "RecipeShareTokenCreate": {"title": "RecipeShareTokenCreate", "required": ["recipeId"], "type": "object", "properties": {"recipeId": {"title": "Recipeid", "type": "integer"}, "expiresAt": {"title": "Expiresat", "type": "string", "format": "date-time"}}}, "RecipeShareTokenSummary": {"title": "RecipeShareTokenSummary", "required": ["recipeId", "groupId", "id", "createdAt"], "type": "object", "properties": {"recipeId": {"title": "Recipeid", "type": "integer"}, "expiresAt": {"title": "Expiresat", "type": "string", "format": "date-time"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}}}, "RecipeStep": {"title": "RecipeStep", "required": ["text"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid"}, "title": {"title": "Title", "type": "string", "default": ""}, "text": {"title": "Text", "type": "string"}, "ingredientReferences": {"title": "Ingredientreferences", "type": "array", "items": {"$ref": "#/components/schemas/IngredientReferences"}, "default": []}}}, "RecipeSummary": {"title": "RecipeSummary", "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "userId": {"title": "Userid", "type": "string", "format": "uuid4"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "slug": {"title": "Slug", "type": "string", "default": ""}, "image": {"title": "Image"}, "recipeYield": {"title": "Recipeyield", "type": "string"}, "totalTime": {"title": "Totaltime", "type": "string"}, "prepTime": {"title": "Preptime", "type": "string"}, "cookTime": {"title": "Cooktime", "type": "string"}, "performTime": {"title": "Performtime", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "recipeCategory": {"title": "Recipecategory", "type": "array", "items": {"$ref": "#/components/schemas/RecipeTag"}, "default": []}, "tags": {"title": "Tags", "type": "array", "items": {"$ref": "#/components/schemas/RecipeTag"}, "default": []}, "tools": {"title": "Tools", "type": "array", "items": {"$ref": "#/components/schemas/mealie__schema__recipe__recipe__RecipeTool"}, "default": []}, "rating": {"title": "Rating", "type": "integer"}, "orgURL": {"title": "Orgurl", "type": "string"}, "recipeIngredient": {"title": "Recipeingredient", "type": "array", "items": {"$ref": "#/components/schemas/RecipeIngredient"}, "default": []}, "dateAdded": {"title": "Dateadded", "type": "string", "format": "date"}, "dateUpdated": {"title": "Dateupdated", "type": "string", "format": "date-time"}}}, "RecipeTag": {"title": "RecipeTag", "required": ["name", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "slug": {"title": "Slug", "type": "string"}}}, "RecipeTagResponse": {"title": "RecipeTagResponse", "required": ["name", "id", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "integer"}, "slug": {"title": "Slug", "type": "string"}, "recipes": {"title": "Recipes", "type": "array", "items": {"$ref": "#/components/schemas/Recipe"}, "default": []}}, "example": {"id": 1, "name": "dinner", "recipes": [{}]}}, "RecipeToolCreate": {"title": "RecipeToolCreate", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "onHand": {"title": "Onhand", "type": "boolean", "default": false}}}, "RegisteredParser": {"title": "RegisteredParser", "enum": ["nlp", "brute"], "type": "string", "description": "An enumeration."}, "ReportCategory": {"title": "ReportCategory", "enum": ["backup", "restore", "migration"], "type": "string", "description": "An enumeration."}, "ReportEntryOut": {"title": "ReportEntryOut", "required": ["reportId", "message", "id"], "type": "object", "properties": {"reportId": {"title": "Reportid", "type": "string", "format": "uuid4"}, "timestamp": {"title": "Timestamp", "type": "string", "format": "date-time"}, "success": {"title": "Success", "type": "boolean", "default": true}, "message": {"title": "Message", "type": "string"}, "exception": {"title": "Exception", "type": "string", "default": ""}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}}, "ReportOut": {"title": "ReportOut", "required": ["category", "groupId", "name", "id"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "type": "string", "format": "date-time"}, "category": {"$ref": "#/components/schemas/ReportCategory"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "status": {"allOf": [{"$ref": "#/components/schemas/ReportSummaryStatus"}], "default": "in-progress"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "entries": {"title": "Entries", "type": "array", "items": {"$ref": "#/components/schemas/ReportEntryOut"}, "default": []}}}, "ReportSummary": {"title": "ReportSummary", "required": ["category", "groupId", "name", "id"], "type": "object", "properties": {"timestamp": {"title": "Timestamp", "type": "string", "format": "date-time"}, "category": {"$ref": "#/components/schemas/ReportCategory"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "name": {"title": "Name", "type": "string"}, "status": {"allOf": [{"$ref": "#/components/schemas/ReportSummaryStatus"}], "default": "in-progress"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}}, "ReportSummaryStatus": {"title": "ReportSummaryStatus", "enum": ["in-progress", "success", "failure", "partial"], "type": "string", "description": "An enumeration."}, "ResetPassword": {"title": "ResetPassword", "required": ["token", "email", "password", "passwordConfirm"], "type": "object", "properties": {"token": {"title": "Token", "type": "string"}, "email": {"title": "Email", "type": "string"}, "password": {"title": "Password", "type": "string"}, "passwordConfirm": {"title": "Passwordconfirm", "type": "string"}}}, "ServerTask": {"title": "ServerTask", "required": ["groupId", "id"], "type": "object", "properties": {"groupId": {"title": "Groupid", "type": "string", "format": "uuid"}, "name": {"allOf": [{"$ref": "#/components/schemas/ServerTaskNames"}], "default": "Background Task"}, "createdAt": {"title": "Createdat", "type": "string", "format": "date-time"}, "status": {"allOf": [{"$ref": "#/components/schemas/ServerTaskStatus"}], "default": "running"}, "log": {"title": "Log", "type": "string", "default": ""}, "id": {"title": "Id", "type": "integer"}}}, "ServerTaskNames": {"title": "ServerTaskNames", "enum": ["Background Task", "Database Backup", "Bulk Recipe Import"], "type": "string", "description": "An enumeration."}, "ServerTaskStatus": {"title": "ServerTaskStatus", "enum": ["running", "finished", "failed"], "type": "string", "description": "An enumeration."}, "SetPermissions": {"title": "SetPermissions", "required": ["userId"], "type": "object", "properties": {"userId": {"title": "Userid", "type": "string", "format": "uuid4"}, "canManage": {"title": "Canmanage", "type": "boolean", "default": false}, "canInvite": {"title": "Caninvite", "type": "boolean", "default": false}, "canOrganize": {"title": "Canorganize", "type": "boolean", "default": false}}}, "ShoppingListCreate": {"title": "ShoppingListCreate", "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}, "description": "Create Shopping List"}, "ShoppingListItemOut": {"title": "ShoppingListItemOut", "required": ["shoppingListId", "id"], "type": "object", "properties": {"shoppingListId": {"title": "Shoppinglistid", "type": "string", "format": "uuid4"}, "checked": {"title": "Checked", "type": "boolean", "default": false}, "position": {"title": "Position", "type": "integer", "default": 0}, "isFood": {"title": "Isfood", "type": "boolean", "default": false}, "note": {"title": "Note", "type": "string", "default": ""}, "quantity": {"title": "Quantity", "type": "number", "default": 1}, "unitId": {"title": "Unitid", "type": "integer"}, "unit": {"$ref": "#/components/schemas/IngredientUnit"}, "foodId": {"title": "Foodid", "type": "integer"}, "food": {"$ref": "#/components/schemas/IngredientFood"}, "recipeId": {"title": "Recipeid", "type": "integer"}, "labelId": {"title": "Labelid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "label": {"$ref": "#/components/schemas/MultiPurposeLabelSummary"}}}, "ShoppingListOut": {"title": "ShoppingListOut", "required": ["groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "listItems": {"title": "Listitems", "type": "array", "items": {"$ref": "#/components/schemas/ShoppingListItemOut"}, "default": []}}, "description": "Create Shopping List"}, "ShoppingListSummary": {"title": "ShoppingListSummary", "required": ["groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}}, "description": "Create Shopping List"}, "ShoppingListUpdate": {"title": "ShoppingListUpdate", "required": ["groupId", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "listItems": {"title": "Listitems", "type": "array", "items": {"$ref": "#/components/schemas/ShoppingListItemOut"}, "default": []}}, "description": "Create Shopping List"}, "SupportedMigrations": {"title": "SupportedMigrations", "enum": ["nextcloud", "chowdown", "paprika", "mealie_alpha"], "type": "string", "description": "An enumeration."}, "TagBase": {"title": "TagBase", "required": ["name", "id", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "id": {"title": "Id", "type": "integer"}, "slug": {"title": "Slug", "type": "string"}}}, "TagIn": {"title": "TagIn", "required": ["name"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}}}, "UpdateCookBook": {"title": "UpdateCookBook", "required": ["name", "id"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string", "default": ""}, "slug": {"title": "Slug", "type": "string"}, "position": {"title": "Position", "type": "integer", "default": 1}, "categories": {"title": "Categories", "type": "array", "items": {"$ref": "#/components/schemas/CategoryBase"}, "default": []}, "id": {"title": "Id", "type": "integer"}}}, "UpdateGroupPreferences": {"title": "UpdateGroupPreferences", "type": "object", "properties": {"privateGroup": {"title": "Privategroup", "type": "boolean", "default": false}, "firstDayOfWeek": {"title": "Firstdayofweek", "type": "integer", "default": 0}, "recipePublic": {"title": "Recipepublic", "type": "boolean", "default": true}, "recipeShowNutrition": {"title": "Recipeshownutrition", "type": "boolean", "default": false}, "recipeShowAssets": {"title": "Recipeshowassets", "type": "boolean", "default": false}, "recipeLandscapeView": {"title": "Recipelandscapeview", "type": "boolean", "default": false}, "recipeDisableComments": {"title": "Recipedisablecomments", "type": "boolean", "default": false}, "recipeDisableAmount": {"title": "Recipedisableamount", "type": "boolean", "default": false}}}, "UpdatePlanEntry": {"title": "UpdatePlanEntry", "required": ["date", "id", "groupId"], "type": "object", "properties": {"date": {"title": "Date", "type": "string", "format": "date"}, "entryType": {"allOf": [{"$ref": "#/components/schemas/PlanEntryType"}], "default": "breakfast"}, "title": {"title": "Title", "type": "string", "default": ""}, "text": {"title": "Text", "type": "string", "default": ""}, "recipeId": {"title": "Recipeid", "type": "integer"}, "id": {"title": "Id", "type": "integer"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid"}}}, "UserFavorites": {"title": "UserFavorites", "required": ["email"], "type": "object", "properties": {"username": {"title": "Username", "type": "string"}, "fullName": {"title": "Fullname", "type": "string"}, "email": {"title": "Email", "type": "string"}, "admin": {"title": "Admin", "type": "boolean", "default": false}, "group": {"title": "Group", "type": "string"}, "advanced": {"title": "Advanced", "type": "boolean", "default": false}, "favoriteRecipes": {"title": "Favoriterecipes", "type": "array", "items": {"$ref": "#/components/schemas/RecipeSummary"}, "default": []}, "canInvite": {"title": "Caninvite", "type": "boolean", "default": false}, "canManage": {"title": "Canmanage", "type": "boolean", "default": false}, "canOrganize": {"title": "Canorganize", "type": "boolean", "default": false}}, "fullName": "Change Me", "email": "changeme@email.com", "username": "ChangeMe", "group": "Home", "admin": "false"}, "UserIn": {"title": "UserIn", "required": ["email", "password"], "type": "object", "properties": {"username": {"title": "Username", "type": "string"}, "fullName": {"title": "Fullname", "type": "string"}, "email": {"title": "Email", "type": "string"}, "admin": {"title": "Admin", "type": "boolean", "default": false}, "group": {"title": "Group", "type": "string"}, "advanced": {"title": "Advanced", "type": "boolean", "default": false}, "favoriteRecipes": {"title": "Favoriterecipes", "type": "array", "items": {"type": "string"}, "default": []}, "canInvite": {"title": "Caninvite", "type": "boolean", "default": false}, "canManage": {"title": "Canmanage", "type": "boolean", "default": false}, "canOrganize": {"title": "Canorganize", "type": "boolean", "default": false}, "password": {"title": "Password", "type": "string"}}, "fullName": "Change Me", "email": "changeme@email.com", "username": "ChangeMe", "group": "Home", "admin": "false"}, "UserOut": {"title": "UserOut", "required": ["email", "group", "id", "groupId", "cacheKey"], "type": "object", "properties": {"username": {"title": "Username", "type": "string"}, "fullName": {"title": "Fullname", "type": "string"}, "email": {"title": "Email", "type": "string"}, "admin": {"title": "Admin", "type": "boolean", "default": false}, "group": {"title": "Group", "type": "string"}, "advanced": {"title": "Advanced", "type": "boolean", "default": false}, "favoriteRecipes": {"title": "Favoriterecipes", "type": "array", "items": {"type": "string"}, "default": []}, "canInvite": {"title": "Caninvite", "type": "boolean", "default": false}, "canManage": {"title": "Canmanage", "type": "boolean", "default": false}, "canOrganize": {"title": "Canorganize", "type": "boolean", "default": false}, "id": {"title": "Id", "type": "string", "format": "uuid4"}, "groupId": {"title": "Groupid", "type": "string", "format": "uuid4"}, "tokens": {"title": "Tokens", "type": "array", "items": {"$ref": "#/components/schemas/LongLiveTokenOut"}}, "cacheKey": {"title": "Cachekey", "type": "string"}}, "fullName": "Change Me", "email": "changeme@email.com", "username": "ChangeMe", "group": "Home", "admin": "false"}, "ValidationError": {"title": "ValidationError", "required": ["loc", "msg", "type"], "type": "object", "properties": {"loc": {"title": "Location", "type": "array", "items": {"type": "string"}}, "msg": {"title": "Message", "type": "string"}, "type": {"title": "Error Type", "type": "string"}}}, "mealie__schema__recipe__recipe__RecipeTool": {"title": "RecipeTool", "required": ["name", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "slug": {"title": "Slug", "type": "string"}, "id": {"title": "Id", "type": "integer", "default": 0}, "onHand": {"title": "Onhand", "type": "boolean", "default": false}}}, "mealie__schema__recipe__recipe_comments__UserBase": {"title": "UserBase", "required": ["id", "admin"], "type": "object", "properties": {"id": {"title": "Id", "type": "integer"}, "username": {"title": "Username", "type": "string"}, "admin": {"title": "Admin", "type": "boolean"}}}, "mealie__schema__recipe__recipe_tool__RecipeTool": {"title": "RecipeTool", "required": ["name", "id", "slug"], "type": "object", "properties": {"name": {"title": "Name", "type": "string"}, "onHand": {"title": "Onhand", "type": "boolean", "default": false}, "id": {"title": "Id", "type": "integer"}, "slug": {"title": "Slug", "type": "string"}}}, "mealie__schema__user__user__UserBase": {"title": "UserBase", "required": ["email"], "type": "object", "properties": {"username": {"title": "Username", "type": "string"}, "fullName": {"title": "Fullname", "type": "string"}, "email": {"title": "Email", "type": "string"}, "admin": {"title": "Admin", "type": "boolean", "default": false}, "group": {"title": "Group", "type": "string"}, "advanced": {"title": "Advanced", "type": "boolean", "default": false}, "favoriteRecipes": {"title": "Favoriterecipes", "type": "array", "items": {"type": "string"}, "default": []}, "canInvite": {"title": "Caninvite", "type": "boolean", "default": false}, "canManage": {"title": "Canmanage", "type": "boolean", "default": false}, "canOrganize": {"title": "Canorganize", "type": "boolean", "default": false}}, "fullName": "Change Me", "email": "changeme@email.com", "username": "ChangeMe", "group": "Home", "admin": "false"}}, "securitySchemes": {"OAuth2PasswordBearer": {"type": "oauth2", "flows": {"password": {"scopes": {}, "tokenUrl": "/api/auth/token"}}}}}};
|
|
Redoc.init(spec, {}, document.getElementById("redoc-container"));
|
|
</script>
|
|
|
|
|
|
{% endblock %}
|
|
{% block content %}{% endblock %}
|
|
{% block footer %}{% endblock %}
|