openapi.json•754 kB
{
"openapi": "3.1.0",
"info": {
"title": "Mealie",
"description": "\nMealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful\nAPI interactive documentation that can be used to explore the API. If you're justing getting started with\nthe API and want to get started quickly, you can use the\n[API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/)\nas a reference for how to get started.\n\n\nIf you have any questions or comments about mealie, please use the discord server to talk to the developers or other\ncommunity members. If you'd like to file an issue, please use the\n[GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose)\n\n\n## Helpful Links\n- [Home Page](https://mealie.io)\n- [Documentation](https://docs.mealie.io)\n- [Discord](https://discord.gg/QuStdQGSGK)\n- [Demo](https://demo.mealie.io)\n",
"version": "develop"
},
"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/app/about/startup-info": {
"get": {
"tags": [
"App: About"
],
"summary": "Get Startup Info",
"description": "returns helpful startup information",
"operationId": "get_startup_info_api_app_about_startup_info_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppStartupInfo"
}
}
}
}
}
}
},
"/api/app/about/theme": {
"get": {
"tags": [
"App: About"
],
"summary": "Get App Theme",
"description": "Get's the current theme settings",
"operationId": "get_app_theme_api_app_about_theme_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppTheme"
}
}
}
}
}
}
},
"/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"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/oauth": {
"get": {
"tags": [
"Users: Authentication"
],
"summary": "Oauth Login",
"operationId": "oauth_login_api_auth_oauth_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/auth/oauth/callback": {
"get": {
"tags": [
"Users: Authentication"
],
"summary": "Oauth Callback",
"operationId": "oauth_callback_api_auth_oauth_callback_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/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/auth/logout": {
"post": {
"tags": [
"Users: Authentication"
],
"summary": "Logout",
"operationId": "logout_api_auth_logout_post",
"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",
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserRegistration"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/users/self": {
"get": {
"tags": [
"Users: CRUD"
],
"summary": "Get Logged In User",
"operationId": "get_logged_in_user_api_users_self_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/users/self/ratings": {
"get": {
"tags": [
"Users: CRUD"
],
"summary": "Get Logged In User Ratings",
"operationId": "get_logged_in_user_ratings_api_users_self_ratings_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRatings_UserRatingSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/self/ratings/{recipe_id}": {
"get": {
"tags": [
"Users: CRUD"
],
"summary": "Get Logged In User Rating For Recipe",
"operationId": "get_logged_in_user_rating_for_recipe_api_users_self_ratings__recipe_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "recipe_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Recipe Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRatingSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/self/favorites": {
"get": {
"tags": [
"Users: CRUD"
],
"summary": "Get Logged In User Favorites",
"operationId": "get_logged_in_user_favorites_api_users_self_favorites_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRatings_UserRatingSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/password": {
"put": {
"tags": [
"Users: CRUD"
],
"summary": "Update Password",
"description": "Resets the User Password",
"operationId": "update_password_api_users_password_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePassword"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/{item_id}": {
"put": {
"tags": [
"Users: CRUD"
],
"summary": "Update User",
"operationId": "update_user_api_users__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/mealie__schema__user__user__UserBase"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Users: Admin CRUD"
],
"summary": "Get User",
"operationId": "get_user_api_users__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Users: Admin CRUD"
],
"summary": "Delete User",
"operationId": "delete_user_api_users__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users": {
"get": {
"tags": [
"Users: Admin CRUD"
],
"summary": "Get All",
"description": "Returns all users from all groups",
"operationId": "get_all_api_users_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Users: Admin CRUD"
],
"summary": "Create User",
"operationId": "create_user_api_users_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserIn"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/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",
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForgotPassword"
}
}
}
},
"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"
],
"summary": "Update User Image",
"description": "Updates a User Image",
"operationId": "update_user_image_api_users__id__image_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_update_user_image_api_users__id__image_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LongLiveTokenIn"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LongLiveTokenCreateResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "token_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Token Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteTokenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/{id}/ratings": {
"get": {
"tags": [
"Users: Ratings"
],
"summary": "Get Ratings",
"description": "Get user's rated recipes",
"operationId": "get_ratings_api_users__id__ratings_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRatings_UserRatingOut_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/{id}/favorites": {
"get": {
"tags": [
"Users: Ratings"
],
"summary": "Get Favorites",
"description": "Get user's favorited recipes",
"operationId": "get_favorites_api_users__id__favorites_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRatings_UserRatingOut_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/{id}/ratings/{slug}": {
"post": {
"tags": [
"Users: Ratings"
],
"summary": "Set Rating",
"description": "Sets the user's rating for a recipe",
"operationId": "set_rating_api_users__id__ratings__slug__post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRatingUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/users/{id}/favorites/{slug}": {
"post": {
"tags": [
"Users: Ratings"
],
"summary": "Add Favorite",
"description": "Adds a recipe to the user's favorites",
"operationId": "add_favorite_api_users__id__favorites__slug__post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Users: Ratings"
],
"summary": "Remove Favorite",
"description": "Removes a recipe from the user's favorites",
"operationId": "remove_favorite_api_users__id__favorites__slug__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/cookbooks": {
"get": {
"tags": [
"Households: Cookbooks"
],
"summary": "Get All",
"operationId": "get_all_api_households_cookbooks_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CookBookPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Cookbooks"
],
"summary": "Create One",
"operationId": "create_one_api_households_cookbooks_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCookBook"
}
}
}
},
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Cookbooks"
],
"summary": "Update Many",
"operationId": "update_many_api_households_cookbooks_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpdateCookBook"
},
"title": "Data"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReadCookBook"
},
"title": "Response Update Many Api Households Cookbooks Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/cookbooks/{item_id}": {
"get": {
"tags": [
"Households: Cookbooks"
],
"summary": "Get One",
"operationId": "get_one_api_households_cookbooks__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
],
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Cookbooks"
],
"summary": "Update One",
"operationId": "update_one_api_households_cookbooks__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCookBook"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Cookbooks"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_cookbooks__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/households/events/notifications": {
"get": {
"tags": [
"Households: Event Notifications"
],
"summary": "Get All",
"operationId": "get_all_api_households_events_notifications_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupEventPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Event Notifications"
],
"summary": "Create One",
"operationId": "create_one_api_households_events_notifications_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupEventNotifierCreate"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/events/notifications/{item_id}": {
"get": {
"tags": [
"Households: Event Notifications"
],
"summary": "Get One",
"operationId": "get_one_api_households_events_notifications__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Event Notifications"
],
"summary": "Update One",
"operationId": "update_one_api_households_events_notifications__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupEventNotifierUpdate"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Event Notifications"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_events_notifications__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/events/notifications/{item_id}/test": {
"post": {
"tags": [
"Households: Event Notifications"
],
"summary": "Test Notification",
"operationId": "test_notification_api_households_events_notifications__item_id__test_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/recipe-actions": {
"get": {
"tags": [
"Households: Recipe Actions"
],
"summary": "Get All",
"operationId": "get_all_api_households_recipe_actions_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRecipeActionPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Recipe Actions"
],
"summary": "Create One",
"operationId": "create_one_api_households_recipe_actions_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateGroupRecipeAction"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRecipeActionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/recipe-actions/{item_id}": {
"get": {
"tags": [
"Households: Recipe Actions"
],
"summary": "Get One",
"operationId": "get_one_api_households_recipe_actions__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRecipeActionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Recipe Actions"
],
"summary": "Update One",
"operationId": "update_one_api_households_recipe_actions__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SaveGroupRecipeAction"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRecipeActionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Recipe Actions"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_recipe_actions__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupRecipeActionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/recipe-actions/{item_id}/trigger/{recipe_slug}": {
"post": {
"tags": [
"Households: Recipe Actions"
],
"summary": "Trigger Action",
"operationId": "trigger_action_api_households_recipe_actions__item_id__trigger__recipe_slug__post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "recipe_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Recipe Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/self": {
"get": {
"tags": [
"Households: Self Service"
],
"summary": "Get Logged In User Household",
"description": "Returns the Household Data for the Current User",
"operationId": "get_logged_in_user_household_api_households_self_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdInDB"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/self/recipes/{recipe_slug}": {
"get": {
"tags": [
"Households: Self Service"
],
"summary": "Get Household Recipe",
"description": "Returns recipe data for the current household",
"operationId": "get_household_recipe_api_households_self_recipes__recipe_slug__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "recipe_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Recipe Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdRecipeSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/members": {
"get": {
"tags": [
"Households: Self Service"
],
"summary": "Get Household Members",
"description": "Returns all users belonging to the current household",
"operationId": "get_household_members_api_households_members_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_UserOut_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/preferences": {
"get": {
"tags": [
"Households: Self Service"
],
"summary": "Get Household Preferences",
"operationId": "get_household_preferences_api_households_preferences_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadHouseholdPreferences"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Self Service"
],
"summary": "Update Household Preferences",
"operationId": "update_household_preferences_api_households_preferences_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateHouseholdPreferences"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReadHouseholdPreferences"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/permissions": {
"put": {
"tags": [
"Households: Self Service"
],
"summary": "Set Member Permissions",
"operationId": "set_member_permissions_api_households_permissions_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetPermissions"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/statistics": {
"get": {
"tags": [
"Households: Self Service"
],
"summary": "Get Statistics",
"operationId": "get_statistics_api_households_statistics_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdStatistics"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/invitations": {
"get": {
"tags": [
"Households: Invitations"
],
"summary": "Get Invite Tokens",
"operationId": "get_invite_tokens_api_households_invitations_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReadInviteToken"
},
"title": "Response Get Invite Tokens Api Households Invitations Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Invitations"
],
"summary": "Create Invite Token",
"operationId": "create_invite_token_api_households_invitations_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInviteToken"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/invitations/email": {
"post": {
"tags": [
"Households: Invitations"
],
"summary": "Email Invitation",
"operationId": "email_invitation_api_households_invitations_email_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailInvitation"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/shopping/lists": {
"get": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Get All",
"operationId": "get_all_api_households_shopping_lists_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Create One",
"operationId": "create_one_api_households_shopping_lists_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/shopping/lists/{item_id}": {
"get": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Get One",
"operationId": "get_one_api_households_shopping_lists__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Update One",
"operationId": "update_one_api_households_shopping_lists__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListUpdate"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_shopping_lists__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/households/shopping/lists/{item_id}/label-settings": {
"put": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Update Label Settings",
"operationId": "update_label_settings_api_households_shopping_lists__item_id__label_settings_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShoppingListMultiPurposeLabelUpdate"
},
"title": "Data"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/shopping/lists/{item_id}/recipe": {
"post": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Add Recipe Ingredients To List",
"operationId": "add_recipe_ingredients_to_list_api_households_shopping_lists__item_id__recipe_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShoppingListAddRecipeParamsBulk"
},
"title": "Data"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/shopping/lists/{item_id}/recipe/{recipe_id}": {
"post": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Add Single Recipe Ingredients To List",
"operationId": "add_single_recipe_ingredients_to_list_api_households_shopping_lists__item_id__recipe__recipe_id__post",
"deprecated": true,
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "recipe_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Recipe Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ShoppingListAddRecipeParams"
},
{
"type": "null"
}
],
"title": "Data"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/shopping/lists/{item_id}/recipe/{recipe_id}/delete": {
"post": {
"tags": [
"Households: Shopping Lists"
],
"summary": "Remove Recipe Ingredients From List",
"operationId": "remove_recipe_ingredients_from_list_api_households_shopping_lists__item_id__recipe__recipe_id__delete_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "recipe_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Recipe Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ShoppingListRemoveRecipeParams"
},
{
"type": "null"
}
],
"title": "Data"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/shopping/items": {
"get": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Get All",
"operationId": "get_all_api_households_shopping_items_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Create One",
"operationId": "create_one_api_households_shopping_items_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemsCollectionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Update Many",
"operationId": "update_many_api_households_shopping_items_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShoppingListItemUpdateBulk"
},
"title": "Data"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemsCollectionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Delete Many",
"operationId": "delete_many_api_households_shopping_items_delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "ids",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid4"
},
"title": "Ids"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/shopping/items/create-bulk": {
"post": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Create Many",
"operationId": "create_many_api_households_shopping_items_create_bulk_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShoppingListItemCreate"
},
"title": "Data"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemsCollectionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/shopping/items/{item_id}": {
"get": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Get One",
"operationId": "get_one_api_households_shopping_items__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemOut-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Update One",
"operationId": "update_one_api_households_shopping_items__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShoppingListItemsCollectionOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Shopping List Items"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_shopping_items__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/webhooks": {
"get": {
"tags": [
"Households: Webhooks"
],
"summary": "Get All",
"operationId": "get_all_api_households_webhooks_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Webhooks"
],
"summary": "Create One",
"operationId": "create_one_api_households_webhooks_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhook"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/webhooks/rerun": {
"post": {
"tags": [
"Households: Webhooks"
],
"summary": "Rerun Webhooks",
"description": "Manually re-fires all previously scheduled webhooks for today",
"operationId": "rerun_webhooks_api_households_webhooks_rerun_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/webhooks/{item_id}": {
"get": {
"tags": [
"Households: Webhooks"
],
"summary": "Get One",
"operationId": "get_one_api_households_webhooks__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Webhooks"
],
"summary": "Update One",
"operationId": "update_one_api_households_webhooks__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateWebhook"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Webhooks"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_webhooks__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/households/webhooks/{item_id}/test": {
"post": {
"tags": [
"Households: Webhooks"
],
"summary": "Test One",
"operationId": "test_one_api_households_webhooks__item_id__test_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/mealplans/rules": {
"get": {
"tags": [
"Households: Mealplan Rules"
],
"summary": "Get All",
"operationId": "get_all_api_households_mealplans_rules_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Mealplan Rules"
],
"summary": "Create One",
"operationId": "create_one_api_households_mealplans_rules_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/mealplans/rules/{item_id}": {
"get": {
"tags": [
"Households: Mealplan Rules"
],
"summary": "Get One",
"operationId": "get_one_api_households_mealplans_rules__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Mealplan Rules"
],
"summary": "Update One",
"operationId": "update_one_api_households_mealplans_rules__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Mealplan Rules"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_mealplans_rules__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRulesOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/mealplans": {
"get": {
"tags": [
"Households: Mealplans"
],
"summary": "Get All",
"operationId": "get_all_api_households_mealplans_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "start_date",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date"
}
},
{
"name": "end_date",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanEntryPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Households: Mealplans"
],
"summary": "Create One",
"operationId": "create_one_api_households_mealplans_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePlanEntry"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/mealplans/today": {
"get": {
"tags": [
"Households: Mealplans"
],
"summary": "Get Todays Meals",
"operationId": "get_todays_meals_api_households_mealplans_today_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/households/mealplans/random": {
"post": {
"tags": [
"Households: Mealplans"
],
"summary": "Create Random Meal",
"description": "`create_random_meal` is a route that provides the randomized functionality for mealplaners.\nIt operates by following the rules set out in the household's mealplan settings. If no settings\nare set, it will return any random meal.\n\nRefer to the mealplan settings routes for more information on how rules can be applied\nto the random meal selector.",
"operationId": "create_random_meal_api_households_mealplans_random_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRandomEntry"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/households/mealplans/{item_id}": {
"get": {
"tags": [
"Households: Mealplans"
],
"summary": "Get One",
"operationId": "get_one_api_households_mealplans__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Households: Mealplans"
],
"summary": "Update One",
"operationId": "update_one_api_households_mealplans__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePlanEntry"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Households: Mealplans"
],
"summary": "Delete One",
"operationId": "delete_one_api_households_mealplans__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/groups/households": {
"get": {
"tags": [
"Groups: Households"
],
"summary": "Get All Households",
"operationId": "get_all_households_api_groups_households_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_HouseholdSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/households/{household_slug}": {
"get": {
"tags": [
"Groups: Households"
],
"summary": "Get One Household",
"operationId": "get_one_household_api_groups_households__household_slug__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "household_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Household Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/members": {
"get": {
"tags": [
"Groups: Self Service"
],
"summary": "Get Group Members",
"description": "Returns all users belonging to the current group",
"operationId": "get_group_members_api_groups_members_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_UserSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/members/{username_or_id}": {
"get": {
"tags": [
"Groups: Self Service"
],
"summary": "Get Group Member",
"description": "Returns a single user belonging to the current group",
"operationId": "get_group_member_api_groups_members__username_or_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "username_or_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "uuid4"
}
],
"title": "Username Or Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/preferences": {
"get": {
"tags": [
"Groups: Self Service"
],
"summary": "Get Group Preferences",
"operationId": "get_group_preferences_api_groups_preferences_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Groups: Self Service"
],
"summary": "Update Group Preferences",
"operationId": "update_group_preferences_api_groups_preferences_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateGroupPreferences"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/groups/storage": {
"get": {
"tags": [
"Groups: Self Service"
],
"summary": "Get Storage",
"operationId": "get_storage_api_groups_storage_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupStorage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/migrations": {
"post": {
"tags": [
"Groups: Migrations"
],
"summary": "Start Data Migration",
"operationId": "start_data_migration_api_groups_migrations_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_start_data_migration_api_groups_migrations_post"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/groups/reports": {
"get": {
"tags": [
"Groups: Reports"
],
"summary": "Get All",
"operationId": "get_all_api_groups_reports_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "report_type",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/ReportCategory"
},
{
"type": "null"
}
],
"title": "Report Type"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReportSummary"
},
"title": "Response Get All Api Groups Reports Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/reports/{item_id}": {
"get": {
"tags": [
"Groups: Reports"
],
"summary": "Get One",
"operationId": "get_one_api_groups_reports__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Groups: Reports"
],
"summary": "Delete One",
"operationId": "delete_one_api_groups_reports__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/labels": {
"get": {
"tags": [
"Groups: Multi Purpose Labels"
],
"summary": "Get All",
"operationId": "get_all_api_groups_labels_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultiPurposeLabelPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Groups: Multi Purpose Labels"
],
"summary": "Create One",
"operationId": "create_one_api_groups_labels_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultiPurposeLabelCreate"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/groups/labels/{item_id}": {
"get": {
"tags": [
"Groups: Multi Purpose Labels"
],
"summary": "Get One",
"operationId": "get_one_api_groups_labels__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Groups: Multi Purpose Labels"
],
"summary": "Update One",
"operationId": "update_one_api_groups_labels__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultiPurposeLabelUpdate"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Groups: Multi Purpose Labels"
],
"summary": "Delete One",
"operationId": "delete_one_api_groups_labels__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/groups/seeders/foods": {
"post": {
"tags": [
"Groups: Seeders"
],
"summary": "Seed Foods",
"operationId": "seed_foods_api_groups_seeders_foods_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeederConfig"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/seeders/labels": {
"post": {
"tags": [
"Groups: Seeders"
],
"summary": "Seed Labels",
"operationId": "seed_labels_api_groups_seeders_labels_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeederConfig"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/groups/seeders/units": {
"post": {
"tags": [
"Groups: Seeders"
],
"summary": "Seed Units",
"operationId": "seed_units_api_groups_seeders_units_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeederConfig"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FormatResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}/exports": {
"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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeZipTokenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "template_name",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Template Name"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}/exports/zip": {
"get": {
"tags": [
"Recipe: Exports"
],
"summary": "Get Recipe As Zip",
"description": "Get a Recipe and Its Original Image as a Zip File",
"operationId": "get_recipe_as_zip_api_recipes__slug__exports_zip_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Token"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScrapeRecipeTest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/create/html-or-json": {
"post": {
"tags": [
"Recipe: CRUD"
],
"summary": "Create Recipe From Html Or Json",
"description": "Takes in raw HTML or a https://schema.org/Recipe object as a JSON string and parses it like a URL",
"operationId": "create_recipe_from_html_or_json_api_recipes_create_html_or_json_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScrapeRecipeData"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScrapeRecipe"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Parse Recipe Url Api Recipes Create Url Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRecipeByUrlBulk"
}
}
}
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/create/zip": {
"post": {
"tags": [
"Recipe: CRUD"
],
"summary": "Create Recipe From Zip",
"description": "Create recipe from archive",
"operationId": "create_recipe_from_zip_api_recipes_create_zip_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_recipe_from_zip_api_recipes_create_zip_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/create/image": {
"post": {
"tags": [
"Recipe: CRUD"
],
"summary": "Create Recipe From Image",
"description": "Create a recipe from an image using OpenAI.\nOptionally specify a language for it to translate the recipe to.",
"operationId": "create_recipe_from_image_api_recipes_create_image_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "translateLanguage",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Translatelanguage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_create_recipe_from_image_api_recipes_create_image_post"
}
}
}
},
"responses": {
"201": {
"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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "categories",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Categories"
}
},
{
"name": "tags",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Tags"
}
},
{
"name": "tools",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Tools"
}
},
{
"name": "foods",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Foods"
}
},
{
"name": "households",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Households"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "cookbook",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cookbook"
}
},
{
"name": "requireAllCategories",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requireallcategories"
}
},
{
"name": "requireAllTags",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requirealltags"
}
},
{
"name": "requireAllTools",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requirealltools"
}
},
{
"name": "requireAllFoods",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requireallfoods"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_RecipeSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Recipe: CRUD"
],
"summary": "Create One",
"description": "Takes in a JSON string and loads data into the database as a new entry",
"operationId": "create_one_api_recipes_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRecipe"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Create One Api Recipes Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipe: CRUD"
],
"summary": "Update Many",
"operationId": "update_many_api_recipes_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipe-Input"
},
"title": "Data"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Recipe: CRUD"
],
"summary": "Patch Many",
"operationId": "patch_many_api_recipes_patch",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipe-Input"
},
"title": "Data"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/suggestions": {
"get": {
"tags": [
"Recipe: CRUD"
],
"summary": "Suggest Recipes",
"operationId": "suggest_recipes_api_recipes_suggestions_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "foods",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid4"
}
},
{
"type": "null"
}
],
"title": "Foods"
}
},
{
"name": "tools",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid4"
}
},
{
"type": "null"
}
],
"title": "Tools"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"title": "Limit"
}
},
{
"name": "maxMissingFoods",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Maxmissingfoods"
}
},
{
"name": "maxMissingTools",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Maxmissingtools"
}
},
{
"name": "includeFoodsOnHand",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Includefoodsonhand"
}
},
{
"name": "includeToolsOnHand",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Includetoolsonhand"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeSuggestionResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}": {
"get": {
"tags": [
"Recipe: CRUD"
],
"summary": "Get One",
"description": "Takes in a recipe's slug or id and returns all data for a recipe",
"operationId": "get_one_api_recipes__slug__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "A recipe's slug or id",
"title": "Slug"
},
"description": "A recipe's slug or id"
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recipe-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipe: CRUD"
],
"summary": "Update One",
"description": "Updates a recipe by existing slug and data.",
"operationId": "update_one_api_recipes__slug__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recipe-Input"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Recipe: CRUD"
],
"summary": "Patch One",
"description": "Updates a recipe by existing slug and data.",
"operationId": "patch_one_api_recipes__slug__patch",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recipe-Input"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Recipe: CRUD"
],
"summary": "Delete One",
"description": "Deletes a recipe by slug",
"operationId": "delete_one_api_recipes__slug__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}/duplicate": {
"post": {
"tags": [
"Recipe: CRUD"
],
"summary": "Duplicate One",
"description": "Duplicates a recipe with a new custom name if given",
"operationId": "duplicate_one_api_recipes__slug__duplicate_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeDuplicate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recipe-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}/last-made": {
"patch": {
"tags": [
"Recipe: CRUD"
],
"summary": "Update Last Made",
"description": "Update a recipe's last made timestamp",
"operationId": "update_last_made_api_recipes__slug__last_made_patch",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeLastMade"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}/image": {
"post": {
"tags": [
"Recipe: Images and Assets",
"Recipe: CRUD"
],
"summary": "Scrape Image Url",
"operationId": "scrape_image_url_api_recipes__slug__image_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScrapeRecipe"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipe: Images and Assets",
"Recipe: CRUD"
],
"summary": "Update Recipe Image",
"operationId": "update_recipe_image_api_recipes__slug__image_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_update_recipe_image_api_recipes__slug__image_put"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateImageResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/{slug}/assets": {
"post": {
"tags": [
"Recipe: Images and Assets",
"Recipe: CRUD"
],
"summary": "Upload Recipe Asset",
"description": "Upload a file to store as a recipe asset",
"operationId": "upload_recipe_asset_api_recipes__slug__assets_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_recipe_asset_api_recipes__slug__assets_post"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecipeCommentOut-Output"
},
"title": "Response Get Recipe Comments Api Recipes Slug Comments Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/tag": {
"post": {
"tags": [
"Recipe: Bulk Actions"
],
"summary": "Bulk Tag Recipes",
"operationId": "bulk_tag_recipes_api_recipes_bulk_actions_tag_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignTags"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/settings": {
"post": {
"tags": [
"Recipe: Bulk Actions"
],
"summary": "Bulk Settings Recipes",
"operationId": "bulk_settings_recipes_api_recipes_bulk_actions_settings_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignSettings"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/categorize": {
"post": {
"tags": [
"Recipe: Bulk Actions"
],
"summary": "Bulk Categorize Recipes",
"operationId": "bulk_categorize_recipes_api_recipes_bulk_actions_categorize_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignCategories"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/delete": {
"post": {
"tags": [
"Recipe: Bulk Actions"
],
"summary": "Bulk Delete Recipes",
"operationId": "bulk_delete_recipes_api_recipes_bulk_actions_delete_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteRecipes"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/export": {
"post": {
"tags": [
"Recipe: Bulk Actions"
],
"summary": "Bulk Export Recipes",
"operationId": "bulk_export_recipes_api_recipes_bulk_actions_export_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportRecipes"
}
}
}
},
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Recipe: Bulk Actions"
],
"summary": "Get Exported Data",
"operationId": "get_exported_data_api_recipes_bulk_actions_export_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupDataExport"
},
"title": "Response Get Exported Data Api Recipes Bulk Actions Export Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/export/download": {
"get": {
"tags": [
"Recipe: Bulk Actions"
],
"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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "path",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "path",
"title": "Path"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/bulk-actions/export/purge": {
"delete": {
"tags": [
"Recipe: Bulk Actions"
],
"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",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/shared/{token_id}": {
"get": {
"tags": [
"Recipe: Shared"
],
"summary": "Get Shared Recipe",
"operationId": "get_shared_recipe_api_recipes_shared__token_id__get",
"parameters": [
{
"name": "token_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Token Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recipe-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/timeline/events": {
"get": {
"tags": [
"Recipe: Timeline"
],
"summary": "Get All",
"operationId": "get_all_api_recipes_timeline_events_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Recipe: Timeline"
],
"summary": "Create One",
"operationId": "create_one_api_recipes_timeline_events_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventIn"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/timeline/events/{item_id}": {
"get": {
"tags": [
"Recipe: Timeline"
],
"summary": "Get One",
"operationId": "get_one_api_recipes_timeline_events__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipe: Timeline"
],
"summary": "Update One",
"operationId": "update_one_api_recipes_timeline_events__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Recipe: Timeline"
],
"summary": "Delete One",
"operationId": "delete_one_api_recipes_timeline_events__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTimelineEventOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/recipes/timeline/events/{item_id}/image": {
"put": {
"tags": [
"Recipe: Timeline"
],
"summary": "Update Event Image",
"operationId": "update_event_image_api_recipes_timeline_events__item_id__image_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_update_event_image_api_recipes_timeline_events__item_id__image_put"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateImageResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/categories": {
"get": {
"tags": [
"Organizer: Categories"
],
"summary": "Get All",
"description": "Returns a list of available categories in the database",
"operationId": "get_all_api_organizers_categories_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCategoryPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Organizer: Categories"
],
"summary": "Create One",
"description": "Creates a Category in the database",
"operationId": "create_one_api_organizers_categories_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoryIn"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/categories/empty": {
"get": {
"tags": [
"Organizer: Categories"
],
"summary": "Get All Empty",
"description": "Returns a list of categories that do not contain any recipes",
"operationId": "get_all_empty_api_organizers_categories_empty_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CategoryBase"
},
"title": "Response Get All Empty Api Organizers Categories Empty Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/categories/{item_id}": {
"get": {
"tags": [
"Organizer: Categories"
],
"summary": "Get One",
"description": "Returns a list of recipes associated with the provided category.",
"operationId": "get_one_api_organizers_categories__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategorySummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Organizer: Categories"
],
"summary": "Update One",
"description": "Updates an existing Tag in the database",
"operationId": "update_one_api_organizers_categories__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoryIn"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategorySummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Organizer: Categories"
],
"summary": "Delete One",
"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_one_api_organizers_categories__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/categories/slug/{category_slug}": {
"get": {
"tags": [
"Organizer: Categories"
],
"summary": "Get One By Slug",
"description": "Returns a category object with the associated recieps relating to the category",
"operationId": "get_one_by_slug_api_organizers_categories_slug__category_slug__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "category_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Category Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/tags": {
"get": {
"tags": [
"Organizer: Tags"
],
"summary": "Get All",
"description": "Returns a list of available tags in the database",
"operationId": "get_all_api_organizers_tags_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTagPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Organizer: Tags"
],
"summary": "Create One",
"description": "Creates a Tag in the database",
"operationId": "create_one_api_organizers_tags_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagIn"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/tags/empty": {
"get": {
"tags": [
"Organizer: Tags"
],
"summary": "Get Empty Tags",
"description": "Returns a list of tags that do not contain any recipes",
"operationId": "get_empty_tags_api_organizers_tags_empty_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/tags/{item_id}": {
"get": {
"tags": [
"Organizer: Tags"
],
"summary": "Get One",
"description": "Returns a list of recipes associated with the provided tag.",
"operationId": "get_one_api_organizers_tags__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Organizer: Tags"
],
"summary": "Update One",
"description": "Updates an existing Tag in the database",
"operationId": "update_one_api_organizers_tags__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagIn"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Organizer: Tags"
],
"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_organizers_tags__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/tags/slug/{tag_slug}": {
"get": {
"tags": [
"Organizer: Tags"
],
"summary": "Get One By Slug",
"operationId": "get_one_by_slug_api_organizers_tags_slug__tag_slug__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "tag_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Tag Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/organizers/tools": {
"get": {
"tags": [
"Organizer: Tools"
],
"summary": "Get All",
"operationId": "get_all_api_organizers_tools_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeToolPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Organizer: Tools"
],
"summary": "Create One",
"operationId": "create_one_api_organizers_tools_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeToolCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTool"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/tools/{item_id}": {
"get": {
"tags": [
"Organizer: Tools"
],
"summary": "Get One",
"operationId": "get_one_api_organizers_tools__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTool"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Organizer: Tools"
],
"summary": "Update One",
"operationId": "update_one_api_organizers_tools__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeToolCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTool"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Organizer: Tools"
],
"summary": "Delete One",
"operationId": "delete_one_api_organizers_tools__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeTool"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/organizers/tools/slug/{tool_slug}": {
"get": {
"tags": [
"Organizer: Tools"
],
"summary": "Get One By Slug",
"operationId": "get_one_by_slug_api_organizers_tools_slug__tool_slug__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "tool_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Tool Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeToolResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/shared/recipes": {
"get": {
"tags": [
"Shared: Recipes"
],
"summary": "Get All",
"operationId": "get_all_api_shared_recipes_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "recipe_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Recipe Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecipeShareTokenSummary"
},
"title": "Response Get All Api Shared Recipes Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Shared: Recipes"
],
"summary": "Create One",
"operationId": "create_one_api_shared_recipes_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeShareTokenCreate"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/shared/recipes/{item_id}": {
"get": {
"tags": [
"Shared: Recipes"
],
"summary": "Get One",
"operationId": "get_one_api_shared_recipes__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Shared: Recipes"
],
"summary": "Delete One",
"operationId": "delete_one_api_shared_recipes__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/comments": {
"get": {
"tags": [
"Recipe: Comments"
],
"summary": "Get All",
"operationId": "get_all_api_comments_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCommentPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Recipe: Comments"
],
"summary": "Create One",
"operationId": "create_one_api_comments_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCommentCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCommentOut-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/comments/{item_id}": {
"get": {
"tags": [
"Recipe: Comments"
],
"summary": "Get One",
"operationId": "get_one_api_comments__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCommentOut-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipe: Comments"
],
"summary": "Update One",
"operationId": "update_one_api_comments__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCommentUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeCommentOut-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Recipe: Comments"
],
"summary": "Delete One",
"operationId": "delete_one_api_comments__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/parser/ingredient": {
"post": {
"tags": [
"Recipe: Ingredient Parser"
],
"summary": "Parse Ingredient",
"operationId": "parse_ingredient_api_parser_ingredient_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientRequest"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/parser/ingredients": {
"post": {
"tags": [
"Recipe: Ingredient Parser"
],
"summary": "Parse Ingredients",
"operationId": "parse_ingredients_api_parser_ingredients_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientsRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParsedIngredient"
},
"title": "Response Parse Ingredients Api Parser Ingredients Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/foods": {
"get": {
"tags": [
"Recipes: Foods"
],
"summary": "Get All",
"operationId": "get_all_api_foods_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientFoodPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Recipes: Foods"
],
"summary": "Create One",
"operationId": "create_one_api_foods_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIngredientFood"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientFood-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/foods/merge": {
"put": {
"tags": [
"Recipes: Foods"
],
"summary": "Merge One",
"operationId": "merge_one_api_foods_merge_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeFood"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/foods/{item_id}": {
"get": {
"tags": [
"Recipes: Foods"
],
"summary": "Get One",
"operationId": "get_one_api_foods__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientFood-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipes: Foods"
],
"summary": "Update One",
"operationId": "update_one_api_foods__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIngredientFood"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientFood-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Recipes: Foods"
],
"summary": "Delete One",
"operationId": "delete_one_api_foods__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientFood-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/units": {
"get": {
"tags": [
"Recipes: Units"
],
"summary": "Get All",
"operationId": "get_all_api_units_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientUnitPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Recipes: Units"
],
"summary": "Create One",
"operationId": "create_one_api_units_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIngredientUnit"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientUnit-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/units/merge": {
"put": {
"tags": [
"Recipes: Units"
],
"summary": "Merge One",
"operationId": "merge_one_api_units_merge_put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeUnit"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/units/{item_id}": {
"get": {
"tags": [
"Recipes: Units"
],
"summary": "Get One",
"operationId": "get_one_api_units__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientUnit-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Recipes: Units"
],
"summary": "Update One",
"operationId": "update_one_api_units__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateIngredientUnit"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientUnit-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Recipes: Units"
],
"summary": "Delete One",
"operationId": "delete_one_api_units__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientUnit-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/about": {
"get": {
"tags": [
"Admin: About"
],
"summary": "Get App Info",
"description": "Get general application information",
"operationId": "get_app_info_api_admin_about_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdminAboutInfo"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/about/statistics": {
"get": {
"tags": [
"Admin: About"
],
"summary": "Get App Statistics",
"operationId": "get_app_statistics_api_admin_about_statistics_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppStatistics"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/about/check": {
"get": {
"tags": [
"Admin: About"
],
"summary": "Check App Config",
"operationId": "check_app_config_api_admin_about_check_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckAppConfig"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/users": {
"get": {
"tags": [
"Admin: Manage Users"
],
"summary": "Get All",
"operationId": "get_all_api_admin_users_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Admin: Manage Users"
],
"summary": "Create One",
"operationId": "create_one_api_admin_users_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserIn"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/admin/users/unlock": {
"post": {
"tags": [
"Admin: Manage Users"
],
"summary": "Unlock Users",
"operationId": "unlock_users_api_admin_users_unlock_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "force",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Force"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockResults"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/users/{item_id}": {
"get": {
"tags": [
"Admin: Manage Users"
],
"summary": "Get One",
"operationId": "get_one_api_admin_users__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Admin: Manage Users"
],
"summary": "Update One",
"operationId": "update_one_api_admin_users__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOut"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Admin: Manage Users"
],
"summary": "Delete One",
"operationId": "delete_one_api_admin_users__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/admin/users/password-reset-token": {
"post": {
"tags": [
"Admin: Manage Users"
],
"summary": "Generate Token",
"description": "Generates a reset token and returns it. This is an authenticated endpoint",
"operationId": "generate_token_api_admin_users_password_reset_token_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForgotPassword"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordResetToken"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/households": {
"get": {
"tags": [
"Admin: Manage Households"
],
"summary": "Get All",
"operationId": "get_all_api_admin_households_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Admin: Manage Households"
],
"summary": "Create One",
"operationId": "create_one_api_admin_households_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdInDB"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/households/{item_id}": {
"get": {
"tags": [
"Admin: Manage Households"
],
"summary": "Get One",
"operationId": "get_one_api_admin_households__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdInDB"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Admin: Manage Households"
],
"summary": "Update One",
"operationId": "update_one_api_admin_households__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateHouseholdAdmin"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdInDB"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Admin: Manage Households"
],
"summary": "Delete One",
"operationId": "delete_one_api_admin_households__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdInDB"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/groups": {
"get": {
"tags": [
"Admin: Manage Groups"
],
"summary": "Get All",
"operationId": "get_all_api_admin_groups_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupPagination"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Admin: Manage Groups"
],
"summary": "Create One",
"operationId": "create_one_api_admin_groups_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupBase"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/admin/groups/{item_id}": {
"get": {
"tags": [
"Admin: Manage Groups"
],
"summary": "Get One",
"operationId": "get_one_api_admin_groups__item_id__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
},
"put": {
"tags": [
"Admin: Manage Groups"
],
"summary": "Update One",
"operationId": "update_one_api_admin_groups__item_id__put",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupAdminUpdate"
}
}
}
},
"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"
}
}
}
}
}
},
"delete": {
"tags": [
"Admin: Manage Groups"
],
"summary": "Delete One",
"operationId": "delete_one_api_admin_groups__item_id__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/admin/email": {
"get": {
"tags": [
"Admin: Email"
],
"summary": "Check Email Config",
"description": "Get general application information",
"operationId": "check_email_config_api_admin_email_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailReady"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Admin: Email"
],
"summary": "Send Test Email",
"operationId": "send_test_email_api_admin_email_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTest"
}
}
}
},
"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"
}
}
}
}
}
}
},
"/api/admin/backups": {
"get": {
"tags": [
"Admin: Backups"
],
"summary": "Get All",
"operationId": "get_all_api_admin_backups_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AllBackups"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Admin: Backups"
],
"summary": "Create One",
"operationId": "create_one_api_admin_backups_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/backups/{file_name}": {
"get": {
"tags": [
"Admin: Backups"
],
"summary": "Get One",
"description": "Returns a token to download a file",
"operationId": "get_one_api_admin_backups__file_name__get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileTokenResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Admin: Backups"
],
"summary": "Delete One",
"operationId": "delete_one_api_admin_backups__file_name__delete",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/backups/upload": {
"post": {
"tags": [
"Admin: Backups"
],
"summary": "Upload One",
"description": "Upload a .zip File to later be imported into Mealie",
"operationId": "upload_one_api_admin_backups_upload_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_one_api_admin_backups_upload_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/backups/{file_name}/restore": {
"post": {
"tags": [
"Admin: Backups"
],
"summary": "Import One",
"operationId": "import_one_api_admin_backups__file_name__restore_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/maintenance": {
"get": {
"tags": [
"Admin: Maintenance"
],
"summary": "Get Maintenance Summary",
"description": "Get the maintenance summary",
"operationId": "get_maintenance_summary_api_admin_maintenance_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/maintenance/storage": {
"get": {
"tags": [
"Admin: Maintenance"
],
"summary": "Get Storage Details",
"operationId": "get_storage_details_api_admin_maintenance_storage_get",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaintenanceStorageDetails"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/maintenance/clean/images": {
"post": {
"tags": [
"Admin: Maintenance"
],
"summary": "Clean Images",
"description": "Purges all the images from the filesystem that aren't .webp",
"operationId": "clean_images_api_admin_maintenance_clean_images_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/maintenance/clean/temp": {
"post": {
"tags": [
"Admin: Maintenance"
],
"summary": "Clean Temp",
"operationId": "clean_temp_api_admin_maintenance_clean_temp_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/maintenance/clean/recipe-folders": {
"post": {
"tags": [
"Admin: Maintenance"
],
"summary": "Clean Recipe Folders",
"description": "Deletes all the recipe folders that don't have names that are valid UUIDs",
"operationId": "clean_recipe_folders_api_admin_maintenance_clean_recipe_folders_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SuccessResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/admin/debug/openai": {
"post": {
"tags": [
"Admin: Debug"
],
"summary": "Debug Openai",
"operationId": "debug_openai_api_admin_debug_openai_post",
"security": [
{
"OAuth2PasswordBearer": []
},
{
"OAuth2PasswordBearer": []
}
],
"parameters": [
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_debug_openai_api_admin_debug_openai_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/foods": {
"get": {
"tags": [
"Explore: Foods"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__foods_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_IngredientFood_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/foods/{item_id}": {
"get": {
"tags": [
"Explore: Foods"
],
"summary": "Get One",
"operationId": "get_one_api_explore_groups__group_slug__foods__item_id__get",
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngredientFood-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/households": {
"get": {
"tags": [
"Explore: Households"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__households_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_HouseholdSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/households/{household_slug}": {
"get": {
"tags": [
"Explore: Households"
],
"summary": "Get Household",
"operationId": "get_household_api_explore_groups__group_slug__households__household_slug__get",
"parameters": [
{
"name": "household_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Household Slug"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HouseholdSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/organizers/categories": {
"get": {
"tags": [
"Explore: Categories"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__organizers_categories_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_RecipeCategory_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/organizers/categories/{item_id}": {
"get": {
"tags": [
"Explore: Categories"
],
"summary": "Get One",
"operationId": "get_one_api_explore_groups__group_slug__organizers_categories__item_id__get",
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CategoryOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/organizers/tags": {
"get": {
"tags": [
"Explore: Tags"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__organizers_tags_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_RecipeTag_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/organizers/tags/{item_id}": {
"get": {
"tags": [
"Explore: Tags"
],
"summary": "Get One",
"operationId": "get_one_api_explore_groups__group_slug__organizers_tags__item_id__get",
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/organizers/tools": {
"get": {
"tags": [
"Explore: Tools"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__organizers_tools_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_RecipeTool_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/organizers/tools/{item_id}": {
"get": {
"tags": [
"Explore: Tools"
],
"summary": "Get One",
"operationId": "get_one_api_explore_groups__group_slug__organizers_tools__item_id__get",
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Item Id"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeToolOut"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/cookbooks": {
"get": {
"tags": [
"Explore: Cookbooks"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__cookbooks_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_ReadCookBook_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/cookbooks/{item_id}": {
"get": {
"tags": [
"Explore: Cookbooks"
],
"summary": "Get One",
"operationId": "get_one_api_explore_groups__group_slug__cookbooks__item_id__get",
"parameters": [
{
"name": "item_id",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
],
"title": "Item Id"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"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"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/recipes": {
"get": {
"tags": [
"Explore: Recipes"
],
"summary": "Get All",
"operationId": "get_all_api_explore_groups__group_slug__recipes_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "categories",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Categories"
}
},
{
"name": "tags",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Tags"
}
},
{
"name": "tools",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Tools"
}
},
{
"name": "foods",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Foods"
}
},
{
"name": "households",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
}
]
}
},
{
"type": "null"
}
],
"title": "Households"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"title": "Page"
}
},
{
"name": "perPage",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"title": "Perpage"
}
},
{
"name": "cookbook",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cookbook"
}
},
{
"name": "requireAllCategories",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requireallcategories"
}
},
{
"name": "requireAllTags",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requirealltags"
}
},
{
"name": "requireAllTools",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requirealltools"
}
},
{
"name": "requireAllFoods",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"title": "Requireallfoods"
}
},
{
"name": "search",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginationBase_RecipeSummary_"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/recipes/suggestions": {
"get": {
"tags": [
"Explore: Recipes"
],
"summary": "Suggest Recipes",
"operationId": "suggest_recipes_api_explore_groups__group_slug__recipes_suggestions_get",
"parameters": [
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "foods",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid4"
}
},
{
"type": "null"
}
],
"title": "Foods"
}
},
{
"name": "tools",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid4"
}
},
{
"type": "null"
}
],
"title": "Tools"
}
},
{
"name": "orderBy",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orderby"
}
},
{
"name": "orderByNullPosition",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderByNullPosition"
},
{
"type": "null"
}
],
"title": "Orderbynullposition"
}
},
{
"name": "orderDirection",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/OrderDirection",
"default": "desc"
}
},
{
"name": "queryFilter",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Queryfilter"
}
},
{
"name": "paginationSeed",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paginationseed"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 10,
"title": "Limit"
}
},
{
"name": "maxMissingFoods",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Maxmissingfoods"
}
},
{
"name": "maxMissingTools",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"default": 5,
"title": "Maxmissingtools"
}
},
{
"name": "includeFoodsOnHand",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Includefoodsonhand"
}
},
{
"name": "includeToolsOnHand",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": true,
"title": "Includetoolsonhand"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecipeSuggestionResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/explore/groups/{group_slug}/recipes/{recipe_slug}": {
"get": {
"tags": [
"Explore: Recipes"
],
"summary": "Get Recipe",
"operationId": "get_recipe_api_explore_groups__group_slug__recipes__recipe_slug__get",
"parameters": [
{
"name": "recipe_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Recipe Slug"
}
},
{
"name": "group_slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Group Slug"
}
},
{
"name": "accept-language",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accept-Language"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recipe-Output"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/media/recipes/{recipe_id}/images/{file_name}": {
"get": {
"tags": [
"Recipe: Images and Assets"
],
"summary": "Get Recipe Img",
"description": "Takes in a recipe id, 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__recipe_id__images__file_name__get",
"parameters": [
{
"name": "recipe_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Recipe Id"
}
},
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/ImageType"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/media/recipes/{recipe_id}/images/timeline/{timeline_event_id}/{file_name}": {
"get": {
"tags": [
"Recipe: Images and Assets"
],
"summary": "Get Recipe Timeline Event Img",
"description": "Takes in a recipe id and event timeline id, returns the static image. This route is proxied in the docker image\nand should not hit the API in production",
"operationId": "get_recipe_timeline_event_img_api_media_recipes__recipe_id__images_timeline__timeline_event_id___file_name__get",
"parameters": [
{
"name": "recipe_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Recipe Id"
}
},
{
"name": "timeline_event_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Timeline Event Id"
}
},
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/ImageType"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/media/recipes/{recipe_id}/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__recipe_id__assets__file_name__get",
"parameters": [
{
"name": "recipe_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "Recipe Id"
}
},
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
}
],
"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": [
{
"name": "user_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid4",
"title": "User Id"
}
},
{
"name": "file_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Name"
}
}
],
"responses": {
"200": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/media/docker/validate.txt": {
"get": {
"tags": [
"Recipe: Images and Assets"
],
"summary": "Get Validation Text",
"operationId": "get_validation_text_api_media_docker_validate_txt_get",
"responses": {
"200": {
"description": "Successful Response"
}
}
}
},
"/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": [
{
"name": "token",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Token"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AdminAboutInfo": {
"properties": {
"production": {
"type": "boolean",
"title": "Production"
},
"version": {
"type": "string",
"title": "Version"
},
"demoStatus": {
"type": "boolean",
"title": "Demostatus"
},
"allowSignup": {
"type": "boolean",
"title": "Allowsignup"
},
"defaultGroupSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Defaultgroupslug"
},
"defaultHouseholdSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Defaulthouseholdslug"
},
"enableOidc": {
"type": "boolean",
"title": "Enableoidc"
},
"oidcRedirect": {
"type": "boolean",
"title": "Oidcredirect"
},
"oidcProviderName": {
"type": "string",
"title": "Oidcprovidername"
},
"enableOpenai": {
"type": "boolean",
"title": "Enableopenai"
},
"enableOpenaiImageServices": {
"type": "boolean",
"title": "Enableopenaiimageservices"
},
"versionLatest": {
"type": "string",
"title": "Versionlatest"
},
"apiPort": {
"type": "integer",
"title": "Apiport"
},
"apiDocs": {
"type": "boolean",
"title": "Apidocs"
},
"dbType": {
"type": "string",
"title": "Dbtype"
},
"dbUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dburl"
},
"defaultGroup": {
"type": "string",
"title": "Defaultgroup"
},
"defaultHousehold": {
"type": "string",
"title": "Defaulthousehold"
},
"buildId": {
"type": "string",
"title": "Buildid"
},
"recipeScraperVersion": {
"type": "string",
"title": "Recipescraperversion"
}
},
"type": "object",
"required": [
"production",
"version",
"demoStatus",
"allowSignup",
"enableOidc",
"oidcRedirect",
"oidcProviderName",
"enableOpenai",
"enableOpenaiImageServices",
"versionLatest",
"apiPort",
"apiDocs",
"dbType",
"defaultGroup",
"defaultHousehold",
"buildId",
"recipeScraperVersion"
],
"title": "AdminAboutInfo"
},
"AllBackups": {
"properties": {
"imports": {
"items": {
"$ref": "#/components/schemas/BackupFile"
},
"type": "array",
"title": "Imports"
},
"templates": {
"items": {
"type": "string"
},
"type": "array",
"title": "Templates"
}
},
"type": "object",
"required": [
"imports",
"templates"
],
"title": "AllBackups"
},
"AppInfo": {
"properties": {
"production": {
"type": "boolean",
"title": "Production"
},
"version": {
"type": "string",
"title": "Version"
},
"demoStatus": {
"type": "boolean",
"title": "Demostatus"
},
"allowSignup": {
"type": "boolean",
"title": "Allowsignup"
},
"defaultGroupSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Defaultgroupslug"
},
"defaultHouseholdSlug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Defaulthouseholdslug"
},
"enableOidc": {
"type": "boolean",
"title": "Enableoidc"
},
"oidcRedirect": {
"type": "boolean",
"title": "Oidcredirect"
},
"oidcProviderName": {
"type": "string",
"title": "Oidcprovidername"
},
"enableOpenai": {
"type": "boolean",
"title": "Enableopenai"
},
"enableOpenaiImageServices": {
"type": "boolean",
"title": "Enableopenaiimageservices"
}
},
"type": "object",
"required": [
"production",
"version",
"demoStatus",
"allowSignup",
"enableOidc",
"oidcRedirect",
"oidcProviderName",
"enableOpenai",
"enableOpenaiImageServices"
],
"title": "AppInfo"
},
"AppStartupInfo": {
"properties": {
"isFirstLogin": {
"type": "boolean",
"title": "Isfirstlogin"
},
"isDemo": {
"type": "boolean",
"title": "Isdemo"
}
},
"type": "object",
"required": [
"isFirstLogin",
"isDemo"
],
"title": "AppStartupInfo"
},
"AppStatistics": {
"properties": {
"totalRecipes": {
"type": "integer",
"title": "Totalrecipes"
},
"totalUsers": {
"type": "integer",
"title": "Totalusers"
},
"totalHouseholds": {
"type": "integer",
"title": "Totalhouseholds"
},
"totalGroups": {
"type": "integer",
"title": "Totalgroups"
},
"uncategorizedRecipes": {
"type": "integer",
"title": "Uncategorizedrecipes"
},
"untaggedRecipes": {
"type": "integer",
"title": "Untaggedrecipes"
}
},
"type": "object",
"required": [
"totalRecipes",
"totalUsers",
"totalHouseholds",
"totalGroups",
"uncategorizedRecipes",
"untaggedRecipes"
],
"title": "AppStatistics"
},
"AppTheme": {
"properties": {
"lightPrimary": {
"type": "string",
"title": "Lightprimary",
"default": "#E58325"
},
"lightAccent": {
"type": "string",
"title": "Lightaccent",
"default": "#007A99"
},
"lightSecondary": {
"type": "string",
"title": "Lightsecondary",
"default": "#973542"
},
"lightSuccess": {
"type": "string",
"title": "Lightsuccess",
"default": "#43A047"
},
"lightInfo": {
"type": "string",
"title": "Lightinfo",
"default": "#1976D2"
},
"lightWarning": {
"type": "string",
"title": "Lightwarning",
"default": "#FF6D00"
},
"lightError": {
"type": "string",
"title": "Lighterror",
"default": "#EF5350"
},
"darkPrimary": {
"type": "string",
"title": "Darkprimary",
"default": "#E58325"
},
"darkAccent": {
"type": "string",
"title": "Darkaccent",
"default": "#007A99"
},
"darkSecondary": {
"type": "string",
"title": "Darksecondary",
"default": "#973542"
},
"darkSuccess": {
"type": "string",
"title": "Darksuccess",
"default": "#43A047"
},
"darkInfo": {
"type": "string",
"title": "Darkinfo",
"default": "#1976D2"
},
"darkWarning": {
"type": "string",
"title": "Darkwarning",
"default": "#FF6D00"
},
"darkError": {
"type": "string",
"title": "Darkerror",
"default": "#EF5350"
}
},
"type": "object",
"title": "AppTheme"
},
"AssignCategories": {
"properties": {
"recipes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Recipes"
},
"categories": {
"items": {
"$ref": "#/components/schemas/CategoryBase"
},
"type": "array",
"title": "Categories"
}
},
"type": "object",
"required": [
"recipes",
"categories"
],
"title": "AssignCategories"
},
"AssignSettings": {
"properties": {
"recipes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Recipes"
},
"settings": {
"$ref": "#/components/schemas/RecipeSettings"
}
},
"type": "object",
"required": [
"recipes",
"settings"
],
"title": "AssignSettings"
},
"AssignTags": {
"properties": {
"recipes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Recipes"
},
"tags": {
"items": {
"$ref": "#/components/schemas/TagBase"
},
"type": "array",
"title": "Tags"
}
},
"type": "object",
"required": [
"recipes",
"tags"
],
"title": "AssignTags"
},
"AuthMethod": {
"type": "string",
"enum": [
"Mealie",
"LDAP",
"OIDC"
],
"title": "AuthMethod"
},
"BackupFile": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"date": {
"type": "string",
"format": "date-time",
"title": "Date"
},
"size": {
"type": "string",
"title": "Size"
}
},
"type": "object",
"required": [
"name",
"date",
"size"
],
"title": "BackupFile"
},
"Body_create_recipe_from_image_api_recipes_create_image_post": {
"properties": {
"images": {
"items": {
"type": "string",
"format": "binary"
},
"type": "array",
"title": "Images"
}
},
"type": "object",
"required": [
"images"
],
"title": "Body_create_recipe_from_image_api_recipes_create_image_post"
},
"Body_create_recipe_from_zip_api_recipes_create_zip_post": {
"properties": {
"archive": {
"type": "string",
"format": "binary",
"title": "Archive"
}
},
"type": "object",
"required": [
"archive"
],
"title": "Body_create_recipe_from_zip_api_recipes_create_zip_post"
},
"Body_debug_openai_api_admin_debug_openai_post": {
"properties": {
"image": {
"anyOf": [
{
"type": "string",
"format": "binary"
},
{
"type": "null"
}
],
"title": "Image"
}
},
"type": "object",
"title": "Body_debug_openai_api_admin_debug_openai_post"
},
"Body_get_token_api_auth_token_post": {
"properties": {
"username": {
"type": "string",
"title": "Username",
"default": ""
},
"password": {
"type": "string",
"title": "Password",
"default": ""
},
"remember_me": {
"type": "boolean",
"title": "Remember Me",
"default": false
}
},
"type": "object",
"title": "Body_get_token_api_auth_token_post"
},
"Body_start_data_migration_api_groups_migrations_post": {
"properties": {
"add_migration_tag": {
"type": "boolean",
"title": "Add Migration Tag",
"default": false
},
"migration_type": {
"$ref": "#/components/schemas/SupportedMigrations"
},
"archive": {
"type": "string",
"format": "binary",
"title": "Archive"
}
},
"type": "object",
"required": [
"migration_type",
"archive"
],
"title": "Body_start_data_migration_api_groups_migrations_post"
},
"Body_update_event_image_api_recipes_timeline_events__item_id__image_put": {
"properties": {
"image": {
"type": "string",
"format": "binary",
"title": "Image"
},
"extension": {
"type": "string",
"title": "Extension"
}
},
"type": "object",
"required": [
"image",
"extension"
],
"title": "Body_update_event_image_api_recipes_timeline_events__item_id__image_put"
},
"Body_update_recipe_image_api_recipes__slug__image_put": {
"properties": {
"image": {
"type": "string",
"format": "binary",
"title": "Image"
},
"extension": {
"type": "string",
"title": "Extension"
}
},
"type": "object",
"required": [
"image",
"extension"
],
"title": "Body_update_recipe_image_api_recipes__slug__image_put"
},
"Body_update_user_image_api_users__id__image_post": {
"properties": {
"profile": {
"type": "string",
"format": "binary",
"title": "Profile"
}
},
"type": "object",
"required": [
"profile"
],
"title": "Body_update_user_image_api_users__id__image_post"
},
"Body_upload_one_api_admin_backups_upload_post": {
"properties": {
"archive": {
"type": "string",
"format": "binary",
"title": "Archive"
}
},
"type": "object",
"required": [
"archive"
],
"title": "Body_upload_one_api_admin_backups_upload_post"
},
"Body_upload_recipe_asset_api_recipes__slug__assets_post": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"icon": {
"type": "string",
"title": "Icon"
},
"extension": {
"type": "string",
"title": "Extension"
},
"file": {
"type": "string",
"format": "binary",
"title": "File"
}
},
"type": "object",
"required": [
"name",
"icon",
"extension",
"file"
],
"title": "Body_upload_recipe_asset_api_recipes__slug__assets_post"
},
"CategoryBase": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "CategoryBase"
},
"CategoryIn": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "CategoryIn"
},
"CategoryOut": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
}
},
"type": "object",
"required": [
"name",
"id",
"slug",
"groupId"
],
"title": "CategoryOut"
},
"CategorySummary": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"id",
"slug",
"name"
],
"title": "CategorySummary"
},
"ChangePassword": {
"properties": {
"currentPassword": {
"type": "string",
"title": "Currentpassword",
"default": ""
},
"newPassword": {
"type": "string",
"minLength": 8,
"title": "Newpassword"
}
},
"type": "object",
"required": [
"newPassword"
],
"title": "ChangePassword"
},
"CheckAppConfig": {
"properties": {
"emailReady": {
"type": "boolean",
"title": "Emailready"
},
"ldapReady": {
"type": "boolean",
"title": "Ldapready"
},
"oidcReady": {
"type": "boolean",
"title": "Oidcready"
},
"enableOpenai": {
"type": "boolean",
"title": "Enableopenai"
},
"baseUrlSet": {
"type": "boolean",
"title": "Baseurlset"
},
"isUpToDate": {
"type": "boolean",
"title": "Isuptodate"
}
},
"type": "object",
"required": [
"emailReady",
"ldapReady",
"oidcReady",
"enableOpenai",
"baseUrlSet",
"isUpToDate"
],
"title": "CheckAppConfig"
},
"CookBookPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/ReadCookBook"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "CookBookPagination"
},
"CreateCookBook": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug"
},
"position": {
"type": "integer",
"title": "Position",
"default": 1
},
"public": {
"type": "boolean",
"title": "Public",
"default": false
},
"queryFilterString": {
"type": "string",
"title": "Queryfilterstring",
"default": ""
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateCookBook"
},
"CreateGroupRecipeAction": {
"properties": {
"actionType": {
"$ref": "#/components/schemas/GroupRecipeActionType"
},
"title": {
"type": "string",
"title": "Title"
},
"url": {
"type": "string",
"title": "Url"
}
},
"type": "object",
"required": [
"actionType",
"title",
"url"
],
"title": "CreateGroupRecipeAction"
},
"CreateIngredientFood": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"pluralName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralname"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"aliases": {
"items": {
"$ref": "#/components/schemas/CreateIngredientFoodAlias"
},
"type": "array",
"title": "Aliases",
"default": []
},
"householdsWithIngredientFood": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithingredientfood",
"default": []
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateIngredientFood"
},
"CreateIngredientFoodAlias": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateIngredientFoodAlias"
},
"CreateIngredientUnit": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"pluralName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralname"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"fraction": {
"type": "boolean",
"title": "Fraction",
"default": true
},
"abbreviation": {
"type": "string",
"title": "Abbreviation",
"default": ""
},
"pluralAbbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralabbreviation",
"default": ""
},
"useAbbreviation": {
"type": "boolean",
"title": "Useabbreviation",
"default": false
},
"aliases": {
"items": {
"$ref": "#/components/schemas/CreateIngredientUnitAlias"
},
"type": "array",
"title": "Aliases",
"default": []
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateIngredientUnit"
},
"CreateIngredientUnitAlias": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateIngredientUnitAlias"
},
"CreateInviteToken": {
"properties": {
"uses": {
"type": "integer",
"title": "Uses"
},
"groupId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Groupid"
},
"householdId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Householdid"
}
},
"type": "object",
"required": [
"uses"
],
"title": "CreateInviteToken"
},
"CreatePlanEntry": {
"properties": {
"date": {
"type": "string",
"format": "date",
"title": "Date"
},
"entryType": {
"$ref": "#/components/schemas/PlanEntryType",
"default": "breakfast"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"text": {
"type": "string",
"title": "Text",
"default": ""
},
"recipeId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Recipeid"
}
},
"type": "object",
"required": [
"date"
],
"title": "CreatePlanEntry"
},
"CreateRandomEntry": {
"properties": {
"date": {
"type": "string",
"format": "date",
"title": "Date"
},
"entryType": {
"$ref": "#/components/schemas/PlanEntryType",
"default": "dinner"
}
},
"type": "object",
"required": [
"date"
],
"title": "CreateRandomEntry"
},
"CreateRecipe": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateRecipe"
},
"CreateRecipeBulk": {
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"categories": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeCategory"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Categories"
},
"tags": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeTag"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags"
}
},
"type": "object",
"required": [
"url"
],
"title": "CreateRecipeBulk"
},
"CreateRecipeByUrlBulk": {
"properties": {
"imports": {
"items": {
"$ref": "#/components/schemas/CreateRecipeBulk"
},
"type": "array",
"title": "Imports"
}
},
"type": "object",
"required": [
"imports"
],
"title": "CreateRecipeByUrlBulk"
},
"CreateUserRegistration": {
"properties": {
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group"
},
"household": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Household"
},
"groupToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grouptoken"
},
"email": {
"type": "string",
"title": "Email"
},
"username": {
"type": "string",
"title": "Username"
},
"fullName": {
"type": "string",
"title": "Fullname"
},
"password": {
"type": "string",
"title": "Password"
},
"passwordConfirm": {
"type": "string",
"title": "Passwordconfirm"
},
"advanced": {
"type": "boolean",
"title": "Advanced",
"default": false
},
"private": {
"type": "boolean",
"title": "Private",
"default": false
},
"seedData": {
"type": "boolean",
"title": "Seeddata",
"default": false
},
"locale": {
"type": "string",
"title": "Locale",
"default": "en-US"
}
},
"type": "object",
"required": [
"email",
"username",
"fullName",
"password",
"passwordConfirm"
],
"title": "CreateUserRegistration"
},
"CreateWebhook": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
},
"name": {
"type": "string",
"title": "Name",
"default": ""
},
"url": {
"type": "string",
"title": "Url",
"default": ""
},
"webhookType": {
"$ref": "#/components/schemas/WebhookType",
"default": "mealplan"
},
"scheduledTime": {
"type": "string",
"format": "time",
"title": "Scheduledtime"
}
},
"type": "object",
"required": [
"scheduledTime"
],
"title": "CreateWebhook"
},
"DebugResponse": {
"properties": {
"success": {
"type": "boolean",
"title": "Success"
},
"response": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Response"
}
},
"type": "object",
"required": [
"success"
],
"title": "DebugResponse"
},
"DeleteRecipes": {
"properties": {
"recipes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Recipes"
}
},
"type": "object",
"required": [
"recipes"
],
"title": "DeleteRecipes"
},
"DeleteTokenResponse": {
"properties": {
"tokenDelete": {
"type": "string",
"title": "Tokendelete"
}
},
"type": "object",
"required": [
"tokenDelete"
],
"title": "DeleteTokenResponse"
},
"EmailInitationResponse": {
"properties": {
"success": {
"type": "boolean",
"title": "Success"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"type": "object",
"required": [
"success"
],
"title": "EmailInitationResponse"
},
"EmailInvitation": {
"properties": {
"email": {
"type": "string",
"title": "Email"
},
"token": {
"type": "string",
"title": "Token"
}
},
"type": "object",
"required": [
"email",
"token"
],
"title": "EmailInvitation"
},
"EmailReady": {
"properties": {
"ready": {
"type": "boolean",
"title": "Ready"
}
},
"type": "object",
"required": [
"ready"
],
"title": "EmailReady"
},
"EmailSuccess": {
"properties": {
"success": {
"type": "boolean",
"title": "Success"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"type": "object",
"required": [
"success"
],
"title": "EmailSuccess"
},
"EmailTest": {
"properties": {
"email": {
"type": "string",
"title": "Email"
}
},
"type": "object",
"required": [
"email"
],
"title": "EmailTest"
},
"ExportRecipes": {
"properties": {
"recipes": {
"items": {
"type": "string"
},
"type": "array",
"title": "Recipes"
},
"exportType": {
"$ref": "#/components/schemas/ExportTypes",
"default": "json"
}
},
"type": "object",
"required": [
"recipes"
],
"title": "ExportRecipes"
},
"ExportTypes": {
"type": "string",
"enum": [
"json"
],
"title": "ExportTypes"
},
"FileTokenResponse": {
"properties": {
"fileToken": {
"type": "string",
"title": "Filetoken"
}
},
"type": "object",
"required": [
"fileToken"
],
"title": "FileTokenResponse"
},
"ForgotPassword": {
"properties": {
"email": {
"type": "string",
"title": "Email"
}
},
"type": "object",
"required": [
"email"
],
"title": "ForgotPassword"
},
"FormatResponse": {
"properties": {
"json": {
"items": {
"type": "string"
},
"type": "array",
"title": "Json"
},
"zip": {
"items": {
"type": "string"
},
"type": "array",
"title": "Zip"
},
"jinja2": {
"items": {
"type": "string"
},
"type": "array",
"title": "Jinja2"
}
},
"type": "object",
"required": [
"json",
"zip",
"jinja2"
],
"title": "FormatResponse"
},
"GroupAdminUpdate": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"preferences": {
"anyOf": [
{
"$ref": "#/components/schemas/UpdateGroupPreferences"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "GroupAdminUpdate"
},
"GroupBase": {
"properties": {
"name": {
"type": "string",
"minLength": 1,
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "GroupBase"
},
"GroupDataExport": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"type": "string",
"title": "Name"
},
"filename": {
"type": "string",
"title": "Filename"
},
"path": {
"type": "string",
"title": "Path"
},
"size": {
"type": "string",
"title": "Size"
},
"expires": {
"type": "string",
"format": "date-time",
"title": "Expires"
}
},
"type": "object",
"required": [
"id",
"groupId",
"name",
"filename",
"path",
"size",
"expires"
],
"title": "GroupDataExport"
},
"GroupEventNotifierCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"appriseUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Appriseurl"
}
},
"type": "object",
"required": [
"name"
],
"title": "GroupEventNotifierCreate"
},
"GroupEventNotifierOptions": {
"properties": {
"testMessage": {
"type": "boolean",
"title": "Testmessage",
"default": false
},
"webhookTask": {
"type": "boolean",
"title": "Webhooktask",
"default": false
},
"recipeCreated": {
"type": "boolean",
"title": "Recipecreated",
"default": false
},
"recipeUpdated": {
"type": "boolean",
"title": "Recipeupdated",
"default": false
},
"recipeDeleted": {
"type": "boolean",
"title": "Recipedeleted",
"default": false
},
"userSignup": {
"type": "boolean",
"title": "Usersignup",
"default": false
},
"dataMigrations": {
"type": "boolean",
"title": "Datamigrations",
"default": false
},
"dataExport": {
"type": "boolean",
"title": "Dataexport",
"default": false
},
"dataImport": {
"type": "boolean",
"title": "Dataimport",
"default": false
},
"mealplanEntryCreated": {
"type": "boolean",
"title": "Mealplanentrycreated",
"default": false
},
"shoppingListCreated": {
"type": "boolean",
"title": "Shoppinglistcreated",
"default": false
},
"shoppingListUpdated": {
"type": "boolean",
"title": "Shoppinglistupdated",
"default": false
},
"shoppingListDeleted": {
"type": "boolean",
"title": "Shoppinglistdeleted",
"default": false
},
"cookbookCreated": {
"type": "boolean",
"title": "Cookbookcreated",
"default": false
},
"cookbookUpdated": {
"type": "boolean",
"title": "Cookbookupdated",
"default": false
},
"cookbookDeleted": {
"type": "boolean",
"title": "Cookbookdeleted",
"default": false
},
"tagCreated": {
"type": "boolean",
"title": "Tagcreated",
"default": false
},
"tagUpdated": {
"type": "boolean",
"title": "Tagupdated",
"default": false
},
"tagDeleted": {
"type": "boolean",
"title": "Tagdeleted",
"default": false
},
"categoryCreated": {
"type": "boolean",
"title": "Categorycreated",
"default": false
},
"categoryUpdated": {
"type": "boolean",
"title": "Categoryupdated",
"default": false
},
"categoryDeleted": {
"type": "boolean",
"title": "Categorydeleted",
"default": false
}
},
"type": "object",
"title": "GroupEventNotifierOptions",
"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": {
"properties": {
"testMessage": {
"type": "boolean",
"title": "Testmessage",
"default": false
},
"webhookTask": {
"type": "boolean",
"title": "Webhooktask",
"default": false
},
"recipeCreated": {
"type": "boolean",
"title": "Recipecreated",
"default": false
},
"recipeUpdated": {
"type": "boolean",
"title": "Recipeupdated",
"default": false
},
"recipeDeleted": {
"type": "boolean",
"title": "Recipedeleted",
"default": false
},
"userSignup": {
"type": "boolean",
"title": "Usersignup",
"default": false
},
"dataMigrations": {
"type": "boolean",
"title": "Datamigrations",
"default": false
},
"dataExport": {
"type": "boolean",
"title": "Dataexport",
"default": false
},
"dataImport": {
"type": "boolean",
"title": "Dataimport",
"default": false
},
"mealplanEntryCreated": {
"type": "boolean",
"title": "Mealplanentrycreated",
"default": false
},
"shoppingListCreated": {
"type": "boolean",
"title": "Shoppinglistcreated",
"default": false
},
"shoppingListUpdated": {
"type": "boolean",
"title": "Shoppinglistupdated",
"default": false
},
"shoppingListDeleted": {
"type": "boolean",
"title": "Shoppinglistdeleted",
"default": false
},
"cookbookCreated": {
"type": "boolean",
"title": "Cookbookcreated",
"default": false
},
"cookbookUpdated": {
"type": "boolean",
"title": "Cookbookupdated",
"default": false
},
"cookbookDeleted": {
"type": "boolean",
"title": "Cookbookdeleted",
"default": false
},
"tagCreated": {
"type": "boolean",
"title": "Tagcreated",
"default": false
},
"tagUpdated": {
"type": "boolean",
"title": "Tagupdated",
"default": false
},
"tagDeleted": {
"type": "boolean",
"title": "Tagdeleted",
"default": false
},
"categoryCreated": {
"type": "boolean",
"title": "Categorycreated",
"default": false
},
"categoryUpdated": {
"type": "boolean",
"title": "Categoryupdated",
"default": false
},
"categoryDeleted": {
"type": "boolean",
"title": "Categorydeleted",
"default": false
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "GroupEventNotifierOptionsOut"
},
"GroupEventNotifierOut": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"enabled": {
"type": "boolean",
"title": "Enabled"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"options": {
"$ref": "#/components/schemas/GroupEventNotifierOptionsOut"
}
},
"type": "object",
"required": [
"id",
"name",
"enabled",
"groupId",
"householdId",
"options"
],
"title": "GroupEventNotifierOut"
},
"GroupEventNotifierUpdate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"appriseUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Appriseurl"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"options": {
"$ref": "#/components/schemas/GroupEventNotifierOptions",
"default": {
"testMessage": false,
"webhookTask": false,
"recipeCreated": false,
"recipeUpdated": false,
"recipeDeleted": false,
"userSignup": false,
"dataMigrations": false,
"dataExport": false,
"dataImport": false,
"mealplanEntryCreated": false,
"shoppingListCreated": false,
"shoppingListUpdated": false,
"shoppingListDeleted": false,
"cookbookCreated": false,
"cookbookUpdated": false,
"cookbookDeleted": false,
"tagCreated": false,
"tagUpdated": false,
"tagDeleted": false,
"categoryCreated": false,
"categoryUpdated": false,
"categoryDeleted": false
}
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"name",
"groupId",
"householdId",
"id"
],
"title": "GroupEventNotifierUpdate"
},
"GroupEventPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/GroupEventNotifierOut"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "GroupEventPagination"
},
"GroupHouseholdSummary": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "GroupHouseholdSummary"
},
"GroupInDB": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"categories": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/CategoryBase"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Categories",
"default": []
},
"webhooks": {
"items": {
"$ref": "#/components/schemas/ReadWebhook"
},
"type": "array",
"title": "Webhooks",
"default": []
},
"households": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/GroupHouseholdSummary"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Households"
},
"users": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/UserSummary"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Users"
},
"preferences": {
"anyOf": [
{
"$ref": "#/components/schemas/ReadGroupPreferences"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "GroupInDB"
},
"GroupPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/GroupInDB"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "GroupPagination"
},
"GroupRecipeActionOut": {
"properties": {
"actionType": {
"$ref": "#/components/schemas/GroupRecipeActionType"
},
"title": {
"type": "string",
"title": "Title"
},
"url": {
"type": "string",
"title": "Url"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"actionType",
"title",
"url",
"groupId",
"householdId",
"id"
],
"title": "GroupRecipeActionOut"
},
"GroupRecipeActionPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/GroupRecipeActionOut"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "GroupRecipeActionPagination"
},
"GroupRecipeActionType": {
"type": "string",
"enum": [
"link",
"post"
],
"title": "GroupRecipeActionType"
},
"GroupStorage": {
"properties": {
"usedStorageBytes": {
"type": "integer",
"title": "Usedstoragebytes"
},
"usedStorageStr": {
"type": "string",
"title": "Usedstoragestr"
},
"totalStorageBytes": {
"type": "integer",
"title": "Totalstoragebytes"
},
"totalStorageStr": {
"type": "string",
"title": "Totalstoragestr"
}
},
"type": "object",
"required": [
"usedStorageBytes",
"usedStorageStr",
"totalStorageBytes",
"totalStorageStr"
],
"title": "GroupStorage"
},
"GroupSummary": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"preferences": {
"anyOf": [
{
"$ref": "#/components/schemas/ReadGroupPreferences"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "GroupSummary"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HouseholdCreate": {
"properties": {
"groupId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Groupid"
},
"name": {
"type": "string",
"minLength": 1,
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "HouseholdCreate"
},
"HouseholdInDB": {
"properties": {
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"type": "string",
"minLength": 1,
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"preferences": {
"anyOf": [
{
"$ref": "#/components/schemas/ReadHouseholdPreferences"
},
{
"type": "null"
}
]
},
"group": {
"type": "string",
"title": "Group"
},
"users": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/HouseholdUserSummary"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Users"
},
"webhooks": {
"items": {
"$ref": "#/components/schemas/ReadWebhook"
},
"type": "array",
"title": "Webhooks",
"default": []
}
},
"type": "object",
"required": [
"groupId",
"name",
"id",
"slug",
"group"
],
"title": "HouseholdInDB"
},
"HouseholdPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/HouseholdInDB"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "HouseholdPagination"
},
"HouseholdRecipeSummary": {
"properties": {
"lastMade": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Lastmade"
},
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
}
},
"type": "object",
"required": [
"recipeId"
],
"title": "HouseholdRecipeSummary"
},
"HouseholdStatistics": {
"properties": {
"totalRecipes": {
"type": "integer",
"title": "Totalrecipes"
},
"totalUsers": {
"type": "integer",
"title": "Totalusers"
},
"totalCategories": {
"type": "integer",
"title": "Totalcategories"
},
"totalTags": {
"type": "integer",
"title": "Totaltags"
},
"totalTools": {
"type": "integer",
"title": "Totaltools"
}
},
"type": "object",
"required": [
"totalRecipes",
"totalUsers",
"totalCategories",
"totalTags",
"totalTools"
],
"title": "HouseholdStatistics"
},
"HouseholdSummary": {
"properties": {
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"type": "string",
"minLength": 1,
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"preferences": {
"anyOf": [
{
"$ref": "#/components/schemas/ReadHouseholdPreferences"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"groupId",
"name",
"id",
"slug"
],
"title": "HouseholdSummary"
},
"HouseholdUserSummary": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"fullName": {
"type": "string",
"title": "Fullname"
}
},
"type": "object",
"required": [
"id",
"fullName"
],
"title": "HouseholdUserSummary"
},
"ImageType": {
"type": "string",
"enum": [
"original.webp",
"min-original.webp",
"tiny-original.webp"
],
"title": "ImageType"
},
"IngredientConfidence": {
"properties": {
"average": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Average"
},
"comment": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Comment"
},
"name": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Name"
},
"unit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Unit"
},
"quantity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quantity"
},
"food": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Food"
}
},
"type": "object",
"title": "IngredientConfidence"
},
"IngredientFood-Input": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"pluralName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralname"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"aliases": {
"items": {
"$ref": "#/components/schemas/IngredientFoodAlias"
},
"type": "array",
"title": "Aliases",
"default": []
},
"householdsWithIngredientFood": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithingredientfood",
"default": []
},
"label": {
"anyOf": [
{
"$ref": "#/components/schemas/MultiPurposeLabelSummary"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"update_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Update At"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "IngredientFood"
},
"IngredientFood-Output": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"pluralName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralname"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"aliases": {
"items": {
"$ref": "#/components/schemas/IngredientFoodAlias"
},
"type": "array",
"title": "Aliases",
"default": []
},
"householdsWithIngredientFood": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithingredientfood",
"default": []
},
"label": {
"anyOf": [
{
"$ref": "#/components/schemas/MultiPurposeLabelSummary"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "IngredientFood"
},
"IngredientFoodAlias": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "IngredientFoodAlias"
},
"IngredientFoodPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/IngredientFood-Output"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "IngredientFoodPagination"
},
"IngredientReferences": {
"properties": {
"referenceId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Referenceid"
}
},
"type": "object",
"title": "IngredientReferences",
"description": "A list of ingredient references."
},
"IngredientRequest": {
"properties": {
"parser": {
"$ref": "#/components/schemas/RegisteredParser",
"default": "nlp"
},
"ingredient": {
"type": "string",
"title": "Ingredient"
}
},
"type": "object",
"required": [
"ingredient"
],
"title": "IngredientRequest"
},
"IngredientUnit-Input": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"pluralName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralname"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"fraction": {
"type": "boolean",
"title": "Fraction",
"default": true
},
"abbreviation": {
"type": "string",
"title": "Abbreviation",
"default": ""
},
"pluralAbbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralabbreviation",
"default": ""
},
"useAbbreviation": {
"type": "boolean",
"title": "Useabbreviation",
"default": false
},
"aliases": {
"items": {
"$ref": "#/components/schemas/IngredientUnitAlias"
},
"type": "array",
"title": "Aliases",
"default": []
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"update_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Update At"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "IngredientUnit"
},
"IngredientUnit-Output": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"pluralName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralname"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"fraction": {
"type": "boolean",
"title": "Fraction",
"default": true
},
"abbreviation": {
"type": "string",
"title": "Abbreviation",
"default": ""
},
"pluralAbbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pluralabbreviation",
"default": ""
},
"useAbbreviation": {
"type": "boolean",
"title": "Useabbreviation",
"default": false
},
"aliases": {
"items": {
"$ref": "#/components/schemas/IngredientUnitAlias"
},
"type": "array",
"title": "Aliases",
"default": []
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "IngredientUnit"
},
"IngredientUnitAlias": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "IngredientUnitAlias"
},
"IngredientUnitPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/IngredientUnit-Output"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "IngredientUnitPagination"
},
"IngredientsRequest": {
"properties": {
"parser": {
"$ref": "#/components/schemas/RegisteredParser",
"default": "nlp"
},
"ingredients": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ingredients"
}
},
"type": "object",
"required": [
"ingredients"
],
"title": "IngredientsRequest"
},
"LogicalOperator": {
"type": "string",
"enum": [
"AND",
"OR"
],
"title": "LogicalOperator"
},
"LongLiveTokenCreateResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "integer",
"title": "Id"
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"token": {
"type": "string",
"title": "Token"
}
},
"type": "object",
"required": [
"name",
"id",
"token"
],
"title": "LongLiveTokenCreateResponse",
"description": "Should ONLY be used when creating a new token, as the token field is sensitive"
},
"LongLiveTokenIn": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"integrationId": {
"type": "string",
"title": "Integrationid",
"default": "generic"
}
},
"type": "object",
"required": [
"name"
],
"title": "LongLiveTokenIn"
},
"LongLiveTokenOut": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "integer",
"title": "Id"
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
}
},
"type": "object",
"required": [
"name",
"id"
],
"title": "LongLiveTokenOut"
},
"MaintenanceStorageDetails": {
"properties": {
"tempDirSize": {
"type": "string",
"title": "Tempdirsize"
},
"backupsDirSize": {
"type": "string",
"title": "Backupsdirsize"
},
"groupsDirSize": {
"type": "string",
"title": "Groupsdirsize"
},
"recipesDirSize": {
"type": "string",
"title": "Recipesdirsize"
},
"userDirSize": {
"type": "string",
"title": "Userdirsize"
}
},
"type": "object",
"required": [
"tempDirSize",
"backupsDirSize",
"groupsDirSize",
"recipesDirSize",
"userDirSize"
],
"title": "MaintenanceStorageDetails"
},
"MaintenanceSummary": {
"properties": {
"dataDirSize": {
"type": "string",
"title": "Datadirsize"
},
"cleanableImages": {
"type": "integer",
"title": "Cleanableimages"
},
"cleanableDirs": {
"type": "integer",
"title": "Cleanabledirs"
}
},
"type": "object",
"required": [
"dataDirSize",
"cleanableImages",
"cleanableDirs"
],
"title": "MaintenanceSummary"
},
"MergeFood": {
"properties": {
"fromFood": {
"type": "string",
"format": "uuid4",
"title": "Fromfood"
},
"toFood": {
"type": "string",
"format": "uuid4",
"title": "Tofood"
}
},
"type": "object",
"required": [
"fromFood",
"toFood"
],
"title": "MergeFood"
},
"MergeUnit": {
"properties": {
"fromUnit": {
"type": "string",
"format": "uuid4",
"title": "Fromunit"
},
"toUnit": {
"type": "string",
"format": "uuid4",
"title": "Tounit"
}
},
"type": "object",
"required": [
"fromUnit",
"toUnit"
],
"title": "MergeUnit"
},
"MultiPurposeLabelCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"color": {
"type": "string",
"title": "Color",
"default": "#959595"
}
},
"type": "object",
"required": [
"name"
],
"title": "MultiPurposeLabelCreate"
},
"MultiPurposeLabelOut": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"color": {
"type": "string",
"title": "Color",
"default": "#959595"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"name",
"groupId",
"id"
],
"title": "MultiPurposeLabelOut"
},
"MultiPurposeLabelPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/MultiPurposeLabelSummary"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "MultiPurposeLabelPagination"
},
"MultiPurposeLabelSummary": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"color": {
"type": "string",
"title": "Color",
"default": "#959595"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"name",
"groupId",
"id"
],
"title": "MultiPurposeLabelSummary"
},
"MultiPurposeLabelUpdate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"color": {
"type": "string",
"title": "Color",
"default": "#959595"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"name",
"groupId",
"id"
],
"title": "MultiPurposeLabelUpdate"
},
"Nutrition": {
"properties": {
"calories": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Calories"
},
"carbohydrateContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Carbohydratecontent"
},
"cholesterolContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cholesterolcontent"
},
"fatContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fatcontent"
},
"fiberContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fibercontent"
},
"proteinContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Proteincontent"
},
"saturatedFatContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Saturatedfatcontent"
},
"sodiumContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sodiumcontent"
},
"sugarContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sugarcontent"
},
"transFatContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Transfatcontent"
},
"unsaturatedFatContent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Unsaturatedfatcontent"
}
},
"type": "object",
"title": "Nutrition"
},
"OrderByNullPosition": {
"type": "string",
"enum": [
"first",
"last"
],
"title": "OrderByNullPosition"
},
"OrderDirection": {
"type": "string",
"enum": [
"asc",
"desc"
],
"title": "OrderDirection"
},
"PaginationBase_HouseholdSummary_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/HouseholdSummary"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[HouseholdSummary]"
},
"PaginationBase_IngredientFood_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/IngredientFood-Output"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[IngredientFood]"
},
"PaginationBase_ReadCookBook_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/ReadCookBook"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[ReadCookBook]"
},
"PaginationBase_RecipeCategory_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeCategory"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[RecipeCategory]"
},
"PaginationBase_RecipeSummary_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeSummary"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[RecipeSummary]"
},
"PaginationBase_RecipeTag_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeTag"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[RecipeTag]"
},
"PaginationBase_RecipeTool_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeTool"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[RecipeTool]"
},
"PaginationBase_UserOut_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/UserOut"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[UserOut]"
},
"PaginationBase_UserSummary_": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/UserSummary"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PaginationBase[UserSummary]"
},
"ParsedIngredient": {
"properties": {
"input": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Input"
},
"confidence": {
"$ref": "#/components/schemas/IngredientConfidence",
"default": {}
},
"ingredient": {
"$ref": "#/components/schemas/RecipeIngredient-Output"
}
},
"type": "object",
"required": [
"ingredient"
],
"title": "ParsedIngredient"
},
"PasswordResetToken": {
"properties": {
"token": {
"type": "string",
"title": "Token"
}
},
"type": "object",
"required": [
"token"
],
"title": "PasswordResetToken"
},
"PlanEntryPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/ReadPlanEntry"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PlanEntryPagination"
},
"PlanEntryType": {
"type": "string",
"enum": [
"breakfast",
"lunch",
"dinner",
"side"
],
"title": "PlanEntryType"
},
"PlanRulesCreate": {
"properties": {
"day": {
"$ref": "#/components/schemas/PlanRulesDay",
"default": "unset"
},
"entryType": {
"$ref": "#/components/schemas/PlanRulesType",
"default": "unset"
},
"queryFilterString": {
"type": "string",
"title": "Queryfilterstring",
"default": ""
}
},
"type": "object",
"title": "PlanRulesCreate"
},
"PlanRulesDay": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday",
"unset"
],
"title": "PlanRulesDay"
},
"PlanRulesOut": {
"properties": {
"day": {
"$ref": "#/components/schemas/PlanRulesDay",
"default": "unset"
},
"entryType": {
"$ref": "#/components/schemas/PlanRulesType",
"default": "unset"
},
"queryFilterString": {
"type": "string",
"title": "Queryfilterstring",
"default": ""
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"queryFilter": {
"$ref": "#/components/schemas/QueryFilterJSON"
}
},
"type": "object",
"required": [
"groupId",
"householdId",
"id"
],
"title": "PlanRulesOut"
},
"PlanRulesPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/PlanRulesOut"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "PlanRulesPagination"
},
"PlanRulesType": {
"type": "string",
"enum": [
"breakfast",
"lunch",
"dinner",
"side",
"unset"
],
"title": "PlanRulesType"
},
"QueryFilterJSON": {
"properties": {
"parts": {
"items": {
"$ref": "#/components/schemas/QueryFilterJSONPart"
},
"type": "array",
"title": "Parts",
"default": []
}
},
"type": "object",
"title": "QueryFilterJSON"
},
"QueryFilterJSONPart": {
"properties": {
"leftParenthesis": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Leftparenthesis"
},
"rightParenthesis": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rightparenthesis"
},
"logicalOperator": {
"anyOf": [
{
"$ref": "#/components/schemas/LogicalOperator"
},
{
"type": "null"
}
]
},
"attributeName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Attributename"
},
"relationalOperator": {
"anyOf": [
{
"$ref": "#/components/schemas/RelationalKeyword"
},
{
"$ref": "#/components/schemas/RelationalOperator"
},
{
"type": "null"
}
],
"title": "Relationaloperator"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Value"
}
},
"type": "object",
"title": "QueryFilterJSONPart"
},
"ReadCookBook": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug"
},
"position": {
"type": "integer",
"title": "Position",
"default": 1
},
"public": {
"type": "boolean",
"title": "Public",
"default": false
},
"queryFilterString": {
"type": "string",
"title": "Queryfilterstring",
"default": ""
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"queryFilter": {
"$ref": "#/components/schemas/QueryFilterJSON"
}
},
"type": "object",
"required": [
"name",
"groupId",
"householdId",
"id"
],
"title": "ReadCookBook"
},
"ReadGroupPreferences": {
"properties": {
"privateGroup": {
"type": "boolean",
"title": "Privategroup",
"default": true
},
"groupId": {
"type": "string",
"format": "uuid",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"groupId",
"id"
],
"title": "ReadGroupPreferences"
},
"ReadHouseholdPreferences": {
"properties": {
"privateHousehold": {
"type": "boolean",
"title": "Privatehousehold",
"default": true
},
"lockRecipeEditsFromOtherHouseholds": {
"type": "boolean",
"title": "Lockrecipeeditsfromotherhouseholds",
"default": true
},
"firstDayOfWeek": {
"type": "integer",
"title": "Firstdayofweek",
"default": 0
},
"recipePublic": {
"type": "boolean",
"title": "Recipepublic",
"default": true
},
"recipeShowNutrition": {
"type": "boolean",
"title": "Recipeshownutrition",
"default": false
},
"recipeShowAssets": {
"type": "boolean",
"title": "Recipeshowassets",
"default": false
},
"recipeLandscapeView": {
"type": "boolean",
"title": "Recipelandscapeview",
"default": false
},
"recipeDisableComments": {
"type": "boolean",
"title": "Recipedisablecomments",
"default": false
},
"recipeDisableAmount": {
"type": "boolean",
"title": "Recipedisableamount",
"default": true
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "ReadHouseholdPreferences"
},
"ReadInviteToken": {
"properties": {
"token": {
"type": "string",
"title": "Token"
},
"usesLeft": {
"type": "integer",
"title": "Usesleft"
},
"groupId": {
"type": "string",
"format": "uuid",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid",
"title": "Householdid"
}
},
"type": "object",
"required": [
"token",
"usesLeft",
"groupId",
"householdId"
],
"title": "ReadInviteToken"
},
"ReadPlanEntry": {
"properties": {
"date": {
"type": "string",
"format": "date",
"title": "Date"
},
"entryType": {
"$ref": "#/components/schemas/PlanEntryType",
"default": "breakfast"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"text": {
"type": "string",
"title": "Text",
"default": ""
},
"recipeId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Recipeid"
},
"id": {
"type": "integer",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid",
"title": "Groupid"
},
"userId": {
"type": "string",
"format": "uuid",
"title": "Userid"
},
"householdId": {
"type": "string",
"format": "uuid",
"title": "Householdid"
},
"recipe": {
"anyOf": [
{
"$ref": "#/components/schemas/RecipeSummary"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"date",
"id",
"groupId",
"userId",
"householdId"
],
"title": "ReadPlanEntry"
},
"ReadWebhook": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true
},
"name": {
"type": "string",
"title": "Name",
"default": ""
},
"url": {
"type": "string",
"title": "Url",
"default": ""
},
"webhookType": {
"$ref": "#/components/schemas/WebhookType",
"default": "mealplan"
},
"scheduledTime": {
"type": "string",
"format": "time",
"title": "Scheduledtime"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"scheduledTime",
"groupId",
"householdId",
"id"
],
"title": "ReadWebhook"
},
"Recipe-Input": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug",
"default": ""
},
"image": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Image"
},
"recipeServings": {
"type": "number",
"title": "Recipeservings",
"default": 0
},
"recipeYieldQuantity": {
"type": "number",
"title": "Recipeyieldquantity",
"default": 0
},
"recipeYield": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recipeyield"
},
"totalTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totaltime"
},
"prepTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Preptime"
},
"cookTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cooktime"
},
"performTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Performtime"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": ""
},
"recipeCategory": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeCategory"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipecategory",
"default": []
},
"tags": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeTag"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"default": []
},
"tools": {
"items": {
"$ref": "#/components/schemas/RecipeTool"
},
"type": "array",
"title": "Tools",
"default": []
},
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Rating"
},
"orgURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orgurl"
},
"dateAdded": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Dateadded"
},
"dateUpdated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Dateupdated"
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"update_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Update At"
},
"lastMade": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Lastmade"
},
"recipeIngredient": {
"items": {
"$ref": "#/components/schemas/RecipeIngredient-Input"
},
"type": "array",
"title": "Recipeingredient",
"default": []
},
"recipeInstructions": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeStep"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipeinstructions",
"default": []
},
"nutrition": {
"anyOf": [
{
"$ref": "#/components/schemas/Nutrition"
},
{
"type": "null"
}
]
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/RecipeSettings"
},
{
"type": "null"
}
]
},
"assets": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeAsset"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Assets",
"default": []
},
"notes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeNote"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Notes",
"default": []
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"comments": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeCommentOut-Input"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Comments",
"default": []
}
},
"type": "object",
"title": "Recipe"
},
"Recipe-Output": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug",
"default": ""
},
"image": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Image"
},
"recipeServings": {
"type": "number",
"title": "Recipeservings",
"default": 0
},
"recipeYieldQuantity": {
"type": "number",
"title": "Recipeyieldquantity",
"default": 0
},
"recipeYield": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recipeyield"
},
"totalTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totaltime"
},
"prepTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Preptime"
},
"cookTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cooktime"
},
"performTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Performtime"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": ""
},
"recipeCategory": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeCategory"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipecategory",
"default": []
},
"tags": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeTag"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"default": []
},
"tools": {
"items": {
"$ref": "#/components/schemas/RecipeTool"
},
"type": "array",
"title": "Tools",
"default": []
},
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Rating"
},
"orgURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orgurl"
},
"dateAdded": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Dateadded"
},
"dateUpdated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Dateupdated"
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
},
"lastMade": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Lastmade"
},
"recipeIngredient": {
"items": {
"$ref": "#/components/schemas/RecipeIngredient-Output"
},
"type": "array",
"title": "Recipeingredient",
"default": []
},
"recipeInstructions": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeStep"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipeinstructions",
"default": []
},
"nutrition": {
"anyOf": [
{
"$ref": "#/components/schemas/Nutrition"
},
{
"type": "null"
}
]
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/RecipeSettings"
},
{
"type": "null"
}
]
},
"assets": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeAsset"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Assets",
"default": []
},
"notes": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeNote"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Notes",
"default": []
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"comments": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeCommentOut-Output"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Comments",
"default": []
}
},
"type": "object",
"title": "Recipe"
},
"RecipeAsset": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"icon": {
"type": "string",
"title": "Icon"
},
"fileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filename"
}
},
"type": "object",
"required": [
"name",
"icon"
],
"title": "RecipeAsset"
},
"RecipeCategory": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug"
}
},
"type": "object",
"required": [
"name",
"slug"
],
"title": "RecipeCategory"
},
"RecipeCategoryPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeCategory"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "RecipeCategoryPagination"
},
"RecipeCommentCreate": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"text": {
"type": "string",
"title": "Text"
}
},
"type": "object",
"required": [
"recipeId",
"text"
],
"title": "RecipeCommentCreate"
},
"RecipeCommentOut-Input": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"text": {
"type": "string",
"title": "Text"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"createdAt": {
"type": "string",
"format": "date-time",
"title": "Createdat"
},
"update_at": {
"type": "string",
"format": "date-time",
"title": "Update At"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"user": {
"$ref": "#/components/schemas/mealie__schema__recipe__recipe_comments__UserBase"
}
},
"type": "object",
"required": [
"recipeId",
"text",
"id",
"createdAt",
"update_at",
"userId",
"user"
],
"title": "RecipeCommentOut"
},
"RecipeCommentOut-Output": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"text": {
"type": "string",
"title": "Text"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"createdAt": {
"type": "string",
"format": "date-time",
"title": "Createdat"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"title": "Updatedat"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"user": {
"$ref": "#/components/schemas/UserBase-Output"
}
},
"type": "object",
"required": [
"recipeId",
"text",
"id",
"createdAt",
"updatedAt",
"userId",
"user"
],
"title": "RecipeCommentOut"
},
"RecipeCommentPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeCommentOut-Output"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "RecipeCommentPagination"
},
"RecipeCommentUpdate": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"text": {
"type": "string",
"title": "Text"
}
},
"type": "object",
"required": [
"id",
"text"
],
"title": "RecipeCommentUpdate"
},
"RecipeCookBook": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug"
},
"position": {
"type": "integer",
"title": "Position",
"default": 1
},
"public": {
"type": "boolean",
"title": "Public",
"default": false
},
"queryFilterString": {
"type": "string",
"title": "Queryfilterstring",
"default": ""
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"queryFilter": {
"$ref": "#/components/schemas/QueryFilterJSON"
},
"recipes": {
"items": {
"$ref": "#/components/schemas/RecipeSummary"
},
"type": "array",
"title": "Recipes"
}
},
"type": "object",
"required": [
"name",
"groupId",
"householdId",
"id",
"recipes"
],
"title": "RecipeCookBook"
},
"RecipeDuplicate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"type": "object",
"title": "RecipeDuplicate"
},
"RecipeIngredient-Input": {
"properties": {
"quantity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientUnit"
},
{
"type": "null"
}
],
"title": "Unit"
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientFood"
},
{
"type": "null"
}
],
"title": "Food"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Isfood"
},
"disableAmount": {
"type": "boolean",
"title": "Disableamount",
"default": true
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"originalText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Originaltext"
},
"referenceId": {
"type": "string",
"format": "uuid",
"title": "Referenceid"
}
},
"type": "object",
"title": "RecipeIngredient"
},
"RecipeIngredient-Output": {
"properties": {
"quantity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Output"
},
{
"$ref": "#/components/schemas/CreateIngredientUnit"
},
{
"type": "null"
}
],
"title": "Unit"
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Output"
},
{
"$ref": "#/components/schemas/CreateIngredientFood"
},
{
"type": "null"
}
],
"title": "Food"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Isfood"
},
"disableAmount": {
"type": "boolean",
"title": "Disableamount",
"default": true
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"originalText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Originaltext"
},
"referenceId": {
"type": "string",
"format": "uuid",
"title": "Referenceid"
}
},
"type": "object",
"title": "RecipeIngredient"
},
"RecipeLastMade": {
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
}
},
"type": "object",
"required": [
"timestamp"
],
"title": "RecipeLastMade"
},
"RecipeNote": {
"properties": {
"title": {
"type": "string",
"title": "Title"
},
"text": {
"type": "string",
"title": "Text"
}
},
"type": "object",
"required": [
"title",
"text"
],
"title": "RecipeNote"
},
"RecipeSettings": {
"properties": {
"public": {
"type": "boolean",
"title": "Public",
"default": false
},
"showNutrition": {
"type": "boolean",
"title": "Shownutrition",
"default": false
},
"showAssets": {
"type": "boolean",
"title": "Showassets",
"default": false
},
"landscapeView": {
"type": "boolean",
"title": "Landscapeview",
"default": false
},
"disableComments": {
"type": "boolean",
"title": "Disablecomments",
"default": true
},
"disableAmount": {
"type": "boolean",
"title": "Disableamount",
"default": true
},
"locked": {
"type": "boolean",
"title": "Locked",
"default": false
}
},
"type": "object",
"title": "RecipeSettings"
},
"RecipeShareToken": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"title": "Expiresat"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"createdAt": {
"type": "string",
"format": "date-time",
"title": "Createdat"
},
"recipe": {
"$ref": "#/components/schemas/Recipe-Output"
}
},
"type": "object",
"required": [
"recipeId",
"groupId",
"id",
"createdAt",
"recipe"
],
"title": "RecipeShareToken"
},
"RecipeShareTokenCreate": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"title": "Expiresat"
}
},
"type": "object",
"required": [
"recipeId"
],
"title": "RecipeShareTokenCreate"
},
"RecipeShareTokenSummary": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"title": "Expiresat"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"createdAt": {
"type": "string",
"format": "date-time",
"title": "Createdat"
}
},
"type": "object",
"required": [
"recipeId",
"groupId",
"id",
"createdAt"
],
"title": "RecipeShareTokenSummary"
},
"RecipeStep": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"default": ""
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary",
"default": ""
},
"text": {
"type": "string",
"title": "Text"
},
"ingredientReferences": {
"items": {
"$ref": "#/components/schemas/IngredientReferences"
},
"type": "array",
"title": "Ingredientreferences",
"default": []
}
},
"type": "object",
"required": [
"text"
],
"title": "RecipeStep"
},
"RecipeSuggestionResponse": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/RecipeSuggestionResponseItem"
},
"type": "array",
"title": "Items"
}
},
"type": "object",
"required": [
"items"
],
"title": "RecipeSuggestionResponse"
},
"RecipeSuggestionResponseItem": {
"properties": {
"recipe": {
"$ref": "#/components/schemas/RecipeSummary"
},
"missingFoods": {
"items": {
"$ref": "#/components/schemas/IngredientFood-Output"
},
"type": "array",
"title": "Missingfoods"
},
"missingTools": {
"items": {
"$ref": "#/components/schemas/RecipeTool"
},
"type": "array",
"title": "Missingtools"
}
},
"type": "object",
"required": [
"recipe",
"missingFoods",
"missingTools"
],
"title": "RecipeSuggestionResponseItem"
},
"RecipeSummary": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug",
"default": ""
},
"image": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Image"
},
"recipeServings": {
"type": "number",
"title": "Recipeservings",
"default": 0
},
"recipeYieldQuantity": {
"type": "number",
"title": "Recipeyieldquantity",
"default": 0
},
"recipeYield": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recipeyield"
},
"totalTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Totaltime"
},
"prepTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Preptime"
},
"cookTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cooktime"
},
"performTime": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Performtime"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": ""
},
"recipeCategory": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeCategory"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipecategory",
"default": []
},
"tags": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeTag"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"default": []
},
"tools": {
"items": {
"$ref": "#/components/schemas/RecipeTool"
},
"type": "array",
"title": "Tools",
"default": []
},
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Rating"
},
"orgURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Orgurl"
},
"dateAdded": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Dateadded"
},
"dateUpdated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Dateupdated"
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
},
"lastMade": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Lastmade"
}
},
"type": "object",
"title": "RecipeSummary"
},
"RecipeTag": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug"
}
},
"type": "object",
"required": [
"name",
"slug"
],
"title": "RecipeTag"
},
"RecipeTagPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeTag"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "RecipeTagPagination"
},
"RecipeTagResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"recipes": {
"items": {
"$ref": "#/components/schemas/RecipeSummary"
},
"type": "array",
"title": "Recipes",
"default": []
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "RecipeTagResponse"
},
"RecipeTimelineEventIn": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"userId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Userid"
},
"subject": {
"type": "string",
"title": "Subject"
},
"eventType": {
"$ref": "#/components/schemas/TimelineEventType"
},
"eventMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Eventmessage"
},
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/TimelineEventImage"
},
{
"type": "null"
}
],
"default": "does not have image"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
}
},
"type": "object",
"required": [
"recipeId",
"subject",
"eventType"
],
"title": "RecipeTimelineEventIn"
},
"RecipeTimelineEventOut": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"subject": {
"type": "string",
"title": "Subject"
},
"eventType": {
"$ref": "#/components/schemas/TimelineEventType"
},
"eventMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Eventmessage"
},
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/TimelineEventImage"
},
{
"type": "null"
}
],
"default": "does not have image"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"createdAt": {
"type": "string",
"format": "date-time",
"title": "Createdat"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"title": "Updatedat"
}
},
"type": "object",
"required": [
"recipeId",
"userId",
"subject",
"eventType",
"id",
"groupId",
"householdId",
"createdAt",
"updatedAt"
],
"title": "RecipeTimelineEventOut"
},
"RecipeTimelineEventPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeTimelineEventOut"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "RecipeTimelineEventPagination"
},
"RecipeTimelineEventUpdate": {
"properties": {
"subject": {
"type": "string",
"title": "Subject"
},
"eventMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Eventmessage"
},
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/TimelineEventImage"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"subject"
],
"title": "RecipeTimelineEventUpdate"
},
"RecipeTool": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug"
},
"householdsWithTool": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithtool",
"default": []
}
},
"type": "object",
"required": [
"id",
"name",
"slug"
],
"title": "RecipeTool"
},
"RecipeToolCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"householdsWithTool": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithtool",
"default": []
}
},
"type": "object",
"required": [
"name"
],
"title": "RecipeToolCreate"
},
"RecipeToolOut": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"householdsWithTool": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithtool",
"default": []
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "RecipeToolOut"
},
"RecipeToolPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/RecipeTool"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "RecipeToolPagination"
},
"RecipeToolResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"householdsWithTool": {
"items": {
"type": "string"
},
"type": "array",
"title": "Householdswithtool",
"default": []
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
},
"recipes": {
"items": {
"$ref": "#/components/schemas/RecipeSummary"
},
"type": "array",
"title": "Recipes",
"default": []
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "RecipeToolResponse"
},
"RecipeZipTokenResponse": {
"properties": {
"token": {
"type": "string",
"title": "Token"
}
},
"type": "object",
"required": [
"token"
],
"title": "RecipeZipTokenResponse"
},
"RegisteredParser": {
"type": "string",
"enum": [
"nlp",
"brute",
"openai"
],
"title": "RegisteredParser"
},
"RelationalKeyword": {
"type": "string",
"enum": [
"IS",
"IS NOT",
"IN",
"NOT IN",
"CONTAINS ALL",
"LIKE",
"NOT LIKE"
],
"title": "RelationalKeyword"
},
"RelationalOperator": {
"type": "string",
"enum": [
"=",
"<>",
">",
"<",
">=",
"<="
],
"title": "RelationalOperator"
},
"ReportCategory": {
"type": "string",
"enum": [
"backup",
"restore",
"migration",
"bulk_import"
],
"title": "ReportCategory"
},
"ReportEntryOut": {
"properties": {
"reportId": {
"type": "string",
"format": "uuid4",
"title": "Reportid"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"success": {
"type": "boolean",
"title": "Success",
"default": true
},
"message": {
"type": "string",
"title": "Message"
},
"exception": {
"type": "string",
"title": "Exception",
"default": ""
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"reportId",
"message",
"id"
],
"title": "ReportEntryOut"
},
"ReportOut": {
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"category": {
"$ref": "#/components/schemas/ReportCategory"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"type": "string",
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/ReportSummaryStatus",
"default": "in-progress"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"entries": {
"items": {
"$ref": "#/components/schemas/ReportEntryOut"
},
"type": "array",
"title": "Entries",
"default": []
}
},
"type": "object",
"required": [
"category",
"groupId",
"name",
"id"
],
"title": "ReportOut"
},
"ReportSummary": {
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"category": {
"$ref": "#/components/schemas/ReportCategory"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"type": "string",
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/ReportSummaryStatus",
"default": "in-progress"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"category",
"groupId",
"name",
"id"
],
"title": "ReportSummary"
},
"ReportSummaryStatus": {
"type": "string",
"enum": [
"in-progress",
"success",
"failure",
"partial"
],
"title": "ReportSummaryStatus"
},
"ResetPassword": {
"properties": {
"token": {
"type": "string",
"title": "Token"
},
"email": {
"type": "string",
"title": "Email"
},
"password": {
"type": "string",
"title": "Password"
},
"passwordConfirm": {
"type": "string",
"title": "Passwordconfirm"
}
},
"type": "object",
"required": [
"token",
"email",
"password",
"passwordConfirm"
],
"title": "ResetPassword"
},
"SaveGroupRecipeAction": {
"properties": {
"actionType": {
"$ref": "#/components/schemas/GroupRecipeActionType"
},
"title": {
"type": "string",
"title": "Title"
},
"url": {
"type": "string",
"title": "Url"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
}
},
"type": "object",
"required": [
"actionType",
"title",
"url",
"groupId",
"householdId"
],
"title": "SaveGroupRecipeAction"
},
"ScrapeRecipe": {
"properties": {
"includeTags": {
"type": "boolean",
"title": "Includetags",
"default": false
},
"url": {
"type": "string",
"title": "Url"
}
},
"type": "object",
"required": [
"url"
],
"title": "ScrapeRecipe",
"example": {
"includeTags": true,
"url": "https://myfavoriterecipes.com/recipes"
}
},
"ScrapeRecipeData": {
"properties": {
"includeTags": {
"type": "boolean",
"title": "Includetags",
"default": false
},
"data": {
"type": "string",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "ScrapeRecipeData"
},
"ScrapeRecipeTest": {
"properties": {
"url": {
"type": "string",
"title": "Url"
},
"useOpenAI": {
"type": "boolean",
"title": "Useopenai",
"default": false
}
},
"type": "object",
"required": [
"url"
],
"title": "ScrapeRecipeTest"
},
"SeederConfig": {
"properties": {
"locale": {
"type": "string",
"title": "Locale"
}
},
"type": "object",
"required": [
"locale"
],
"title": "SeederConfig"
},
"SetPermissions": {
"properties": {
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"canManageHousehold": {
"type": "boolean",
"title": "Canmanagehousehold",
"default": false
},
"canManage": {
"type": "boolean",
"title": "Canmanage",
"default": false
},
"canInvite": {
"type": "boolean",
"title": "Caninvite",
"default": false
},
"canOrganize": {
"type": "boolean",
"title": "Canorganize",
"default": false
}
},
"type": "object",
"required": [
"userId"
],
"title": "SetPermissions"
},
"ShoppingListAddRecipeParams": {
"properties": {
"recipeIncrementQuantity": {
"type": "number",
"title": "Recipeincrementquantity",
"default": 1
},
"recipeIngredients": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeIngredient-Input"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipeingredients"
}
},
"type": "object",
"title": "ShoppingListAddRecipeParams"
},
"ShoppingListAddRecipeParamsBulk": {
"properties": {
"recipeIncrementQuantity": {
"type": "number",
"title": "Recipeincrementquantity",
"default": 1
},
"recipeIngredients": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RecipeIngredient-Input"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Recipeingredients"
},
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
}
},
"type": "object",
"required": [
"recipeId"
],
"title": "ShoppingListAddRecipeParamsBulk"
},
"ShoppingListCreate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"update_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Update At"
}
},
"type": "object",
"title": "ShoppingListCreate"
},
"ShoppingListItemCreate": {
"properties": {
"quantity": {
"type": "number",
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientUnit"
},
{
"type": "null"
}
],
"title": "Unit"
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientFood"
},
{
"type": "null"
}
],
"title": "Food"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"type": "boolean",
"title": "Isfood",
"default": false
},
"disableAmount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Disableamount"
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"checked": {
"type": "boolean",
"title": "Checked",
"default": false
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"foodId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Foodid"
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"unitId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Unitid"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"recipeReferences": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemRecipeRefCreate"
},
"type": "array",
"title": "Recipereferences",
"default": []
}
},
"type": "object",
"required": [
"shoppingListId"
],
"title": "ShoppingListItemCreate"
},
"ShoppingListItemOut-Input": {
"properties": {
"quantity": {
"type": "number",
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Input"
},
{
"type": "null"
}
]
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Input"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"type": "boolean",
"title": "Isfood",
"default": false
},
"disableAmount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Disableamount"
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"checked": {
"type": "boolean",
"title": "Checked",
"default": false
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"foodId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Foodid"
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"unitId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Unitid"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"label": {
"anyOf": [
{
"$ref": "#/components/schemas/MultiPurposeLabelSummary"
},
{
"type": "null"
}
]
},
"recipeReferences": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemRecipeRefOut"
},
"type": "array",
"title": "Recipereferences",
"default": []
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"update_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Update At"
}
},
"type": "object",
"required": [
"shoppingListId",
"id",
"groupId",
"householdId"
],
"title": "ShoppingListItemOut"
},
"ShoppingListItemOut-Output": {
"properties": {
"quantity": {
"type": "number",
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Output"
},
{
"type": "null"
}
]
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Output"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"type": "boolean",
"title": "Isfood",
"default": false
},
"disableAmount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Disableamount"
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"checked": {
"type": "boolean",
"title": "Checked",
"default": false
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"foodId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Foodid"
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"unitId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Unitid"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"label": {
"anyOf": [
{
"$ref": "#/components/schemas/MultiPurposeLabelSummary"
},
{
"type": "null"
}
]
},
"recipeReferences": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemRecipeRefOut"
},
"type": "array",
"title": "Recipereferences",
"default": []
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
}
},
"type": "object",
"required": [
"shoppingListId",
"id",
"groupId",
"householdId"
],
"title": "ShoppingListItemOut"
},
"ShoppingListItemPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemOut-Output"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "ShoppingListItemPagination"
},
"ShoppingListItemRecipeRefCreate": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"recipeQuantity": {
"type": "number",
"title": "Recipequantity",
"default": 0
},
"recipeScale": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Recipescale",
"default": 1
},
"recipeNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recipenote"
}
},
"type": "object",
"required": [
"recipeId"
],
"title": "ShoppingListItemRecipeRefCreate"
},
"ShoppingListItemRecipeRefOut": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"recipeQuantity": {
"type": "number",
"title": "Recipequantity",
"default": 0
},
"recipeScale": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Recipescale",
"default": 1
},
"recipeNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recipenote"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"shoppingListItemId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistitemid"
}
},
"type": "object",
"required": [
"recipeId",
"id",
"shoppingListItemId"
],
"title": "ShoppingListItemRecipeRefOut"
},
"ShoppingListItemRecipeRefUpdate": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"recipeQuantity": {
"type": "number",
"title": "Recipequantity",
"default": 0
},
"recipeScale": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Recipescale",
"default": 1
},
"recipeNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Recipenote"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"shoppingListItemId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistitemid"
}
},
"type": "object",
"required": [
"recipeId",
"id",
"shoppingListItemId"
],
"title": "ShoppingListItemRecipeRefUpdate"
},
"ShoppingListItemUpdate": {
"properties": {
"quantity": {
"type": "number",
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientUnit"
},
{
"type": "null"
}
],
"title": "Unit"
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientFood"
},
{
"type": "null"
}
],
"title": "Food"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"type": "boolean",
"title": "Isfood",
"default": false
},
"disableAmount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Disableamount"
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"checked": {
"type": "boolean",
"title": "Checked",
"default": false
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"foodId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Foodid"
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"unitId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Unitid"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"recipeReferences": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ShoppingListItemRecipeRefCreate"
},
{
"$ref": "#/components/schemas/ShoppingListItemRecipeRefUpdate"
}
]
},
"type": "array",
"title": "Recipereferences",
"default": []
}
},
"type": "object",
"required": [
"shoppingListId"
],
"title": "ShoppingListItemUpdate"
},
"ShoppingListItemUpdateBulk": {
"properties": {
"quantity": {
"type": "number",
"title": "Quantity",
"default": 1
},
"unit": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientUnit-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientUnit"
},
{
"type": "null"
}
],
"title": "Unit"
},
"food": {
"anyOf": [
{
"$ref": "#/components/schemas/IngredientFood-Input"
},
{
"$ref": "#/components/schemas/CreateIngredientFood"
},
{
"type": "null"
}
],
"title": "Food"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": ""
},
"isFood": {
"type": "boolean",
"title": "Isfood",
"default": false
},
"disableAmount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Disableamount"
},
"display": {
"type": "string",
"title": "Display",
"default": ""
},
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"checked": {
"type": "boolean",
"title": "Checked",
"default": false
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"foodId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Foodid"
},
"labelId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Labelid"
},
"unitId": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Unitid"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"recipeReferences": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ShoppingListItemRecipeRefCreate"
},
{
"$ref": "#/components/schemas/ShoppingListItemRecipeRefUpdate"
}
]
},
"type": "array",
"title": "Recipereferences",
"default": []
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"shoppingListId",
"id"
],
"title": "ShoppingListItemUpdateBulk",
"description": "Only used for bulk update operations where the shopping list item id isn't already supplied"
},
"ShoppingListItemsCollectionOut": {
"properties": {
"createdItems": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemOut-Output"
},
"type": "array",
"title": "Createditems",
"default": []
},
"updatedItems": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemOut-Output"
},
"type": "array",
"title": "Updateditems",
"default": []
},
"deletedItems": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemOut-Output"
},
"type": "array",
"title": "Deleteditems",
"default": []
}
},
"type": "object",
"title": "ShoppingListItemsCollectionOut",
"description": "Container for bulk shopping list item changes"
},
"ShoppingListMultiPurposeLabelOut": {
"properties": {
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"labelId": {
"type": "string",
"format": "uuid4",
"title": "Labelid"
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"label": {
"$ref": "#/components/schemas/MultiPurposeLabelSummary"
}
},
"type": "object",
"required": [
"shoppingListId",
"labelId",
"id",
"label"
],
"title": "ShoppingListMultiPurposeLabelOut"
},
"ShoppingListMultiPurposeLabelUpdate": {
"properties": {
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"labelId": {
"type": "string",
"format": "uuid4",
"title": "Labelid"
},
"position": {
"type": "integer",
"title": "Position",
"default": 0
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"shoppingListId",
"labelId",
"id"
],
"title": "ShoppingListMultiPurposeLabelUpdate"
},
"ShoppingListOut": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"listItems": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemOut-Output"
},
"type": "array",
"title": "Listitems",
"default": []
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"recipeReferences": {
"items": {
"$ref": "#/components/schemas/ShoppingListRecipeRefOut"
},
"type": "array",
"title": "Recipereferences",
"default": []
},
"labelSettings": {
"items": {
"$ref": "#/components/schemas/ShoppingListMultiPurposeLabelOut"
},
"type": "array",
"title": "Labelsettings",
"default": []
}
},
"type": "object",
"required": [
"groupId",
"userId",
"id",
"householdId"
],
"title": "ShoppingListOut"
},
"ShoppingListPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/ShoppingListSummary"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "ShoppingListPagination"
},
"ShoppingListRecipeRefOut": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"shoppingListId": {
"type": "string",
"format": "uuid4",
"title": "Shoppinglistid"
},
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"recipeQuantity": {
"type": "number",
"title": "Recipequantity"
},
"recipe": {
"$ref": "#/components/schemas/RecipeSummary"
}
},
"type": "object",
"required": [
"id",
"shoppingListId",
"recipeId",
"recipeQuantity",
"recipe"
],
"title": "ShoppingListRecipeRefOut"
},
"ShoppingListRemoveRecipeParams": {
"properties": {
"recipeDecrementQuantity": {
"type": "number",
"title": "Recipedecrementquantity",
"default": 1
}
},
"type": "object",
"title": "ShoppingListRemoveRecipeParams"
},
"ShoppingListSummary": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"updatedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updatedat"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"recipeReferences": {
"items": {
"$ref": "#/components/schemas/ShoppingListRecipeRefOut"
},
"type": "array",
"title": "Recipereferences"
},
"labelSettings": {
"items": {
"$ref": "#/components/schemas/ShoppingListMultiPurposeLabelOut"
},
"type": "array",
"title": "Labelsettings"
}
},
"type": "object",
"required": [
"groupId",
"userId",
"id",
"householdId",
"recipeReferences",
"labelSettings"
],
"title": "ShoppingListSummary"
},
"ShoppingListUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"extras": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"title": "Extras",
"default": {}
},
"createdAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Createdat"
},
"update_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Update At"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"listItems": {
"items": {
"$ref": "#/components/schemas/ShoppingListItemOut-Input"
},
"type": "array",
"title": "Listitems",
"default": []
}
},
"type": "object",
"required": [
"groupId",
"userId",
"id"
],
"title": "ShoppingListUpdate"
},
"SuccessResponse": {
"properties": {
"message": {
"type": "string",
"title": "Message"
},
"error": {
"type": "boolean",
"title": "Error",
"default": false
}
},
"type": "object",
"required": [
"message"
],
"title": "SuccessResponse"
},
"SupportedMigrations": {
"type": "string",
"enum": [
"nextcloud",
"chowdown",
"copymethat",
"paprika",
"mealie_alpha",
"tandoor",
"plantoeat",
"myrecipebox",
"recipekeeper"
],
"title": "SupportedMigrations"
},
"TagBase": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
}
},
"type": "object",
"required": [
"name",
"id",
"slug"
],
"title": "TagBase"
},
"TagIn": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "TagIn"
},
"TagOut": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"slug": {
"type": "string",
"title": "Slug"
}
},
"type": "object",
"required": [
"name",
"groupId",
"id",
"slug"
],
"title": "TagOut"
},
"TimelineEventImage": {
"type": "string",
"enum": [
"has image",
"does not have image"
],
"title": "TimelineEventImage"
},
"TimelineEventType": {
"type": "string",
"enum": [
"system",
"info",
"comment"
],
"title": "TimelineEventType"
},
"UnlockResults": {
"properties": {
"unlocked": {
"type": "integer",
"title": "Unlocked",
"default": 0
}
},
"type": "object",
"title": "UnlockResults"
},
"UpdateCookBook": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug"
},
"position": {
"type": "integer",
"title": "Position",
"default": 1
},
"public": {
"type": "boolean",
"title": "Public",
"default": false
},
"queryFilterString": {
"type": "string",
"title": "Queryfilterstring",
"default": ""
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"name",
"groupId",
"householdId",
"id"
],
"title": "UpdateCookBook"
},
"UpdateGroupPreferences": {
"properties": {
"privateGroup": {
"type": "boolean",
"title": "Privategroup",
"default": true
}
},
"type": "object",
"title": "UpdateGroupPreferences"
},
"UpdateHouseholdAdmin": {
"properties": {
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"name": {
"type": "string",
"minLength": 1,
"title": "Name"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"preferences": {
"anyOf": [
{
"$ref": "#/components/schemas/UpdateHouseholdPreferences"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"groupId",
"name",
"id"
],
"title": "UpdateHouseholdAdmin"
},
"UpdateHouseholdPreferences": {
"properties": {
"privateHousehold": {
"type": "boolean",
"title": "Privatehousehold",
"default": true
},
"lockRecipeEditsFromOtherHouseholds": {
"type": "boolean",
"title": "Lockrecipeeditsfromotherhouseholds",
"default": true
},
"firstDayOfWeek": {
"type": "integer",
"title": "Firstdayofweek",
"default": 0
},
"recipePublic": {
"type": "boolean",
"title": "Recipepublic",
"default": true
},
"recipeShowNutrition": {
"type": "boolean",
"title": "Recipeshownutrition",
"default": false
},
"recipeShowAssets": {
"type": "boolean",
"title": "Recipeshowassets",
"default": false
},
"recipeLandscapeView": {
"type": "boolean",
"title": "Recipelandscapeview",
"default": false
},
"recipeDisableComments": {
"type": "boolean",
"title": "Recipedisablecomments",
"default": false
},
"recipeDisableAmount": {
"type": "boolean",
"title": "Recipedisableamount",
"default": true
}
},
"type": "object",
"title": "UpdateHouseholdPreferences"
},
"UpdateImageResponse": {
"properties": {
"image": {
"type": "string",
"title": "Image"
}
},
"type": "object",
"required": [
"image"
],
"title": "UpdateImageResponse"
},
"UpdatePlanEntry": {
"properties": {
"date": {
"type": "string",
"format": "date",
"title": "Date"
},
"entryType": {
"$ref": "#/components/schemas/PlanEntryType",
"default": "breakfast"
},
"title": {
"type": "string",
"title": "Title",
"default": ""
},
"text": {
"type": "string",
"title": "Text",
"default": ""
},
"recipeId": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Recipeid"
},
"id": {
"type": "integer",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid",
"title": "Groupid"
},
"userId": {
"type": "string",
"format": "uuid",
"title": "Userid"
}
},
"type": "object",
"required": [
"date",
"id",
"groupId",
"userId"
],
"title": "UpdatePlanEntry"
},
"UserBase-Output": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"admin": {
"type": "boolean",
"title": "Admin"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fullname"
}
},
"type": "object",
"required": [
"id",
"admin"
],
"title": "UserBase"
},
"UserIn": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"username": {
"type": "string",
"title": "Username"
},
"fullName": {
"type": "string",
"title": "Fullname"
},
"email": {
"type": "string",
"title": "Email"
},
"authMethod": {
"$ref": "#/components/schemas/AuthMethod",
"default": "Mealie"
},
"admin": {
"type": "boolean",
"title": "Admin",
"default": false
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group"
},
"household": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Household"
},
"advanced": {
"type": "boolean",
"title": "Advanced",
"default": false
},
"canInvite": {
"type": "boolean",
"title": "Caninvite",
"default": false
},
"canManage": {
"type": "boolean",
"title": "Canmanage",
"default": false
},
"canManageHousehold": {
"type": "boolean",
"title": "Canmanagehousehold",
"default": false
},
"canOrganize": {
"type": "boolean",
"title": "Canorganize",
"default": false
},
"password": {
"type": "string",
"title": "Password"
}
},
"type": "object",
"required": [
"username",
"fullName",
"email",
"password"
],
"title": "UserIn",
"example": {
"admin": "false",
"email": "changeme@example.com",
"fullName": "Change Me",
"group": "Home",
"household": "Family",
"username": "ChangeMe"
}
},
"UserOut": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fullname"
},
"email": {
"type": "string",
"title": "Email"
},
"authMethod": {
"$ref": "#/components/schemas/AuthMethod",
"default": "Mealie"
},
"admin": {
"type": "boolean",
"title": "Admin",
"default": false
},
"group": {
"type": "string",
"title": "Group"
},
"household": {
"type": "string",
"title": "Household"
},
"advanced": {
"type": "boolean",
"title": "Advanced",
"default": false
},
"canInvite": {
"type": "boolean",
"title": "Caninvite",
"default": false
},
"canManage": {
"type": "boolean",
"title": "Canmanage",
"default": false
},
"canManageHousehold": {
"type": "boolean",
"title": "Canmanagehousehold",
"default": false
},
"canOrganize": {
"type": "boolean",
"title": "Canorganize",
"default": false
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"groupSlug": {
"type": "string",
"title": "Groupslug"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"householdSlug": {
"type": "string",
"title": "Householdslug"
},
"tokens": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/LongLiveTokenOut"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tokens"
},
"cacheKey": {
"type": "string",
"title": "Cachekey"
}
},
"type": "object",
"required": [
"id",
"email",
"group",
"household",
"groupId",
"groupSlug",
"householdId",
"householdSlug",
"cacheKey"
],
"title": "UserOut",
"example": {
"admin": "false",
"email": "changeme@example.com",
"fullName": "Change Me",
"group": "Home",
"household": "Family",
"username": "ChangeMe"
}
},
"UserPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/UserOut"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "UserPagination"
},
"UserRatingOut": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Rating"
},
"isFavorite": {
"type": "boolean",
"title": "Isfavorite",
"default": false
},
"userId": {
"type": "string",
"format": "uuid4",
"title": "Userid"
},
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
}
},
"type": "object",
"required": [
"recipeId",
"userId",
"id"
],
"title": "UserRatingOut"
},
"UserRatingSummary": {
"properties": {
"recipeId": {
"type": "string",
"format": "uuid4",
"title": "Recipeid"
},
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Rating"
},
"isFavorite": {
"type": "boolean",
"title": "Isfavorite",
"default": false
}
},
"type": "object",
"required": [
"recipeId"
],
"title": "UserRatingSummary"
},
"UserRatingUpdate": {
"properties": {
"rating": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Rating"
},
"isFavorite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Isfavorite"
}
},
"type": "object",
"title": "UserRatingUpdate"
},
"UserRatings_UserRatingOut_": {
"properties": {
"ratings": {
"items": {
"$ref": "#/components/schemas/UserRatingOut"
},
"type": "array",
"title": "Ratings"
}
},
"type": "object",
"required": [
"ratings"
],
"title": "UserRatings[UserRatingOut]"
},
"UserRatings_UserRatingSummary_": {
"properties": {
"ratings": {
"items": {
"$ref": "#/components/schemas/UserRatingSummary"
},
"type": "array",
"title": "Ratings"
}
},
"type": "object",
"required": [
"ratings"
],
"title": "UserRatings[UserRatingSummary]"
},
"UserSummary": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"groupId": {
"type": "string",
"format": "uuid4",
"title": "Groupid"
},
"householdId": {
"type": "string",
"format": "uuid4",
"title": "Householdid"
},
"username": {
"type": "string",
"title": "Username"
},
"fullName": {
"type": "string",
"title": "Fullname"
}
},
"type": "object",
"required": [
"id",
"groupId",
"householdId",
"username",
"fullName"
],
"title": "UserSummary"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WebhookPagination": {
"properties": {
"page": {
"type": "integer",
"title": "Page",
"default": 1
},
"per_page": {
"type": "integer",
"title": "Per Page",
"default": 10
},
"total": {
"type": "integer",
"title": "Total",
"default": 0
},
"total_pages": {
"type": "integer",
"title": "Total Pages",
"default": 0
},
"items": {
"items": {
"$ref": "#/components/schemas/ReadWebhook"
},
"type": "array",
"title": "Items"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
},
"previous": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previous"
}
},
"type": "object",
"required": [
"items"
],
"title": "WebhookPagination"
},
"WebhookType": {
"type": "string",
"enum": [
"mealplan"
],
"title": "WebhookType"
},
"mealie__schema__recipe__recipe_comments__UserBase": {
"properties": {
"id": {
"type": "string",
"format": "uuid4",
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"admin": {
"type": "boolean",
"title": "Admin"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fullname"
}
},
"type": "object",
"required": [
"id",
"admin"
],
"title": "UserBase"
},
"mealie__schema__user__user__UserBase": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid4"
},
{
"type": "null"
}
],
"title": "Id"
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Username"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Fullname"
},
"email": {
"type": "string",
"title": "Email"
},
"authMethod": {
"$ref": "#/components/schemas/AuthMethod",
"default": "Mealie"
},
"admin": {
"type": "boolean",
"title": "Admin",
"default": false
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group"
},
"household": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Household"
},
"advanced": {
"type": "boolean",
"title": "Advanced",
"default": false
},
"canInvite": {
"type": "boolean",
"title": "Caninvite",
"default": false
},
"canManage": {
"type": "boolean",
"title": "Canmanage",
"default": false
},
"canManageHousehold": {
"type": "boolean",
"title": "Canmanagehousehold",
"default": false
},
"canOrganize": {
"type": "boolean",
"title": "Canorganize",
"default": false
}
},
"type": "object",
"required": [
"email"
],
"title": "UserBase",
"example": {
"admin": "false",
"email": "changeme@example.com",
"fullName": "Change Me",
"group": "Home",
"household": "Family",
"username": "ChangeMe"
}
}
},
"securitySchemes": {
"OAuth2PasswordBearer": {
"type": "oauth2",
"flows": {
"password": {
"scopes": {},
"tokenUrl": "/api/auth/token"
}
}
}
}
}
}