Schemathesis 4.32.1
API Coverage Report
2026-10-19 15:56:40
Operations
Operations called at least once
96.3% 238 of 247 called
Parameters
Tested with valid and invalid values
91.2% 679 of 744 covered
Keywords
Constraints tested both ways
91.4% 5080 of 5553 covered
Examples
Schema examples sent in tests
96.9% 658 of 679 used
Responses
Documented response codes hit
78.0% 380 of 487 received
Show
Admin: About 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1447n/a{
2447n/a "anyOf": [
3289n/a {
4289n/a "type": "string"
5289n/a },
6158289 {
7158289 "type": "null"
8158289 }
9447n/a ],
10447n/a}
Responses
codedescriptionhitsavg
200Successful Response53513ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1476n/a{
2476n/a "anyOf": [
3315n/a {
4315n/a "type": "string"
5315n/a },
6161315 {
7161315 "type": "null"
8161315 }
9476n/a ],
10476n/a}
Responses
codedescriptionhitsavg
200Successful Response52513ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1451n/a{
2451n/a "anyOf": [
3296n/a {
4296n/a "type": "string"
5296n/a },
6155296 {
7155296 "type": "null"
8155296 }
9451n/a ],
10451n/a}
Responses
codedescriptionhitsavg
200Successful Response52415ms
422Validation Error0never seen
Admin: Backups 6 operations 5 covered 0 partial 1 uncovered 0 not measured 84% #
Headers
accept-language3 / 3
#validinvalidschema
1541n/a{
2541n/a "anyOf": [
3365n/a {
4365n/a "type": "string"
5365n/a },
6176365 {
7176365 "type": "null"
8176365 }
9541n/a ],
10541n/a}
Responses
codedescriptionhitsavg
200Successful Response72813ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
128n/a{
228n/a "anyOf": [
320n/a {
420n/a "type": "string"
520n/a },
6820 {
7820 "type": "null"
8820 }
928n/a ],
1028n/a}
Responses
codedescriptionhitsavg
201Successful Response46964ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1322n/a{
2322n/a "anyOf": [
3228n/a {
4228n/a "type": "string"
5228n/a },
694228 {
794228 "type": "null"
894228 }
9322n/a ],
10322n/a}
Body
multipart/form-data5 / 5
Body_upload_one_api_admin_backups_upload_post
1249121{
2249n/a "properties": {
3249n/a "archive": {
4249n/a "format": "binary",
5249n/a "type": "string"
6249n/a }
7249n/a },
8249121 "required": [
9249121 "archive"
10249121 ],
11370n/a "type": "object"
12249121}
Responses
codedescriptionhitsavg
200Successful Response1229ms
422Validation Error19112ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request21014ms
Path Parameters
file_name1 / 1
#validinvalidschema
1230n/a{
2230n/a "type": "string"
3230n/a}
Headers
accept-language3 / 3
136n/a{
236n/a "anyOf": [
324n/a {
424n/a "type": "string"
524n/a },
61224 {
71224 "type": "null"
81224 }
936n/a ],
1036n/a}
Responses
codedescriptionhitsavg
200Successful Response2811ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request20215ms
Path Parameters
file_name1 / 1
#validinvalidschema
1513n/a{
2513n/a "type": "string"
3513n/a}
Headers
accept-language3 / 3
1291n/a{
2291n/a "anyOf": [
3183n/a {
4183n/a "type": "string"
5183n/a },
6108183 {
7108183 "type": "null"
8108183 }
9291n/a ],
10291n/a}
Responses
codedescriptionhitsavg
200Successful Response33511ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found17816ms
Path Parameters
file_nameno coverage data
#validinvalidschema
10n/a{
20n/a "type": "string"
30n/a}
Headers
accept-languageno coverage data
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Admin: Debug 1 operation 0 covered 1 partial 0 uncovered 0 not measured 77% #
Headers
accept-language3 / 3
#validinvalidschema
1357n/a{
2357n/a "anyOf": [
3207n/a {
4207n/a "type": "string"
5207n/a },
6150207 {
7150207 "type": "null"
8150207 }
9357n/a ],
10357n/a}
Body
multipart/form-data4 / 6
Body_debug_openai_api_admin_debug_openai_post
12010{
21140 "properties": {
31140 "image": {
41140 "anyOf": [
5105n/a {
6105n/a "format": "binary",
7105n/a "type": "string"
8105n/a },
99105 {
109105 "type": "null"
119105 }
121140 ],
131140 }
141140 },
15201n/a "type": "object"
162010}
Responses
codedescriptionhitsavg
200Successful Response17213ms
422Validation Error22212ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1141ms
Admin: Email 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1452n/a{
2452n/a "anyOf": [
3294n/a {
4294n/a "type": "string"
5294n/a },
6158294 {
7158294 "type": "null"
8158294 }
9452n/a ],
10452n/a}
Responses
codedescriptionhitsavg
200Successful Response51913ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1675n/a{
2675n/a "anyOf": [
3377n/a {
4377n/a "type": "string"
5377n/a },
6298377 {
7298377 "type": "null"
8298377 }
9675n/a ],
10675n/a}
Body
application/json4 / 4
EmailTest
1134328{
2134100 "properties": {
3134100 "email": {
4134100 "type": "string"
5134100 }
6134100 },
7234196 "required": [
8234196 "email"
9234196 ],
1043032 "type": "object"
11134328}
Responses
codedescriptionhitsavg
200Successful Response1349ms
422Validation Error3769ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request181ms
Admin: Maintenance 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1421n/a{
2421n/a "anyOf": [
3281n/a {
4281n/a "type": "string"
5281n/a },
6140281 {
7140281 "type": "null"
8140281 }
9421n/a ],
10421n/a}
Responses
codedescriptionhitsavg
200Successful Response45823ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1449n/a{
2449n/a "anyOf": [
3293n/a {
4293n/a "type": "string"
5293n/a },
6156293 {
7156293 "type": "null"
8156293 }
9449n/a ],
10449n/a}
Responses
codedescriptionhitsavg
200Successful Response49514ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1477n/a{
2477n/a "anyOf": [
3312n/a {
4312n/a "type": "string"
5312n/a },
6165312 {
7165312 "type": "null"
8165312 }
9477n/a ],
10477n/a}
Responses
codedescriptionhitsavg
200Successful Response52411ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1486n/a{
2486n/a "anyOf": [
3315n/a {
4315n/a "type": "string"
5315n/a },
6171315 {
7171315 "type": "null"
8171315 }
9486n/a ],
10486n/a}
Responses
codedescriptionhitsavg
200Successful Response5519ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1427n/a{
2427n/a "anyOf": [
3290n/a {
4290n/a "type": "string"
5290n/a },
6137290 {
7137290 "type": "null"
8137290 }
9427n/a ],
10427n/a}
Responses
codedescriptionhitsavg
200Successful Response48020ms
422Validation Error0never seen
Admin: Manage Groups 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1314n/a{
2314n/a "anyOf": [
3247n/a {
4247n/a "type": "string"
5247n/a },
667247 {
767247 "type": "null"
867247 }
9314n/a ],
10314n/a}
orderByNullPosition5 / 5
1154239{
2154239 "anyOf": [
3118275 {
5118275 },
636357 {
736357 "type": "null"
836357 }
9154239 ],
10154239}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1118275{
2118275 "enum": [
366n/a "first",
452n/a "last"
5118275 ],
6357n/a "type": "string"
7118275}
orderDirection2 / 2
OrderDirection
1232101{
2232101 "enum": [
3130n/a "asc",
4102n/a "desc"
5232101 ],
6333n/a "type": "string"
7232101}
queryFilter3 / 3
1343n/a{
2343n/a "anyOf": [
3255n/a {
4255n/a "type": "string"
5255n/a },
688255 {
788255 "type": "null"
888255 }
9343n/a ],
10343n/a}
paginationSeed3 / 3
1292n/a{
2292n/a "anyOf": [
3221n/a {
4221n/a "type": "string"
5221n/a },
671221 {
771221 "type": "null"
871221 }
9292n/a ],
10292n/a}
page1 / 1
125243{
225243 "type": "integer"
325243}
perPage1 / 1
121163{
221163 "type": "integer"
321163}
Headers
accept-language3 / 3
1429n/a{
2429n/a "anyOf": [
3316n/a {
4316n/a "type": "string"
5316n/a },
6113316 {
7113316 "type": "null"
8113316 }
9429n/a ],
10429n/a}
Responses
codedescriptionhitsavg
200Successful Response28735ms
422Validation Error32313ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4415ms
500Internal Server Error1117ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1544n/a{
2544n/a "anyOf": [
3327n/a {
4327n/a "type": "string"
5327n/a },
6217327 {
7217327 "type": "null"
8217327 }
9544n/a ],
10544n/a}
Body
application/json5 / 5
GroupBase
1338213{
233891 "properties": {
333891 "name": {
433848 "minLength": 1,
538643 "type": "string"
633891 }
733891 },
8429110 "required": [
9429110 "name"
10429110 ],
1153912 "type": "object"
12338213}
Responses
codedescriptionhitsavg
201Successful Response30474ms
422Validation Error3796ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request211ms
500Internal Server Error3416ms
Path Parameters
item_id2 / 2
#validinvalidschema
133216{
233216 "format": "uuid4",
3348n/a "type": "string"
433216}
Headers
accept-language3 / 3
198n/a{
298n/a "anyOf": [
367n/a {
467n/a "type": "string"
567n/a },
63167 {
73167 "type": "null"
83167 }
998n/a ],
1098n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1616ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request16526ms
404Not Found16718ms
Path Parameters
item_id2 / 2
#validinvalidschema
149116{
249116 "format": "uuid4",
3507n/a "type": "string"
449116}
Headers
accept-language3 / 3
1141n/a{
2141n/a "anyOf": [
394n/a {
494n/a "type": "string"
594n/a },
64794 {
74794 "type": "null"
84794 }
9141n/a ],
10141n/a}
Responses
codedescriptionhitsavg
200Successful Response44616ms
422Validation Error1613ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4513ms
Path Parameters
item_id2 / 2
#validinvalidschema
149627{
249627 "format": "uuid4",
3523n/a "type": "string"
449627}
Headers
accept-language3 / 3
1239n/a{
2239n/a "anyOf": [
3161n/a {
4161n/a "type": "string"
5161n/a },
678161 {
778161 "type": "null"
878161 }
9239n/a ],
10239n/a}
Body
application/json12 / 12
GroupAdminUpdate
142362{
244831 "properties": {
345011 "id": {
44504 "format": "uuid4",
54547 "type": "string"
645011 },
74639 "name": {
84639 "type": "string"
94639 },
1012120 "preferences": {
1112120 "anyOf": [
1240101 {
1440101 },
158160 {
168160 "type": "null"
178160 }
1812120 ]
1912120 }
2044831 },
2145426 "required": [
2246119 "id",
234728 "name"
2445426 ],
254805 "type": "object"
2642362}
Referenced Components (1)4 of 4 keywords
UpdateGroupPreferences4 of 4 keywords
140101{
21910 "properties": {
31910 "privateGroup": {
41910 "type": "boolean"
51910 }
61910 },
75091 "type": "object"
840101}
Responses
codedescriptionhitsavg
200Successful Response21827ms
422Validation Error1178ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error18217ms
400Bad Request61ms
Examples
Body: application/json
trueUpdateGroupPreferences.privateGroup
Admin: Manage Households 5 operations 4 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1204n/a{
2204n/a "anyOf": [
3168n/a {
4168n/a "type": "string"
5168n/a },
636168 {
736168 "type": "null"
836168 }
9204n/a ],
10204n/a}
orderByNullPosition5 / 5
1179110{
2179110 "anyOf": [
3168121 {
5168121 },
611278 {
711278 "type": "null"
811278 }
9179110 ],
10179110}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1168121{
2168121 "enum": [
361n/a "first",
4107n/a "last"
5168121 ],
6278n/a "type": "string"
7168121}
orderDirection2 / 2
OrderDirection
119557{
219557 "enum": [
3122n/a "asc",
473n/a "desc"
519557 ],
6252n/a "type": "string"
719557}
queryFilter3 / 3
1184n/a{
2184n/a "anyOf": [
3163n/a {
4163n/a "type": "string"
5163n/a },
621163 {
721163 "type": "null"
821163 }
9184n/a ],
10184n/a}
paginationSeed3 / 3
1190n/a{
2190n/a "anyOf": [
3165n/a {
4165n/a "type": "string"
5165n/a },
625165 {
725165 "type": "null"
825165 }
9190n/a ],
10190n/a}
page1 / 1
135027{
235027 "type": "integer"
335027}
perPage1 / 1
121539{
221539 "type": "integer"
321539}
Headers
accept-language3 / 3
1634n/a{
2634n/a "anyOf": [
3406n/a {
4406n/a "type": "string"
5406n/a },
6228406 {
7228406 "type": "null"
8228406 }
9634n/a ],
10634n/a}
Responses
codedescriptionhitsavg
200Successful Response23414ms
422Validation Error17813ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error23432ms
400Bad Request5312ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1244n/a{
2244n/a "anyOf": [
3169n/a {
4169n/a "type": "string"
5169n/a },
675169 {
775169 "type": "null"
875169 }
9244n/a ],
10244n/a}
Body
application/json9 / 9
HouseholdCreate
150216{
253199 "properties": {
336178 "groupId": {
436178 "anyOf": [
525189 {
625167 "format": "uuid4",
719222 "type": "string"
825189 },
911203 {
1011203 "type": "null"
1111203 }
1236178 ],
1336178 },
1421336 "name": {
1521323 "minLength": 1,
1623613 "type": "string"
1721336 }
1853199 },
192499 "required": [
202499 "name"
212499 ],
222588 "type": "object"
2350216}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error3436ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5027ms
400Bad Request1551ms
Path Parameters
item_id2 / 2
#validinvalidschema
115911{
215911 "format": "uuid4",
3170n/a "type": "string"
415911}
Headers
accept-language3 / 3
155n/a{
255n/a "anyOf": [
335n/a {
435n/a "type": "string"
535n/a },
62035 {
72035 "type": "null"
82035 }
955n/a ],
1055n/a}
Responses
codedescriptionhitsavg
200Successful Response765ms
422Validation Error1113ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request11444ms
404Not Found3811ms
Path Parameters
item_id2 / 2
#validinvalidschema
146718{
246718 "format": "uuid4",
3485n/a "type": "string"
446718}
Headers
accept-language3 / 3
1197n/a{
2197n/a "anyOf": [
3127n/a {
4127n/a "type": "string"
5127n/a },
670127 {
770127 "type": "null"
870127 }
9197n/a ],
10197n/a}
Responses
codedescriptionhitsavg
200Successful Response18633ms
422Validation Error1814ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found28114ms
Path Parameters
item_id2 / 2
#validinvalidschema
15027{
25027 "format": "uuid4",
3509n/a "type": "string"
45027}
Headers
accept-language3 / 3
1263n/a{
2263n/a "anyOf": [
3210n/a {
4210n/a "type": "string"
5210n/a },
653210 {
753210 "type": "null"
853210 }
9263n/a ],
10263n/a}
Body
application/json21 / 22
UpdateHouseholdAdmin
136589{
236879 "properties": {
34388 "groupId": {
44382 "format": "uuid4",
54406 "type": "string"
64388 },
743511 "id": {
84350 "format": "uuid4",
943511 "type": "string"
1043511 },
1143214 "name": {
124329 "minLength": 1,
134415 "type": "string"
1443214 },
1511255 "preferences": {
1611255 "anyOf": [
1758109 {
1958109 },
2054113 {
2154113 "type": "null"
2254113 }
2311255 ]
2411255 }
2536879 },
264443 "required": [
274461 "groupId",
284461 "name",
294461 "id"
304443 ],
314477 "type": "object"
3236589}
Referenced Components (1)11 of 11 keywords
UpdateHouseholdPreferences11 of 11 keywords
158109{
24251 "properties": {
3717 "firstDayOfWeek": {
4717 "type": "integer"
5717 },
6687 "lockRecipeEditsFromOtherHouseholds": {
7687 "type": "boolean"
8687 },
9726 "privateHousehold": {
10726 "type": "boolean"
11726 },
12669 "recipeDisableComments": {
13669 "type": "boolean"
14669 },
15686 "recipeLandscapeView": {
16686 "type": "boolean"
17686 },
18657 "recipePublic": {
19657 "type": "boolean"
20657 },
21676 "recipeShowAssets": {
22676 "type": "boolean"
23676 },
24589 "recipeShowNutrition": {
25589 "type": "boolean"
26589 }
274251 },
2810958 "type": "object"
2958109}
Responses
codedescriptionhitsavg
200Successful Response22856ms
422Validation Error1265ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error13919ms
400Bad Request161ms
Examples
Body: application/json
0UpdateHouseholdPreferences.firstDayOfWeek
trueUpdateHouseholdPreferences.lockRecipeEditsFromOtherHouseholds
trueUpdateHouseholdPreferences.privateHousehold
falseUpdateHouseholdPreferences.recipeDisableComments
falseUpdateHouseholdPreferences.recipeLandscapeView
trueUpdateHouseholdPreferences.recipePublic
falseUpdateHouseholdPreferences.recipeShowAssets
falseUpdateHouseholdPreferences.recipeShowNutrition
Admin: Manage Users 7 operations 3 covered 1 partial 3 uncovered 0 not measured 48% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1374n/a{
2374n/a "anyOf": [
3273n/a {
4273n/a "type": "string"
5273n/a },
6101273 {
7101273 "type": "null"
8101273 }
9374n/a ],
10374n/a}
orderByNullPosition5 / 5
1148187{
2148187 "anyOf": [
3117218 {
5117218 },
631304 {
731304 "type": "null"
831304 }
9148187 ],
10148187}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1117218{
2117218 "enum": [
361n/a "first",
456n/a "last"
5117218 ],
6304n/a "type": "string"
7117218}
orderDirection2 / 2
OrderDirection
126585{
226585 "enum": [
3166n/a "asc",
499n/a "desc"
526585 ],
6350n/a "type": "string"
726585}
queryFilter3 / 3
1271n/a{
2271n/a "anyOf": [
3217n/a {
4217n/a "type": "string"
5217n/a },
654217 {
754217 "type": "null"
854217 }
9271n/a ],
10271n/a}
paginationSeed3 / 3
1302n/a{
2302n/a "anyOf": [
3234n/a {
4234n/a "type": "string"
5234n/a },
668234 {
768234 "type": "null"
868234 }
9302n/a ],
10302n/a}
page1 / 1
125385{
225385 "type": "integer"
325385}
perPage1 / 1
125624{
225624 "type": "integer"
325624}
Headers
accept-language3 / 3
1482n/a{
2482n/a "anyOf": [
3306n/a {
4306n/a "type": "string"
5306n/a },
6176306 {
7176306 "type": "null"
8176306 }
9482n/a ],
10482n/a}
Responses
codedescriptionhitsavg
200Successful Response25623ms
422Validation Error32313ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4712ms
500Internal Server Error421ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1447n/a{
2447n/a "anyOf": [
3357n/a {
4357n/a "type": "string"
5357n/a },
690357 {
790357 "type": "null"
890357 }
9447n/a ],
10447n/a}
Body
application/json25 / 26
UserIn
1364164{
2391132 "properties": {
324314 "admin": {
424314 "type": "boolean"
524314 },
62415 "advanced": {
72415 "type": "boolean"
82415 },
921124 "authMethod": {
1121124 },
122386 "canInvite": {
132386 "type": "boolean"
142386 },
1523813 "canManage": {
1623813 "type": "boolean"
1723813 },
182237 "canManageHousehold": {
192237 "type": "boolean"
202237 },
2122312 "canOrganize": {
2222312 "type": "boolean"
2322312 },
245166 "email": {
255166 "type": "string"
265166 },
275148 "fullName": {
285148 "type": "string"
295148 },
3020724 "group": {
3120724 "anyOf": [
3296135 {
3396135 "type": "string"
3496135 },
35111120 {
36111120 "type": "null"
37111120 }
3820724 ],
3920724 },
4023313 "household": {
4123313 "anyOf": [
4298148 {
4398148 "type": "string"
4498148 },
45135111 {
46135111 "type": "null"
47135111 }
4823313 ],
4923313 },
5023216 "id": {
5123216 "anyOf": [
5217771 {
531770 "format": "uuid4",
5417771 "type": "string"
5517771 },
5655193 {
5755193 "type": "null"
5855193 }
5923216 ],
6023216 },
6150913 "password": {
6250913 "type": "string"
6350913 },
6448613 "username": {
6548613 "type": "string"
6648613 }
67391132 },
6849627 "required": [
6949924 "username",
705221 "fullName",
715221 "email",
725221 "password"
7349627 ],
745235 "type": "object"
75364164}
Referenced Components (1)3 of 3 keywords
AuthMethod3 of 3 keywords
121124{
221124 "enum": [
3119n/a "Mealie",
442n/a "LDAP",
550n/a "OIDC"
621124 ],
722510 "type": "string"
821124}
Responses
codedescriptionhitsavg
201Successful Response2219ms
422Validation Error4244ms
Undocumented - not in spec
codedescriptionhitsavg
409Conflict33115ms
400Bad Request14944ms
Examples
Body: application/json
{ "admin": "false", "email": "changeme@example.com", "fullName": "Change Me", "group": "Home", "household": "Family", "username": "ChangeMe" }UserIn
falseUserIn.admin
falseUserIn.advanced
"Mealie"UserIn.authMethod
falseUserIn.canInvite
falseUserIn.canManage
falseUserIn.canManageHousehold
falseUserIn.canOrganize
Headers
accept-languageno coverage data
#validinvalidschema
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Body
application/jsonno coverage data
ForgotPassword
100{
200 "properties": {
300 "email": {
400 "type": "string"
500 }
600 },
700 "required": [
800 "email"
900 ],
1000 "type": "object"
1100}
Expected Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error0never seen
Query Parameters
force1 / 1
#validinvalidschema
182358{
282358 "type": "boolean"
382358}
Headers
accept-language3 / 3
1436n/a{
2436n/a "anyOf": [
3350n/a {
4350n/a "type": "string"
5350n/a },
686350 {
786350 "type": "null"
886350 }
9436n/a ],
10436n/a}
Responses
codedescriptionhitsavg
200Successful Response16212ms
422Validation Error3589ms
Examples
Query
falseforce
Path Parameters
item_idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Headers
accept-languageno coverage data
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Path Parameters
item_id2 / 2
#validinvalidschema
152745{
252745 "format": "uuid4",
3572n/a "type": "string"
452745}
Headers
accept-language3 / 3
1242n/a{
2242n/a "anyOf": [
3152n/a {
4152n/a "type": "string"
5152n/a },
690152 {
790152 "type": "null"
890152 }
9242n/a ],
10242n/a}
Responses
codedescriptionhitsavg
200Successful Response21914ms
422Validation Error4513ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found30814ms
Path Parameters
item_idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Headers
accept-languageno coverage data
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Body
application/jsonno coverage data
UserOut
100{
200 "properties": {
300 "admin": {
400 "type": "boolean"
500 },
600 "advanced": {
700 "type": "boolean"
800 },
900 "authMethod": {
1100 },
1200 "cacheKey": {
1300 "type": "string"
1400 },
1500 "canInvite": {
1600 "type": "boolean"
1700 },
1800 "canManage": {
1900 "type": "boolean"
2000 },
2100 "canManageHousehold": {
2200 "type": "boolean"
2300 },
2400 "canOrganize": {
2500 "type": "boolean"
2600 },
2700 "email": {
2800 "type": "string"
2900 },
3000 "fullName": {
3100 "anyOf": [
3200 {
3300 "type": "string"
3400 },
3500 {
3600 "type": "null"
3700 }
3800 ],
3900 },
4000 "group": {
4100 "type": "string"
4200 },
4300 "groupId": {
4400 "format": "uuid4",
4500 "type": "string"
4600 },
4700 "groupSlug": {
4800 "type": "string"
4900 },
5000 "household": {
5100 "type": "string"
5200 },
5300 "householdId": {
5400 "format": "uuid4",
5500 "type": "string"
5600 },
5700 "householdSlug": {
5800 "type": "string"
5900 },
6000 "id": {
6100 "format": "uuid4",
6200 "type": "string"
6300 },
6400 "tokens": {
6500 "anyOf": [
6600 {
6700 "items": {
6900 },
7000 "type": "array"
7100 },
7200 {
7300 "type": "null"
7400 }
7500 ],
7600 },
7700 "username": {
7800 "anyOf": [
7900 {
8000 "type": "string"
8100 },
8200 {
8300 "type": "null"
8400 }
8500 ],
8600 }
8700 },
8800 "required": [
8900 "id",
9000 "email",
9100 "group",
9200 "household",
9300 "groupId",
9400 "groupSlug",
9500 "householdId",
9600 "householdSlug",
9700 "cacheKey"
9800 ],
9900 "type": "object"
10000}
Referenced Components (2)0 of 15 keywords
AuthMethod0 of 3 keywords
100{
200 "enum": [
30n/a "Mealie",
40n/a "LDAP",
50n/a "OIDC"
600 ],
700 "type": "string"
800}
LongLiveTokenOut0 of 12 keywords
100{
200 "properties": {
300 "createdAt": {
400 "anyOf": [
500 {
600 "format": "date-time",
700 "type": "string"
800 },
900 {
1000 "type": "null"
1100 }
1200 ],
1300 },
1400 "id": {
1500 "type": "integer"
1600 },
1700 "name": {
1800 "type": "string"
1900 }
2000 },
2100 "required": [
2200 "name",
2300 "id"
2400 ],
2500 "type": "object"
2600}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
App: About 3 operations 3 covered 0 partial 0 uncovered 0 not measured — #
Responses
codedescriptionhitsavg
200Successful Response97ms
Responses
codedescriptionhitsavg
200Successful Response94ms
Responses
codedescriptionhitsavg
200Successful Response91ms
Explore: Categories 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1531n/a{
2531n/a "type": "string"
3531n/a}
Query Parameters
search3 / 3
1205n/a{
2205n/a "anyOf": [
3163n/a {
4163n/a "type": "string"
5163n/a },
642163 {
742163 "type": "null"
842163 }
9205n/a ],
10205n/a}
orderBy3 / 3
1241n/a{
2241n/a "anyOf": [
3172n/a {
4172n/a "type": "string"
5172n/a },
669172 {
769172 "type": "null"
869172 }
9241n/a ],
10241n/a}
orderByNullPosition5 / 5
178153{
278153 "anyOf": [
359172 {
559172 },
619212 {
719212 "type": "null"
819212 }
978153 ],
1078153}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
159172{
259172 "enum": [
338n/a "first",
421n/a "last"
559172 ],
6212n/a "type": "string"
759172}
orderDirection2 / 2
OrderDirection
117530{
217530 "enum": [
390n/a "asc",
485n/a "desc"
517530 ],
6205n/a "type": "string"
717530}
queryFilter3 / 3
1205n/a{
2205n/a "anyOf": [
3155n/a {
4155n/a "type": "string"
5155n/a },
650155 {
750155 "type": "null"
850155 }
9205n/a ],
10205n/a}
paginationSeed3 / 3
1228n/a{
2228n/a "anyOf": [
3157n/a {
4157n/a "type": "string"
5157n/a },
671157 {
771157 "type": "null"
871157 }
9228n/a ],
10228n/a}
page1 / 1
1149137{
2149137 "type": "integer"
3149137}
perPage1 / 1
116926{
216926 "type": "integer"
316926}
Headers
accept-language3 / 3
1275n/a{
2275n/a "anyOf": [
3184n/a {
4184n/a "type": "string"
5184n/a },
691184 {
791184 "type": "null"
891184 }
9275n/a ],
10275n/a}
Responses
codedescriptionhitsavg
200Successful Response7019ms
422Validation Error11622ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found33528ms
400Bad Request821ms
500Internal Server Error224ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id2 / 2
#validinvalidschema
159023{
259023 "format": "uuid4",
3613n/a "type": "string"
459023}
group_slug1 / 1
1613n/a{
2613n/a "type": "string"
3613n/a}
Headers
accept-language3 / 3
1126n/a{
2126n/a "anyOf": [
381n/a {
481n/a "type": "string"
581n/a },
64581 {
74581 "type": "null"
84581 }
9126n/a ],
10126n/a}
Responses
codedescriptionhitsavg
200Successful Response18918ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found42419ms
Explore: Cookbooks 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1533n/a{
2533n/a "type": "string"
3533n/a}
Query Parameters
search3 / 3
1191n/a{
2191n/a "anyOf": [
3136n/a {
4136n/a "type": "string"
5136n/a },
655136 {
755136 "type": "null"
855136 }
9191n/a ],
10191n/a}
orderBy3 / 3
1357n/a{
2357n/a "anyOf": [
3241n/a {
4241n/a "type": "string"
5241n/a },
6116241 {
7116241 "type": "null"
8116241 }
9357n/a ],
10357n/a}
orderByNullPosition5 / 5
1100121{
2100121 "anyOf": [
354167 {
554167 },
646175 {
746175 "type": "null"
846175 }
9100121 ],
10100121}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
154167{
254167 "enum": [
343n/a "first",
411n/a "last"
554167 ],
6175n/a "type": "string"
754167}
orderDirection2 / 2
OrderDirection
117924{
217924 "enum": [
3101n/a "asc",
478n/a "desc"
517924 ],
6203n/a "type": "string"
717924}
queryFilter3 / 3
1215n/a{
2215n/a "anyOf": [
3154n/a {
4154n/a "type": "string"
5154n/a },
661154 {
761154 "type": "null"
861154 }
9215n/a ],
10215n/a}
paginationSeed3 / 3
1215n/a{
2215n/a "anyOf": [
3151n/a {
4151n/a "type": "string"
5151n/a },
664151 {
764151 "type": "null"
864151 }
9215n/a ],
10215n/a}
page1 / 1
117331{
217331 "type": "integer"
317331}
perPage1 / 1
1153135{
2153135 "type": "integer"
3153135}
Headers
accept-language3 / 3
1260n/a{
2260n/a "anyOf": [
3179n/a {
4179n/a "type": "string"
5179n/a },
681179 {
781179 "type": "null"
881179 }
9260n/a ],
10260n/a}
Responses
codedescriptionhitsavg
200Successful Response7225ms
422Validation Error11619ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found33128ms
400Bad Request718ms
500Internal Server Error722ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id4 / 4
#validinvalidschema
1573n/a{
2573n/a "anyOf": [
353637 {
453637 "format": "uuid4",
5573n/a "type": "string"
653637 },
7573n/a {
8573n/a "type": "string"
9573n/a }
10573n/a ],
11573n/a}
group_slug1 / 1
1573n/a{
2573n/a "type": "string"
3573n/a}
Headers
accept-language3 / 3
1336n/a{
2336n/a "anyOf": [
3207n/a {
4207n/a "type": "string"
5207n/a },
6129207 {
7129207 "type": "null"
8129207 }
9336n/a ],
10336n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found57326ms
Explore: Foods 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1527n/a{
2527n/a "type": "string"
3527n/a}
Query Parameters
search3 / 3
1254n/a{
2254n/a "anyOf": [
3190n/a {
4190n/a "type": "string"
5190n/a },
664190 {
764190 "type": "null"
864190 }
9254n/a ],
10254n/a}
orderBy3 / 3
1290n/a{
2290n/a "anyOf": [
3215n/a {
4215n/a "type": "string"
5215n/a },
675215 {
775215 "type": "null"
875215 }
9290n/a ],
10290n/a}
orderByNullPosition5 / 5
1159180{
2159180 "anyOf": [
385254 {
585254 },
674265 {
774265 "type": "null"
874265 }
9159180 ],
10159180}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
185254{
285254 "enum": [
357n/a "first",
428n/a "last"
585254 ],
6265n/a "type": "string"
785254}
orderDirection2 / 2
OrderDirection
120433{
220433 "enum": [
3132n/a "asc",
472n/a "desc"
520433 ],
6237n/a "type": "string"
720433}
queryFilter3 / 3
1254n/a{
2254n/a "anyOf": [
3193n/a {
4193n/a "type": "string"
5193n/a },
661193 {
761193 "type": "null"
861193 }
9254n/a ],
10254n/a}
paginationSeed3 / 3
1266n/a{
2266n/a "anyOf": [
3214n/a {
4214n/a "type": "string"
5214n/a },
652214 {
752214 "type": "null"
852214 }
9266n/a ],
10266n/a}
page1 / 1
117874{
217874 "type": "integer"
317874}
perPage1 / 1
118560{
218560 "type": "integer"
318560}
Headers
accept-language3 / 3
1364n/a{
2364n/a "anyOf": [
3231n/a {
4231n/a "type": "string"
5231n/a },
6133231 {
7133231 "type": "null"
8133231 }
9364n/a ],
10364n/a}
Responses
codedescriptionhitsavg
200Successful Response8134ms
422Validation Error10123ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found32629ms
400Bad Request1921ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id2 / 2
#validinvalidschema
158518{
258518 "format": "uuid4",
3603n/a "type": "string"
458518}
group_slug1 / 1
1603n/a{
2603n/a "type": "string"
3603n/a}
Headers
accept-language3 / 3
1106n/a{
2106n/a "anyOf": [
375n/a {
475n/a "type": "string"
575n/a },
63175 {
73175 "type": "null"
83175 }
9106n/a ],
10106n/a}
Responses
codedescriptionhitsavg
200Successful Response18522ms
422Validation Error318ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found41523ms
Explore: Households 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1550n/a{
2550n/a "type": "string"
3550n/a}
Query Parameters
orderBy3 / 3
1271n/a{
2271n/a "anyOf": [
3200n/a {
4200n/a "type": "string"
5200n/a },
671200 {
771200 "type": "null"
871200 }
9271n/a ],
10271n/a}
orderByNullPosition5 / 5
194221{
294221 "anyOf": [
374241 {
574241 },
620295 {
720295 "type": "null"
820295 }
994221 ],
1094221}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
174241{
274241 "enum": [
345n/a "first",
429n/a "last"
574241 ],
6295n/a "type": "string"
774241}
orderDirection2 / 2
OrderDirection
1167105{
2167105 "enum": [
3101n/a "asc",
466n/a "desc"
5167105 ],
6272n/a "type": "string"
7167105}
queryFilter3 / 3
1237n/a{
2237n/a "anyOf": [
3181n/a {
4181n/a "type": "string"
5181n/a },
656181 {
756181 "type": "null"
856181 }
9237n/a ],
10237n/a}
paginationSeed3 / 3
1290n/a{
2290n/a "anyOf": [
3224n/a {
4224n/a "type": "string"
5224n/a },
666224 {
766224 "type": "null"
866224 }
9290n/a ],
10290n/a}
page1 / 1
119920{
219920 "type": "integer"
319920}
perPage1 / 1
117436{
217436 "type": "integer"
317436}
Headers
accept-language3 / 3
1346n/a{
2346n/a "anyOf": [
3237n/a {
4237n/a "type": "string"
5237n/a },
6109237 {
7109237 "type": "null"
8109237 }
9346n/a ],
10346n/a}
Responses
codedescriptionhitsavg
200Successful Response6419ms
422Validation Error12822ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found34726ms
400Bad Request1121ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
household_slug1 / 1
#validinvalidschema
1585n/a{
2585n/a "type": "string"
3585n/a}
group_slug1 / 1
1585n/a{
2585n/a "type": "string"
3585n/a}
Headers
accept-language3 / 3
1334n/a{
2334n/a "anyOf": [
3214n/a {
4214n/a "type": "string"
5214n/a },
6120214 {
7120214 "type": "null"
8120214 }
9334n/a ],
10334n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found58521ms
Explore: Recipes 3 operations 1 covered 2 partial 0 uncovered 0 not measured 87% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1627n/a{
2627n/a "type": "string"
3627n/a}
Query Parameters
categories5 / 7
1188114{
2188114 "anyOf": [
3188114 {
4188n/a "items": {
5959n/a "anyOf": [
696978 {
796863 "format": "uuid4",
8959n/a "type": "string"
996978 },
10959n/a {
11959n/a "type": "string"
12959n/a }
13959n/a ]
14188n/a },
153020 "type": "array"
16188114 },
170302 {
180302 "type": "null"
190302 }
20188114 ],
21188114}
tags5 / 7
114697{
214697 "anyOf": [
314697 {
4146n/a "items": {
5348n/a "anyOf": [
681382 {
781267 "format": "uuid4",
8348n/a "type": "string"
981382 },
10348n/a {
11348n/a "type": "string"
12348n/a }
13348n/a ]
14146n/a },
152430 "type": "array"
1614697 },
170243 {
180243 "type": "null"
190243 }
2014697 ],
2114697}
tools5 / 7
1168111{
2168111 "anyOf": [
3168111 {
4168n/a "items": {
5807n/a "anyOf": [
681937 {
781726 "format": "uuid4",
8807n/a "type": "string"
981937 },
10807n/a {
11807n/a "type": "string"
12807n/a }
13807n/a ]
14168n/a },
152790 "type": "array"
16168111 },
170279 {
180279 "type": "null"
190279 }
20168111 ],
21168111}
foods5 / 7
113979{
213979 "anyOf": [
313979 {
4139n/a "items": {
5351n/a "anyOf": [
695335 {
795256 "format": "uuid4",
8351n/a "type": "string"
995335 },
10351n/a {
11351n/a "type": "string"
12351n/a }
13351n/a ]
14139n/a },
152180 "type": "array"
1613979 },
170218 {
180218 "type": "null"
190218 }
2013979 ],
2113979}
households5 / 7
121596{
221596 "anyOf": [
321596 {
4215n/a "items": {
5797n/a "anyOf": [
694817 {
794703 "format": "uuid4",
8797n/a "type": "string"
994817 },
10797n/a {
11797n/a "type": "string"
12797n/a }
13797n/a ]
14215n/a },
153110 "type": "array"
1621596 },
170311 {
180311 "type": "null"
190311 }
2021596 ],
2121596}
orderBy3 / 3
1344n/a{
2344n/a "anyOf": [
3251n/a {
4251n/a "type": "string"
5251n/a },
693251 {
793251 "type": "null"
893251 }
9344n/a ],
10344n/a}
orderByNullPosition5 / 5
120998{
220998 "anyOf": [
3137170 {
5137170 },
672235 {
772235 "type": "null"
872235 }
920998 ],
1020998}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1137170{
2137170 "enum": [
3113n/a "first",
424n/a "last"
5137170 ],
6235n/a "type": "string"
7137170}
orderDirection2 / 2
OrderDirection
122720{
222720 "enum": [
3156n/a "asc",
471n/a "desc"
522720 ],
6247n/a "type": "string"
722720}
queryFilter3 / 3
1307n/a{
2307n/a "anyOf": [
3220n/a {
4220n/a "type": "string"
5220n/a },
687220 {
787220 "type": "null"
887220 }
9307n/a ],
10307n/a}
paginationSeed3 / 3
1274n/a{
2274n/a "anyOf": [
3212n/a {
4212n/a "type": "string"
5212n/a },
662212 {
762212 "type": "null"
862212 }
9274n/a ],
10274n/a}
page1 / 1
121312{
221312 "type": "integer"
321312}
perPage1 / 1
121713{
221713 "type": "integer"
321713}
cookbook5 / 5
1350n/a{
2350n/a "anyOf": [
3100250 {
4100162 "format": "uuid4",
5262n/a "type": "string"
6100250 },
7262n/a {
8262n/a "type": "string"
9262n/a },
1088262 {
1188262 "type": "null"
1288262 }
13350n/a ],
14350n/a}
requireAllCategories1 / 1
122314{
222314 "type": "boolean"
322314}
requireAllTags1 / 1
120166{
220166 "type": "boolean"
320166}
requireAllTools1 / 1
122217{
222217 "type": "boolean"
322217}
requireAllFoods1 / 1
121510{
221510 "type": "boolean"
321510}
search3 / 3
1267n/a{
2267n/a "anyOf": [
3205n/a {
4205n/a "type": "string"
5205n/a },
662205 {
762205 "type": "null"
862205 }
9267n/a ],
10267n/a}
Headers
accept-language3 / 3
1546n/a{
2546n/a "anyOf": [
3383n/a {
4383n/a "type": "string"
5383n/a },
6163383 {
7163383 "type": "null"
8163383 }
9546n/a ],
10546n/a}
Responses
codedescriptionhitsavg
200Successful Response6825ms
422Validation Error7027ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found47222ms
500Internal Server Error719ms
400Bad Request1020ms
Examples
Query
"desc"orderDirection
1page
50perPage
falserequireAllCategories
falserequireAllTags
falserequireAllTools
falserequireAllFoods
Path Parameters
group_slug1 / 1
#validinvalidschema
1551n/a{
2551n/a "type": "string"
3551n/a}
Query Parameters
foods3 / 5
1100188{
2100188 "anyOf": [
3100188 {
4100188 "items": {
5240398 "format": "uuid4",
6638n/a "type": "string"
7100188 },
82880 "type": "array"
9100188 },
100288 {
110288 "type": "null"
120288 }
13100188 ],
14100188}
tools3 / 5
180190{
280190 "anyOf": [
380190 {
480190 "items": {
5192577 "format": "uuid4",
6769n/a "type": "string"
780190 },
82700 "type": "array"
980190 },
100270 {
110270 "type": "null"
120270 }
1380190 ],
1480190}
orderBy3 / 3
1220n/a{
2220n/a "anyOf": [
3171n/a {
4171n/a "type": "string"
5171n/a },
649171 {
749171 "type": "null"
849171 }
9220n/a ],
10220n/a}
orderByNullPosition5 / 5
1168112{
2168112 "anyOf": [
3109171 {
5109171 },
659221 {
759221 "type": "null"
859221 }
9168112 ],
10168112}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1109171{
2109171 "enum": [
373n/a "first",
436n/a "last"
5109171 ],
6221n/a "type": "string"
7109171}
orderDirection2 / 2
OrderDirection
118220{
218220 "enum": [
3132n/a "asc",
450n/a "desc"
518220 ],
6202n/a "type": "string"
718220}
queryFilter3 / 3
1236n/a{
2236n/a "anyOf": [
3166n/a {
4166n/a "type": "string"
5166n/a },
670166 {
770166 "type": "null"
870166 }
9236n/a ],
10236n/a}
paginationSeed3 / 3
1263n/a{
2263n/a "anyOf": [
3184n/a {
4184n/a "type": "string"
5184n/a },
679184 {
779184 "type": "null"
879184 }
9263n/a ],
10263n/a}
limit1 / 1
118930{
218930 "type": "integer"
318930}
maxMissingFoods1 / 1
119814{
219814 "type": "integer"
319814}
maxMissingTools1 / 1
115273{
215273 "type": "integer"
315273}
includeFoodsOnHand1 / 1
120717{
220717 "type": "boolean"
320717}
includeToolsOnHand1 / 1
120121{
220121 "type": "boolean"
320121}
Headers
accept-language3 / 3
1381n/a{
2381n/a "anyOf": [
3271n/a {
4271n/a "type": "string"
5271n/a },
6110271 {
7110271 "type": "null"
8110271 }
9381n/a ],
10381n/a}
Responses
codedescriptionhitsavg
200Successful Response6921ms
422Validation Error12627ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found34931ms
400Bad Request516ms
500Internal Server Error230ms
Examples
Query
"desc"orderDirection
10limit
5maxMissingFoods
5maxMissingTools
trueincludeFoodsOnHand
trueincludeToolsOnHand
Path Parameters
recipe_slug1 / 1
#validinvalidschema
1598n/a{
2598n/a "type": "string"
3598n/a}
group_slug1 / 1
1598n/a{
2598n/a "type": "string"
3598n/a}
Headers
accept-language3 / 3
1336n/a{
2336n/a "anyOf": [
3213n/a {
4213n/a "type": "string"
5213n/a },
6123213 {
7123213 "type": "null"
8123213 }
9336n/a ],
10336n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found59830ms
Explore: Tags 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1524n/a{
2524n/a "type": "string"
3524n/a}
Query Parameters
search3 / 3
1279n/a{
2279n/a "anyOf": [
3199n/a {
4199n/a "type": "string"
5199n/a },
680199 {
780199 "type": "null"
880199 }
9279n/a ],
10279n/a}
orderBy3 / 3
1380n/a{
2380n/a "anyOf": [
3251n/a {
4251n/a "type": "string"
5251n/a },
6129251 {
7129251 "type": "null"
8129251 }
9380n/a ],
10380n/a}
orderByNullPosition5 / 5
1215150{
2215150 "anyOf": [
3145220 {
5145220 },
670295 {
770295 "type": "null"
870295 }
9215150 ],
10215150}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1145220{
2145220 "enum": [
385n/a "first",
460n/a "last"
5145220 ],
6295n/a "type": "string"
7145220}
orderDirection2 / 2
OrderDirection
125835{
225835 "enum": [
3131n/a "asc",
4127n/a "desc"
525835 ],
6293n/a "type": "string"
725835}
queryFilter3 / 3
1298n/a{
2298n/a "anyOf": [
3243n/a {
4243n/a "type": "string"
5243n/a },
655243 {
755243 "type": "null"
855243 }
9298n/a ],
10298n/a}
paginationSeed3 / 3
1317n/a{
2317n/a "anyOf": [
3210n/a {
4210n/a "type": "string"
5210n/a },
6107210 {
7107210 "type": "null"
8107210 }
9317n/a ],
10317n/a}
page1 / 1
126020{
226020 "type": "integer"
326020}
perPage1 / 1
119277{
219277 "type": "integer"
319277}
Headers
accept-language3 / 3
1345n/a{
2345n/a "anyOf": [
3222n/a {
4222n/a "type": "string"
5222n/a },
6123222 {
7123222 "type": "null"
8123222 }
9345n/a ],
10345n/a}
Responses
codedescriptionhitsavg
200Successful Response7325ms
422Validation Error8125ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found32427ms
400Bad Request4519ms
500Internal Server Error128ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id2 / 2
#validinvalidschema
158624{
258624 "format": "uuid4",
3610n/a "type": "string"
458624}
group_slug1 / 1
1610n/a{
2610n/a "type": "string"
3610n/a}
Headers
accept-language3 / 3
1153n/a{
2153n/a "anyOf": [
392n/a {
492n/a "type": "string"
592n/a },
66192 {
76192 "type": "null"
86192 }
9153n/a ],
10153n/a}
Responses
codedescriptionhitsavg
200Successful Response17217ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found43821ms
Explore: Tools 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1522n/a{
2522n/a "type": "string"
3522n/a}
Query Parameters
search3 / 3
1277n/a{
2277n/a "anyOf": [
3226n/a {
4226n/a "type": "string"
5226n/a },
651226 {
751226 "type": "null"
851226 }
9277n/a ],
10277n/a}
orderBy3 / 3
1282n/a{
2282n/a "anyOf": [
3246n/a {
4246n/a "type": "string"
5246n/a },
636246 {
736246 "type": "null"
836246 }
9282n/a ],
10282n/a}
orderByNullPosition5 / 5
1213133{
2213133 "anyOf": [
3144202 {
5144202 },
669277 {
769277 "type": "null"
869277 }
9213133 ],
10213133}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1144202{
2144202 "enum": [
390n/a "first",
454n/a "last"
5144202 ],
6277n/a "type": "string"
7144202}
orderDirection2 / 2
OrderDirection
126139{
226139 "enum": [
3153n/a "asc",
4108n/a "desc"
526139 ],
6300n/a "type": "string"
726139}
queryFilter3 / 3
1305n/a{
2305n/a "anyOf": [
3206n/a {
4206n/a "type": "string"
5206n/a },
699206 {
799206 "type": "null"
899206 }
9305n/a ],
10305n/a}
paginationSeed3 / 3
1357n/a{
2357n/a "anyOf": [
3244n/a {
4244n/a "type": "string"
5244n/a },
6113244 {
7113244 "type": "null"
8113244 }
9357n/a ],
10357n/a}
page1 / 1
122273{
222273 "type": "integer"
322273}
perPage1 / 1
124933{
224933 "type": "integer"
324933}
Headers
accept-language3 / 3
1448n/a{
2448n/a "anyOf": [
3272n/a {
4272n/a "type": "string"
5272n/a },
6176272 {
7176272 "type": "null"
8176272 }
9448n/a ],
10448n/a}
Responses
codedescriptionhitsavg
200Successful Response5427ms
422Validation Error7618ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found32427ms
500Internal Server Error687ms
400Bad Request6226ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id2 / 2
#validinvalidschema
153941{
253941 "format": "uuid4",
3580n/a "type": "string"
453941}
group_slug1 / 1
1580n/a{
2580n/a "type": "string"
3580n/a}
Headers
accept-language3 / 3
1126n/a{
2126n/a "anyOf": [
386n/a {
486n/a "type": "string"
586n/a },
64086 {
74086 "type": "null"
84086 }
9126n/a ],
10126n/a}
Responses
codedescriptionhitsavg
200Successful Response18523ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found39521ms
Groups: Households 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1402n/a{
2402n/a "anyOf": [
3286n/a {
4286n/a "type": "string"
5286n/a },
6116286 {
7116286 "type": "null"
8116286 }
9402n/a ],
10402n/a}
orderByNullPosition5 / 5
1196209{
2196209 "anyOf": [
3105300 {
5105300 },
691314 {
791314 "type": "null"
891314 }
9196209 ],
10196209}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1105300{
2105300 "enum": [
357n/a "first",
448n/a "last"
5105300 ],
6314n/a "type": "string"
7105300}
orderDirection2 / 2
OrderDirection
124656{
224656 "enum": [
3167n/a "asc",
479n/a "desc"
524656 ],
6302n/a "type": "string"
724656}
queryFilter3 / 3
1346n/a{
2346n/a "anyOf": [
3233n/a {
4233n/a "type": "string"
5233n/a },
6113233 {
7113233 "type": "null"
8113233 }
9346n/a ],
10346n/a}
paginationSeed3 / 3
1371n/a{
2371n/a "anyOf": [
3289n/a {
4289n/a "type": "string"
5289n/a },
682289 {
782289 "type": "null"
882289 }
9371n/a ],
10371n/a}
page1 / 1
1157151{
2157151 "type": "integer"
3157151}
perPage1 / 1
123328{
223328 "type": "integer"
323328}
Headers
accept-language3 / 3
1313n/a{
2313n/a "anyOf": [
3224n/a {
4224n/a "type": "string"
5224n/a },
689224 {
789224 "type": "null"
889224 }
9313n/a ],
10313n/a}
Responses
codedescriptionhitsavg
200Successful Response19214ms
422Validation Error32513ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3414ms
500Internal Server Error515ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
household_slug1 / 1
#validinvalidschema
1504n/a{
2504n/a "type": "string"
3504n/a}
Headers
accept-language3 / 3
1273n/a{
2273n/a "anyOf": [
3172n/a {
4172n/a "type": "string"
5172n/a },
6101172 {
7101172 "type": "null"
8101172 }
9273n/a ],
10273n/a}
Responses
codedescriptionhitsavg
200Successful Response2028ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found48414ms
Groups: Migrations 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1584n/a{
2584n/a "anyOf": [
3341n/a {
4341n/a "type": "string"
5341n/a },
6243341 {
7243341 "type": "null"
8243341 }
9584n/a ],
10584n/a}
Body
multipart/form-data9 / 9
Body_start_data_migration_api_groups_migrations_post
1248288{
2282247 "properties": {
312227 "add_migration_tag": {
412227 "type": "boolean"
512227 },
6522n/a "archive": {
7522n/a "format": "binary",
8522n/a "type": "string"
9522n/a },
10277225 "migration_type": {
12277225 }
13282247 },
1449541 "required": [
1550234 "migration_type",
1652214 "archive"
1749541 ],
18536n/a "type": "object"
19248288}
Referenced Components (1)3 of 3 keywords
SupportedMigrations3 of 3 keywords
1277225{
2277225 "enum": [
334n/a "nextcloud",
422n/a "chowdown",
531n/a "copymethat",
623n/a "paprika",
78n/a "mealie_alpha",
810n/a "tandoor",
917n/a "plantoeat",
109n/a "myrecipebox",
1117n/a "recipekeeper",
12106n/a "cookn"
13277225 ],
14502n/a "type": "string"
15277225}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error78313ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request91ms
Examples
Body: multipart/form-data
falseBody_start_data_migration_api_groups_migrations_post.add_migration_tag
Groups: Multi Purpose Labels 5 operations 4 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
search3 / 3
#validinvalidschema
1237n/a{
2237n/a "anyOf": [
3195n/a {
4195n/a "type": "string"
5195n/a },
642195 {
742195 "type": "null"
842195 }
9237n/a ],
10237n/a}
orderBy3 / 3
1396n/a{
2396n/a "anyOf": [
3285n/a {
4285n/a "type": "string"
5285n/a },
6111285 {
7111285 "type": "null"
8111285 }
9396n/a ],
10396n/a}
orderByNullPosition5 / 5
1140243{
2140243 "anyOf": [
3101282 {
5101282 },
639344 {
739344 "type": "null"
839344 }
9140243 ],
10140243}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1101282{
2101282 "enum": [
351n/a "first",
450n/a "last"
5101282 ],
6344n/a "type": "string"
7101282}
orderDirection2 / 2
OrderDirection
122938{
222938 "enum": [
3135n/a "asc",
494n/a "desc"
522938 ],
6267n/a "type": "string"
722938}
queryFilter3 / 3
1280n/a{
2280n/a "anyOf": [
3197n/a {
4197n/a "type": "string"
5197n/a },
683197 {
783197 "type": "null"
883197 }
9280n/a ],
10280n/a}
paginationSeed3 / 3
1229n/a{
2229n/a "anyOf": [
3171n/a {
4171n/a "type": "string"
5171n/a },
658171 {
758171 "type": "null"
858171 }
9229n/a ],
10229n/a}
page1 / 1
122436{
222436 "type": "integer"
322436}
perPage1 / 1
120147{
220147 "type": "integer"
320147}
Headers
accept-language3 / 3
1462n/a{
2462n/a "anyOf": [
3285n/a {
4285n/a "type": "string"
5285n/a },
6177285 {
7177285 "type": "null"
8177285 }
9462n/a ],
10462n/a}
Responses
codedescriptionhitsavg
200Successful Response19414ms
422Validation Error30411ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6514ms
500Internal Server Error817ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1279n/a{
2279n/a "anyOf": [
3188n/a {
4188n/a "type": "string"
5188n/a },
691188 {
791188 "type": "null"
891188 }
9279n/a ],
10279n/a}
Body
application/json5 / 5
MultiPurposeLabelCreate
1194107{
222845 "properties": {
311031 "color": {
411031 "type": "string"
511031 },
620039 "name": {
720039 "type": "string"
820039 }
922845 },
1023956 "required": [
1123956 "name"
1223956 ],
132956 "type": "object"
14194107}
Responses
codedescriptionhitsavg
200Successful Response138ms
422Validation Error3524ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error193255ms
400Bad Request1051ms
Examples
Body: application/json
"#959595"MultiPurposeLabelCreate.color
Path Parameters
item_id2 / 2
#validinvalidschema
1397129{
2397129 "format": "uuid4",
3526n/a "type": "string"
4397129}
Headers
accept-language3 / 3
1155n/a{
2155n/a "anyOf": [
398n/a {
498n/a "type": "string"
598n/a },
65798 {
75798 "type": "null"
85798 }
9155n/a ],
10155n/a}
Responses
codedescriptionhitsavg
200Successful Response128ms
422Validation Error12913ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found39614ms
Path Parameters
item_id2 / 2
#validinvalidschema
1407127{
2407127 "format": "uuid4",
3534n/a "type": "string"
4407127}
Headers
accept-language3 / 3
1146n/a{
2146n/a "anyOf": [
398n/a {
498n/a "type": "string"
598n/a },
64898 {
74898 "type": "null"
84898 }
9146n/a ],
10146n/a}
Responses
codedescriptionhitsavg
200Successful Response33ms
422Validation Error12716ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error40414ms
Path Parameters
item_id2 / 2
#validinvalidschema
150965{
250965 "format": "uuid4",
3574n/a "type": "string"
450965}
Headers
accept-language3 / 3
1190n/a{
2190n/a "anyOf": [
3143n/a {
4143n/a "type": "string"
5143n/a },
647143 {
747143 "type": "null"
847143 }
9190n/a ],
10190n/a}
Body
application/json8 / 9
MultiPurposeLabelUpdate
131236{
231825 "properties": {
31325 "color": {
41325 "type": "string"
51325 },
63339 "groupId": {
73334 "format": "uuid4",
83375 "type": "string"
93339 },
103366 "id": {
113360 "format": "uuid4",
123366 "type": "string"
133366 },
143336 "name": {
153336 "type": "string"
163336 }
1731825 },
183376 "required": [
193394 "name",
203421 "groupId",
213421 "id"
223376 ],
233435 "type": "object"
2431236}
Responses
codedescriptionhitsavg
200Successful Response310ms
422Validation Error1945ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found26113ms
400Bad Request1161ms
Examples
Body: application/json
"#959595"MultiPurposeLabelUpdate.color
Groups: Reports 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
report_type5 / 5
#validinvalidschema
1112380{
2112380 "anyOf": [
377415 {
577415 },
635457 {
735457 "type": "null"
835457 }
9112380 ],
10112380}
Referenced Components (1)3 of 3 keywords
ReportCategory3 of 3 keywords
177415{
277415 "enum": [
327n/a "backup",
417n/a "restore",
517n/a "migration",
616n/a "bulk_import"
777415 ],
8457n/a "type": "string"
977415}
Headers
accept-language3 / 3
1416n/a{
2416n/a "anyOf": [
3264n/a {
4264n/a "type": "string"
5264n/a },
6152264 {
7152264 "type": "null"
8152264 }
9416n/a ],
10416n/a}
Responses
codedescriptionhitsavg
200Successful Response25117ms
422Validation Error38014ms
Path Parameters
item_id2 / 2
#validinvalidschema
1394138{
2394138 "format": "uuid4",
3532n/a "type": "string"
4394138}
Headers
accept-language3 / 3
1180n/a{
2180n/a "anyOf": [
3121n/a {
4121n/a "type": "string"
5121n/a },
659121 {
759121 "type": "null"
859121 }
9180n/a ],
10180n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error13813ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error39414ms
Path Parameters
item_id2 / 2
#validinvalidschema
148037{
248037 "format": "uuid4",
3517n/a "type": "string"
448037}
Headers
accept-language3 / 3
1116n/a{
2116n/a "anyOf": [
378n/a {
478n/a "type": "string"
578n/a },
63878 {
73878 "type": "null"
83878 }
9116n/a ],
10116n/a}
Responses
codedescriptionhitsavg
200Successful Response45612ms
422Validation Error3713ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2415ms
Groups: Seeders 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1350n/a{
2350n/a "anyOf": [
3219n/a {
4219n/a "type": "string"
5219n/a },
6131219 {
7131219 "type": "null"
8131219 }
9350n/a ],
10350n/a}
Body
application/json4 / 4
SeederConfig
1279200{
227935 "properties": {
327935 "locale": {
427935 "type": "string"
527935 }
627935 },
7314126 "required": [
8314126 "locale"
9314126 ],
1044039 "type": "object"
11279200}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error5318ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request201ms
Headers
accept-language3 / 3
#validinvalidschema
1443n/a{
2443n/a "anyOf": [
3261n/a {
4261n/a "type": "string"
5261n/a },
6182261 {
7182261 "type": "null"
8182261 }
9443n/a ],
10443n/a}
Body
application/json4 / 4
SeederConfig
1347144{
234774 "properties": {
334774 "locale": {
434774 "type": "string"
534774 }
634774 },
742154 "required": [
842154 "locale"
942154 ],
1047516 "type": "object"
11347144}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error5239ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request211ms
Headers
accept-language3 / 3
#validinvalidschema
1354n/a{
2354n/a "anyOf": [
3225n/a {
4225n/a "type": "string"
5225n/a },
6129225 {
7129225 "type": "null"
8129225 }
9354n/a ],
10354n/a}
Body
application/json4 / 4
SeederConfig
1218270{
2218150 "properties": {
3218150 "locale": {
4218150 "type": "string"
5218150 }
6218150 },
7368103 "required": [
8368103 "locale"
9368103 ],
1047117 "type": "object"
11218270}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error5378ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request121ms
Groups: Self Service 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1343n/a{
2343n/a "anyOf": [
3283n/a {
4283n/a "type": "string"
5283n/a },
660283 {
760283 "type": "null"
860283 }
9343n/a ],
10343n/a}
orderByNullPosition5 / 5
1142197{
2142197 "anyOf": [
3105234 {
5105234 },
637302 {
737302 "type": "null"
837302 }
9142197 ],
10142197}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1105234{
2105234 "enum": [
367n/a "first",
438n/a "last"
5105234 ],
6302n/a "type": "string"
7105234}
orderDirection2 / 2
OrderDirection
121053{
221053 "enum": [
3145n/a "asc",
465n/a "desc"
521053 ],
6263n/a "type": "string"
721053}
queryFilter3 / 3
1160n/a{
2160n/a "anyOf": [
3127n/a {
4127n/a "type": "string"
5127n/a },
633127 {
733127 "type": "null"
833127 }
9160n/a ],
10160n/a}
paginationSeed3 / 3
1272n/a{
2272n/a "anyOf": [
3202n/a {
4202n/a "type": "string"
5202n/a },
670202 {
770202 "type": "null"
870202 }
9272n/a ],
10272n/a}
page1 / 1
120549{
220549 "type": "integer"
320549}
perPage1 / 1
116526{
216526 "type": "integer"
316526}
Headers
accept-language3 / 3
1374n/a{
2374n/a "anyOf": [
3275n/a {
4275n/a "type": "string"
5275n/a },
699275 {
799275 "type": "null"
899275 }
9374n/a ],
10374n/a}
Responses
codedescriptionhitsavg
200Successful Response20714ms
422Validation Error28311ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6713ms
500Internal Server Error124ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
username_or_id4 / 4
#validinvalidschema
1505n/a{
2505n/a "anyOf": [
3505n/a {
4505n/a "type": "string"
5505n/a },
61504 {
71504 "format": "uuid4",
8505n/a "type": "string"
91504 }
10505n/a ],
11505n/a}
Headers
accept-language3 / 3
1353n/a{
2353n/a "anyOf": [
3222n/a {
4222n/a "type": "string"
5222n/a },
6131222 {
7131222 "type": "null"
8131222 }
9353n/a ],
10353n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found50514ms
Headers
accept-language3 / 3
#validinvalidschema
1357n/a{
2357n/a "anyOf": [
3233n/a {
4233n/a "type": "string"
5233n/a },
6124233 {
7124233 "type": "null"
8124233 }
9357n/a ],
10357n/a}
Responses
codedescriptionhitsavg
200Successful Response40034ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1603n/a{
2603n/a "anyOf": [
3350n/a {
4350n/a "type": "string"
5350n/a },
6253350 {
7253350 "type": "null"
8253350 }
9603n/a ],
10603n/a}
Body
application/json3 / 3
UpdateGroupPreferences
1208226{
211580 "properties": {
311580 "privateGroup": {
411580 "type": "boolean"
511580 }
611580 },
7288146 "type": "object"
8208226}
Responses
codedescriptionhitsavg
200Successful Response21417ms
422Validation Error27612ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request331ms
Examples
Body: application/json
trueUpdateGroupPreferences.privateGroup
Headers
accept-language3 / 3
#validinvalidschema
1445n/a{
2445n/a "anyOf": [
3287n/a {
4287n/a "type": "string"
5287n/a },
6158287 {
7158287 "type": "null"
8158287 }
9445n/a ],
10445n/a}
Responses
codedescriptionhitsavg
200Successful Response62546ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1472n/a{
2472n/a "anyOf": [
3300n/a {
4300n/a "type": "string"
5300n/a },
6172300 {
7172300 "type": "null"
8172300 }
9472n/a ],
10472n/a}
Responses
codedescriptionhitsavg
200Successful Response48218ms
422Validation Error0never seen
Households: Cookbooks 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1389n/a{
2389n/a "anyOf": [
3320n/a {
4320n/a "type": "string"
5320n/a },
669320 {
769320 "type": "null"
869320 }
9389n/a ],
10389n/a}
orderByNullPosition5 / 5
1124204{
2124204 "anyOf": [
3104224 {
5104224 },
620308 {
720308 "type": "null"
820308 }
9124204 ],
10124204}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1104224{
2104224 "enum": [
366n/a "first",
438n/a "last"
5104224 ],
6308n/a "type": "string"
7104224}
orderDirection2 / 2
OrderDirection
128964{
228964 "enum": [
3186n/a "asc",
4103n/a "desc"
528964 ],
6353n/a "type": "string"
728964}
queryFilter3 / 3
1219n/a{
2219n/a "anyOf": [
3180n/a {
4180n/a "type": "string"
5180n/a },
639180 {
739180 "type": "null"
839180 }
9219n/a ],
10219n/a}
paginationSeed3 / 3
1298n/a{
2298n/a "anyOf": [
3234n/a {
4234n/a "type": "string"
5234n/a },
664234 {
764234 "type": "null"
864234 }
9298n/a ],
10298n/a}
page1 / 1
122394{
222394 "type": "integer"
322394}
perPage1 / 1
121036{
221036 "type": "integer"
321036}
Headers
accept-language3 / 3
1455n/a{
2455n/a "anyOf": [
3344n/a {
4344n/a "type": "string"
5344n/a },
6111344 {
7111344 "type": "null"
8111344 }
9455n/a ],
10455n/a}
Responses
codedescriptionhitsavg
200Successful Response25719ms
422Validation Error33111ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request9716ms
500Internal Server Error817ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1536n/a{
2536n/a "anyOf": [
3327n/a {
4327n/a "type": "string"
5327n/a },
6209327 {
7209327 "type": "null"
8209327 }
9536n/a ],
10536n/a}
Body
application/json11 / 11
CreateCookBook
1393201{
2424140 "properties": {
319235 "description": {
419235 "type": "string"
519235 },
643895 "name": {
743895 "type": "string"
843895 },
917728 "position": {
1017728 "type": "integer"
1117728 },
1218724 "public": {
1318724 "type": "boolean"
1418724 },
1518524 "queryFilterString": {
1618524 "type": "string"
1718524 },
1817580 "slug": {
1917580 "anyOf": [
20105150 {
21105150 "type": "string"
22105150 },
2370185 {
2470185 "type": "null"
2570185 }
2617580 ],
2717580 }
28424140 },
2953347 "required": [
3053347 "name"
3153347 ],
3258014 "type": "object"
33393201}
Responses
codedescriptionhitsavg
201Successful Response27933ms
422Validation Error4366ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request769ms
Examples
Body: application/json
""CreateCookBook.description
1CreateCookBook.position
falseCreateCookBook.public
""CreateCookBook.queryFilterString
Headers
accept-language3 / 3
#validinvalidschema
1521n/a{
2521n/a "anyOf": [
3335n/a {
4335n/a "type": "string"
5335n/a },
6186335 {
7186335 "type": "null"
8186335 }
9521n/a ],
10521n/a}
Body
application/json19 / 19
1179311{
2179289 "items": {
4179289 },
546822 "type": "array"
6179311}
Referenced Components (1)20 of 20 keywords
UpdateCookBook20 of 20 keywords
11173752{
21276621 "properties": {
3866276 "description": {
4866276 "type": "string"
5866276 },
61769117 "groupId": {
7176911 "format": "uuid4",
81780106 "type": "string"
91769117 },
10185227 "householdId": {
11185220 "format": "uuid4",
1218727 "type": "string"
13185227 },
141683209 "id": {
15168333 "format": "uuid4",
161716176 "type": "string"
171683209 },
18173583 "name": {
19173583 "type": "string"
20173583 },
2188086 "position": {
2288086 "type": "integer"
2388086 },
24939103 "public": {
25939103 "type": "boolean"
26939103 },
2795832 "queryFilterString": {
2895832 "type": "string"
2995832 },
30841201 "slug": {
31841201 "anyOf": [
32401641 {
33401641 "type": "string"
34401641 },
35440602 {
36440602 "type": "null"
37440602 }
38841201 ],
39841201 }
401276621 },
411794113 "required": [
42181889 "name",
43188621 "groupId",
44187928 "householdId",
45189215 "id"
461794113 ],
47190718 "type": "object"
481173752}
Responses
codedescriptionhitsavg
200Successful Response3611ms
422Validation Error45612ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request161ms
404Not Found2514ms
500Internal Server Error79ms
Examples
Body: application/json
""UpdateCookBook.description
1UpdateCookBook.position
falseUpdateCookBook.public
""UpdateCookBook.queryFilterString
Path Parameters
item_id1 / 1
#validinvalidschema
164n/a{
264n/a "type": "string"
364n/a}
Headers
accept-language3 / 3
142n/a{
242n/a "anyOf": [
329n/a {
429n/a "type": "string"
529n/a },
61329 {
71329 "type": "null"
81329 }
942n/a ],
1042n/a}
Responses
codedescriptionhitsavg
200Successful Response4137ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1835ms
404Not Found518ms
Path Parameters
item_id4 / 4
#validinvalidschema
1514n/a{
2514n/a "anyOf": [
347836 {
447836 "format": "uuid4",
5514n/a "type": "string"
647836 },
7514n/a {
8514n/a "type": "string"
9514n/a }
10514n/a ],
11514n/a}
Headers
accept-language3 / 3
1125n/a{
2125n/a "anyOf": [
379n/a {
479n/a "type": "string"
579n/a },
64679 {
74679 "type": "null"
84679 }
9125n/a ],
10125n/a}
Responses
codedescriptionhitsavg
200Successful Response46713ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4720ms
Path Parameters
item_id1 / 1
#validinvalidschema
1456n/a{
2456n/a "type": "string"
3456n/a}
Headers
accept-language3 / 3
1192n/a{
2192n/a "anyOf": [
3164n/a {
4164n/a "type": "string"
5164n/a },
628164 {
728164 "type": "null"
828164 }
9192n/a ],
10192n/a}
Body
application/json11 / 11
CreateCookBook
137255{
238038 "properties": {
32485 "description": {
42485 "type": "string"
52485 },
64037 "name": {
74037 "type": "string"
84037 },
91318 "position": {
101318 "type": "integer"
111318 },
121508 "public": {
131508 "type": "boolean"
141508 },
151377 "queryFilterString": {
161377 "type": "string"
171377 },
1813310 "slug": {
1913310 "anyOf": [
209251 {
219251 "type": "string"
229251 },
2341102 {
2441102 "type": "null"
2541102 }
2613310 ],
2713310 }
2838038 },
2941012 "required": [
3041012 "name"
3141012 ],
324225 "type": "object"
3337255}
Responses
codedescriptionhitsavg
200Successful Response31133ms
422Validation Error1005ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3913ms
404Not Found19ms
400Bad Request512ms
Examples
Body: application/json
""CreateCookBook.description
1CreateCookBook.position
falseCreateCookBook.public
""CreateCookBook.queryFilterString
Households: Event Notifications 6 operations 5 covered 1 partial 0 uncovered 0 not measured 97% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1402n/a{
2402n/a "anyOf": [
3310n/a {
4310n/a "type": "string"
5310n/a },
692310 {
792310 "type": "null"
892310 }
9402n/a ],
10402n/a}
orderByNullPosition5 / 5
1285167{
2285167 "anyOf": [
3205247 {
5205247 },
680372 {
780372 "type": "null"
880372 }
9285167 ],
10285167}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1205247{
2205247 "enum": [
394n/a "first",
4111n/a "last"
5205247 ],
6372n/a "type": "string"
7205247}
orderDirection2 / 2
OrderDirection
133949{
233949 "enum": [
3215n/a "asc",
4124n/a "desc"
533949 ],
6388n/a "type": "string"
733949}
queryFilter3 / 3
1265n/a{
2265n/a "anyOf": [
3212n/a {
4212n/a "type": "string"
5212n/a },
653212 {
753212 "type": "null"
853212 }
9265n/a ],
10265n/a}
paginationSeed3 / 3
1383n/a{
2383n/a "anyOf": [
3307n/a {
4307n/a "type": "string"
5307n/a },
676307 {
776307 "type": "null"
876307 }
9383n/a ],
10383n/a}
page1 / 1
1199139{
2199139 "type": "integer"
3199139}
perPage1 / 1
122922{
222922 "type": "integer"
322922}
Headers
accept-language3 / 3
1494n/a{
2494n/a "anyOf": [
3361n/a {
4361n/a "type": "string"
5361n/a },
6133361 {
7133361 "type": "null"
8133361 }
9494n/a ],
10494n/a}
Responses
codedescriptionhitsavg
200Successful Response25720ms
422Validation Error30412ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request11813ms
500Internal Server Error916ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1567n/a{
2567n/a "anyOf": [
3393n/a {
4393n/a "type": "string"
5393n/a },
6174393 {
7174393 "type": "null"
8174393 }
9567n/a ],
10567n/a}
Body
application/json7 / 7
GroupEventNotifierCreate
1422173{
246268 "properties": {
329158 "appriseUrl": {
429158 "anyOf": [
5181168 {
6181168 "type": "string"
7181168 },
8110239 {
9110239 "type": "null"
10110239 }
1129158 ],
1229158 },
1343060 "name": {
1443060 "type": "string"
1543060 }
1646268 },
1749072 "required": [
1849072 "name"
1949072 ],
2056233 "type": "object"
21422173}
Responses
codedescriptionhitsavg
201Successful Response16424ms
422Validation Error3645ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request27612ms
Path Parameters
item_id2 / 2
#validinvalidschema
1515{
2515 "format": "uuid4",
356n/a "type": "string"
4515}
Headers
accept-language3 / 3
148n/a{
248n/a "anyOf": [
327n/a {
427n/a "type": "string"
527n/a },
62127 {
72127 "type": "null"
82127 }
948n/a ],
1048n/a}
Responses
codedescriptionhitsavg
204Successful Response1539ms
422Validation Error514ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3611ms
Path Parameters
item_id2 / 2
#validinvalidschema
149228{
249228 "format": "uuid4",
3520n/a "type": "string"
449228}
Headers
accept-language3 / 3
1137n/a{
2137n/a "anyOf": [
386n/a {
486n/a "type": "string"
586n/a },
65186 {
75186 "type": "null"
85186 }
9137n/a ],
10137n/a}
Responses
codedescriptionhitsavg
200Successful Response959ms
422Validation Error2813ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found39715ms
Path Parameters
item_id2 / 2
#validinvalidschema
172814{
272814 "format": "uuid4",
3742n/a "type": "string"
472814}
Headers
accept-language3 / 3
1414n/a{
2414n/a "anyOf": [
3357n/a {
4357n/a "type": "string"
5357n/a },
657357 {
757357 "type": "null"
857357 }
9414n/a ],
10414n/a}
Body
application/json40 / 42
GroupEventNotifierUpdate
1453232{
2479201 "properties": {
333210 "appriseUrl": {
433210 "anyOf": [
541301 {
641301 "type": "string"
741301 },
829151 {
929151 "type": "null"
1029151 }
1133210 ],
1233210 },
133145 "enabled": {
143145 "type": "boolean"
153145 },
166745 "groupId": {
176740 "format": "uuid4",
186745 "type": "string"
196745 },
206745 "householdId": {
216740 "format": "uuid4",
226745 "type": "string"
236745 },
2465821 "id": {
2565813 "format": "uuid4",
266718 "type": "string"
2765821 },
2864611 "name": {
2964611 "type": "string"
3064611 },
31172171 "options": {
33172171 }
34479201 },
3565426 "required": [
3665723 "name",
376791 "groupId",
386791 "householdId",
396791 "id"
4065426 ],
416805 "type": "object"
42453232}
Referenced Components (1)28 of 28 keywords
GroupEventNotifierOptions28 of 28 keywords
1172171{
2157160 "properties": {
32335 "categoryCreated": {
42335 "type": "boolean"
52335 },
62245 "categoryDeleted": {
72245 "type": "boolean"
82245 },
92325 "categoryUpdated": {
102325 "type": "boolean"
112325 },
122196 "cookbookCreated": {
132196 "type": "boolean"
142196 },
152175 "cookbookDeleted": {
162175 "type": "boolean"
172175 },
1821512 "cookbookUpdated": {
1921512 "type": "boolean"
2021512 },
212215 "dataExport": {
222215 "type": "boolean"
232215 },
2421320 "dataImport": {
2521320 "type": "boolean"
2621320 },
272166 "dataMigrations": {
282166 "type": "boolean"
292166 },
302165 "labelCreated": {
312165 "type": "boolean"
322165 },
332105 "labelDeleted": {
342105 "type": "boolean"
352105 },
362105 "labelUpdated": {
372105 "type": "boolean"
382105 },
392177 "mealplanEntryCreated": {
402177 "type": "boolean"
412177 },
422125 "recipeCreated": {
432125 "type": "boolean"
442125 },
4521110 "recipeDeleted": {
4621110 "type": "boolean"
4721110 },
4820314 "recipeUpdated": {
4920314 "type": "boolean"
5020314 },
512106 "shoppingListCreated": {
522106 "type": "boolean"
532106 },
542009 "shoppingListDeleted": {
552009 "type": "boolean"
562009 },
572025 "shoppingListUpdated": {
582025 "type": "boolean"
592025 },
602075 "tagCreated": {
612075 "type": "boolean"
622075 },
632006 "tagDeleted": {
642006 "type": "boolean"
652006 },
661985 "tagUpdated": {
671985 "type": "boolean"
681985 },
6920312 "testMessage": {
7020312 "type": "boolean"
7120312 },
722006 "userSignup": {
732006 "type": "boolean"
742006 },
751925 "webhookTask": {
761925 "type": "boolean"
771925 }
78157160 },
7933211 "type": "object"
80172171}
Responses
codedescriptionhitsavg
200Successful Response19523ms
422Validation Error2546ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error26514ms
404Not Found1115ms
400Bad Request171ms
Examples
Body: application/json
trueGroupEventNotifierUpdate.enabled
falseGroupEventNotifierOptions.categoryCreated
falseGroupEventNotifierOptions.categoryDeleted
falseGroupEventNotifierOptions.categoryUpdated
falseGroupEventNotifierOptions.cookbookCreated
falseGroupEventNotifierOptions.cookbookDeleted
falseGroupEventNotifierOptions.cookbookUpdated
falseGroupEventNotifierOptions.dataExport
falseGroupEventNotifierOptions.dataImport
falseGroupEventNotifierOptions.dataMigrations
falseGroupEventNotifierOptions.labelCreated
falseGroupEventNotifierOptions.labelDeleted
falseGroupEventNotifierOptions.labelUpdated
falseGroupEventNotifierOptions.mealplanEntryCreated
falseGroupEventNotifierOptions.recipeCreated
falseGroupEventNotifierOptions.recipeDeleted
falseGroupEventNotifierOptions.recipeUpdated
falseGroupEventNotifierOptions.shoppingListCreated
falseGroupEventNotifierOptions.shoppingListDeleted
falseGroupEventNotifierOptions.shoppingListUpdated
falseGroupEventNotifierOptions.tagCreated
falseGroupEventNotifierOptions.tagDeleted
falseGroupEventNotifierOptions.tagUpdated
falseGroupEventNotifierOptions.testMessage
falseGroupEventNotifierOptions.userSignup
falseGroupEventNotifierOptions.webhookTask
{ "categoryCreated": false, "categoryDeleted": false, "categoryUpdated": false, "cookbookCreated": false, "cookbookDeleted": false, "cookbookUpdated": false, "dataExport": false, "dataImport": false, "dataMigrations": false, "labelCreated": false, "labelDeleted": false, "labelUpdated": false, "mealplanEntryCreated": false, "recipeCreated": false, "recipeDeleted": false, "recipeUpdated": false, "shoppingListCreated": false, "shoppingListDeleted": false, "shoppingListUpdated": false, "tagCreated": false, "tagDeleted": false, "tagUpdated": false, "testMessage": false, "userSignup": false, "webhookTask": false }GroupEventNotifierUpdate.options
Path Parameters
item_id2 / 2
#validinvalidschema
1382131{
2382131 "format": "uuid4",
3513n/a "type": "string"
4382131}
Headers
accept-language3 / 3
1162n/a{
2162n/a "anyOf": [
3109n/a {
4109n/a "type": "string"
5109n/a },
653109 {
753109 "type": "null"
853109 }
9162n/a ],
10162n/a}
Responses
codedescriptionhitsavg
204Successful Response0never seen
422Validation Error13115ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error38211ms
Households: Invitations 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1459n/a{
2459n/a "anyOf": [
3297n/a {
4297n/a "type": "string"
5297n/a },
6162297 {
7162297 "type": "null"
8162297 }
9459n/a ],
10459n/a}
Responses
codedescriptionhitsavg
200Successful Response50314ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1222n/a{
2222n/a "anyOf": [
3154n/a {
4154n/a "type": "string"
5154n/a },
668154 {
768154 "type": "null"
868154 }
9222n/a ],
10222n/a}
Body
application/json12 / 12
CreateInviteToken
143037{
243327 "properties": {
343110 "groupId": {
443110 "anyOf": [
542219 {
64224 "format": "uuid",
742615 "type": "string"
842219 },
99432 {
109432 "type": "null"
119432 }
1243110 ],
1343110 },
1443315 "householdId": {
1543315 "anyOf": [
1643018 {
174303 "format": "uuid",
1843315 "type": "string"
1943018 },
203445 {
213445 "type": "null"
223445 }
2343315 ],
2443315 },
254498 "uses": {
264498 "type": "integer"
274498 }
2843327 },
294575 "required": [
304575 "uses"
314575 ],
324625 "type": "object"
3343037}
Responses
codedescriptionhitsavg
201Successful Response42920ms
422Validation Error724ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request51ms
500Internal Server Error29ms
Headers
accept-language3 / 3
#validinvalidschema
1438n/a{
2438n/a "anyOf": [
3263n/a {
4263n/a "type": "string"
5263n/a },
6175263 {
7175263 "type": "null"
8175263 }
9438n/a ],
10438n/a}
Body
application/json5 / 5
EmailInvitation
1288211{
2342137 "properties": {
3315130 "email": {
4315130 "type": "string"
5315130 },
6328131 "token": {
7328131 "type": "string"
8328131 }
9342137 },
1042563 "required": [
1144543 "email",
1245929 "token"
1342563 ],
1448811 "type": "object"
15288211}
Responses
codedescriptionhitsavg
200Successful Response2889ms
422Validation Error2499ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request131ms
Households: Mealplan Rules 5 operations 4 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1337n/a{
2337n/a "anyOf": [
3273n/a {
4273n/a "type": "string"
5273n/a },
664273 {
764273 "type": "null"
864273 }
9337n/a ],
10337n/a}
orderByNullPosition5 / 5
1205211{
2205211 "anyOf": [
3118298 {
5118298 },
687329 {
787329 "type": "null"
887329 }
9205211 ],
10205211}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1118298{
2118298 "enum": [
365n/a "first",
453n/a "last"
5118298 ],
6329n/a "type": "string"
7118298}
orderDirection2 / 2
OrderDirection
125859{
225859 "enum": [
3153n/a "asc",
4105n/a "desc"
525859 ],
6317n/a "type": "string"
725859}
queryFilter3 / 3
1191n/a{
2191n/a "anyOf": [
3157n/a {
4157n/a "type": "string"
5157n/a },
634157 {
734157 "type": "null"
834157 }
9191n/a ],
10191n/a}
paginationSeed3 / 3
1196n/a{
2196n/a "anyOf": [
3176n/a {
4176n/a "type": "string"
5176n/a },
620176 {
720176 "type": "null"
820176 }
9196n/a ],
10196n/a}
page1 / 1
126243{
226243 "type": "integer"
326243}
perPage1 / 1
119821{
219821 "type": "integer"
319821}
Headers
accept-language3 / 3
1430n/a{
2430n/a "anyOf": [
3298n/a {
4298n/a "type": "string"
5298n/a },
6132298 {
7132298 "type": "null"
8132298 }
9430n/a ],
10430n/a}
Responses
codedescriptionhitsavg
200Successful Response29918ms
422Validation Error27911ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request10417ms
500Internal Server Error816ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1438n/a{
2438n/a "anyOf": [
3280n/a {
4280n/a "type": "string"
5280n/a },
6158280 {
7158280 "type": "null"
8158280 }
9438n/a ],
10438n/a}
Body
application/json9 / 9
PlanRulesCreate
1285210{
2153171 "properties": {
3142142 "day": {
5142142 },
6155103 "entryType": {
8155103 },
9133104 "queryFilterString": {
10133104 "type": "string"
11133104 }
12153171 },
1345639 "type": "object"
14285210}
Referenced Components (2)6 of 6 keywords
PlanRulesDay3 of 3 keywords
1142142{
2142142 "enum": [
39n/a "monday",
417n/a "tuesday",
515n/a "wednesday",
615n/a "thursday",
718n/a "friday",
816n/a "saturday",
96n/a "sunday",
1046n/a "unset"
11142142 ],
1219886 "type": "string"
13142142}
PlanRulesType3 of 3 keywords
1155103{
2155103 "enum": [
332n/a "breakfast",
425n/a "lunch",
525n/a "dinner",
626n/a "side",
747n/a "unset"
8155103 ],
918969 "type": "string"
10155103}
Responses
codedescriptionhitsavg
201Successful Response28279ms
422Validation Error4095ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request131ms
500Internal Server Error120ms
Examples
Body: application/json
"unset"PlanRulesCreate.day
"unset"PlanRulesCreate.entryType
""PlanRulesCreate.queryFilterString
Path Parameters
item_id1 / 2
#validinvalidschema
1580{
2580 "format": "uuid4",
358n/a "type": "string"
4580}
Headers
accept-language3 / 3
126n/a{
226n/a "anyOf": [
319n/a {
419n/a "type": "string"
519n/a },
6719 {
7719 "type": "null"
8719 }
926n/a ],
1026n/a}
Responses
codedescriptionhitsavg
200Successful Response3844ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2013ms
Path Parameters
item_id2 / 2
#validinvalidschema
151623{
251623 "format": "uuid4",
3539n/a "type": "string"
451623}
Headers
accept-language3 / 3
1154n/a{
2154n/a "anyOf": [
398n/a {
498n/a "type": "string"
598n/a },
65698 {
75698 "type": "null"
85698 }
9154n/a ],
10154n/a}
Responses
codedescriptionhitsavg
200Successful Response46512ms
422Validation Error2315ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5114ms
Path Parameters
item_id2 / 2
#validinvalidschema
14959{
24959 "format": "uuid4",
3504n/a "type": "string"
44959}
Headers
accept-language3 / 3
1166n/a{
2166n/a "anyOf": [
3122n/a {
4122n/a "type": "string"
5122n/a },
644122 {
744122 "type": "null"
844122 }
9166n/a ],
10166n/a}
Body
application/json9 / 9
PlanRulesCreate
141537{
29832 "properties": {
39410 "day": {
59410 },
68710 "entryType": {
88710 },
97915 "queryFilterString": {
107915 "type": "string"
117915 }
129832 },
134475 "type": "object"
1441537}
Referenced Components (2)6 of 6 keywords
PlanRulesDay3 of 3 keywords
19410{
29410 "enum": [
38n/a "monday",
410n/a "tuesday",
512n/a "wednesday",
67n/a "thursday",
74n/a "friday",
84n/a "saturday",
97n/a "sunday",
1042n/a "unset"
119410 ],
12995 "type": "string"
139410}
PlanRulesType3 of 3 keywords
18710{
28710 "enum": [
314n/a "breakfast",
412n/a "lunch",
512n/a "dinner",
610n/a "side",
739n/a "unset"
88710 ],
9916 "type": "string"
108710}
Responses
codedescriptionhitsavg
200Successful Response37520ms
422Validation Error804ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3412ms
400Bad Request151ms
Examples
Body: application/json
"unset"PlanRulesCreate.day
"unset"PlanRulesCreate.entryType
""PlanRulesCreate.queryFilterString
Households: Mealplans 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
start_date4 / 4
#validinvalidschema
1177157{
2177157 "anyOf": [
3144190 {
4144157 "format": "date",
5301n/a "type": "string"
6144190 },
733301 {
833301 "type": "null"
933301 }
10177157 ],
11177157}
end_date4 / 4
1261139{
2261139 "anyOf": [
3230170 {
4230139 "format": "date",
5369n/a "type": "string"
6230170 },
731369 {
831369 "type": "null"
931369 }
10261139 ],
11261139}
orderBy3 / 3
1239n/a{
2239n/a "anyOf": [
3199n/a {
4199n/a "type": "string"
5199n/a },
640199 {
740199 "type": "null"
840199 }
9239n/a ],
10239n/a}
orderByNullPosition5 / 5
117985{
217985 "anyOf": [
3134130 {
5134130 },
645219 {
745219 "type": "null"
845219 }
917985 ],
1017985}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1134130{
2134130 "enum": [
385n/a "first",
449n/a "last"
5134130 ],
6219n/a "type": "string"
7134130}
orderDirection2 / 2
OrderDirection
125028{
225028 "enum": [
3140n/a "asc",
4110n/a "desc"
525028 ],
6278n/a "type": "string"
725028}
queryFilter3 / 3
1221n/a{
2221n/a "anyOf": [
3180n/a {
4180n/a "type": "string"
5180n/a },
641180 {
741180 "type": "null"
841180 }
9221n/a ],
10221n/a}
paginationSeed3 / 3
1242n/a{
2242n/a "anyOf": [
3187n/a {
4187n/a "type": "string"
5187n/a },
655187 {
755187 "type": "null"
855187 }
9242n/a ],
10242n/a}
page1 / 1
1186154{
2186154 "type": "integer"
3186154}
perPage1 / 1
123426{
223426 "type": "integer"
323426}
Headers
accept-language3 / 3
1474n/a{
2474n/a "anyOf": [
3321n/a {
4321n/a "type": "string"
5321n/a },
6153321 {
7153321 "type": "null"
8153321 }
9474n/a ],
10474n/a}
Responses
codedescriptionhitsavg
200Successful Response37819ms
422Validation Error29912ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4116ms
500Internal Server Error1014ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1746n/a{
2746n/a "anyOf": [
3446n/a {
4446n/a "type": "string"
5446n/a },
6300446 {
7300446 "type": "null"
8300446 }
9746n/a ],
10746n/a}
Body
application/json14 / 14
CreatePlanEntry
1489103{
249687 "properties": {
353244 "date": {
453232 "format": "date",
556412 "type": "string"
653244 },
735219 "entryType": {
935219 },
1033831 "recipeId": {
1133831 "anyOf": [
12120249 {
1312010 "format": "uuid",
14130239 "type": "string"
15120249 },
16218151 {
17218151 "type": "null"
18218151 }
1933831 ],
2033831 },
2134318 "text": {
2234318 "type": "string"
2334318 },
243488 "title": {
253488 "type": "string"
263488 }
2749687 },
2857610 "required": [
2957610 "date"
3057610 ],
315866 "type": "object"
32489103}
Referenced Components (1)3 of 3 keywords
PlanEntryType3 of 3 keywords
135219{
235219 "enum": [
360n/a "breakfast",
434n/a "lunch",
530n/a "dinner",
6228n/a "side"
735219 ],
835813 "type": "string"
935219}
Responses
codedescriptionhitsavg
201Successful Response22735ms
422Validation Error4588ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error7533ms
400Bad Request191ms
Examples
Body: application/json
"breakfast"CreatePlanEntry.entryType
""CreatePlanEntry.text
""CreatePlanEntry.title
Headers
accept-language3 / 3
#validinvalidschema
1283n/a{
2283n/a "anyOf": [
3190n/a {
4190n/a "type": "string"
5190n/a },
693190 {
793190 "type": "null"
893190 }
9283n/a ],
10283n/a}
Body
application/json8 / 8
CreateRandomEntry
1257119{
226077 "properties": {
327163 "date": {
427140 "format": "date",
531123 "type": "string"
627163 },
79447 "entryType": {
99447 }
1026077 },
1133424 "required": [
1233424 "date"
1333424 ],
1435818 "type": "object"
15257119}
Referenced Components (1)3 of 3 keywords
PlanEntryType3 of 3 keywords
19447{
29447 "enum": [
323n/a "breakfast",
424n/a "lunch",
520n/a "dinner",
627n/a "side"
79447 ],
810734 "type": "string"
99447}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error4553ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found24623ms
400Bad Request1832ms
Examples
Body: application/json
"dinner"CreateRandomEntry.entryType
Headers
accept-language3 / 3
#validinvalidschema
1441n/a{
2441n/a "anyOf": [
3281n/a {
4281n/a "type": "string"
5281n/a },
6160281 {
7160281 "type": "null"
8160281 }
9441n/a ],
10441n/a}
Responses
codedescriptionhitsavg
200Successful Response48516ms
422Validation Error0never seen
Path Parameters
item_id1 / 1
#validinvalidschema
1425{
2425 "type": "integer"
3425}
Headers
accept-language3 / 3
134n/a{
234n/a "anyOf": [
326n/a {
426n/a "type": "string"
526n/a },
6826 {
7826 "type": "null"
8826 }
934n/a ],
1034n/a}
Responses
codedescriptionhitsavg
200Successful Response3134ms
422Validation Error52ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1112ms
Path Parameters
item_id1 / 1
#validinvalidschema
149134{
249134 "type": "integer"
349134}
Headers
accept-language3 / 3
1216n/a{
2216n/a "anyOf": [
3143n/a {
4143n/a "type": "string"
5143n/a },
673143 {
773143 "type": "null"
873143 }
9216n/a ],
10216n/a}
Responses
codedescriptionhitsavg
200Successful Response39915ms
422Validation Error3212ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found9213ms
500Internal Server Error211ms
Path Parameters
item_id1 / 1
#validinvalidschema
156423{
256423 "type": "integer"
356423}
Headers
accept-language3 / 3
1273n/a{
2273n/a "anyOf": [
3222n/a {
4222n/a "type": "string"
5222n/a },
651222 {
751222 "type": "null"
851222 }
9273n/a ],
10273n/a}
Body
application/json19 / 19
UpdatePlanEntry
1347101{
236083 "properties": {
342212 "date": {
44226 "format": "date",
54286 "type": "string"
642212 },
71468 "entryType": {
91468 },
1042219 "groupId": {
114227 "format": "uuid",
1242912 "type": "string"
1342219 },
144338 "id": {
154338 "type": "integer"
164338 },
1714016 "recipeId": {
1814016 "anyOf": [
199660 {
20969 "format": "uuid",
2110551 "type": "string"
229660 },
2344112 {
2444112 "type": "null"
2544112 }
2614016 ],
2714016 },
2819114 "text": {
2919114 "type": "string"
3019114 },
311296 "title": {
321296 "type": "string"
331296 },
3442910 "userId": {
354291 "format": "uuid",
364309 "type": "string"
3742910 }
3836083 },
3943013 "required": [
404349 "date",
414412 "id",
424412 "groupId",
434394 "userId"
4443013 ],
454435 "type": "object"
46347101}
Referenced Components (1)3 of 3 keywords
PlanEntryType3 of 3 keywords
11468{
21468 "enum": [
375n/a "breakfast",
426n/a "lunch",
517n/a "dinner",
628n/a "side"
71468 ],
81495 "type": "string"
91468}
Responses
codedescriptionhitsavg
200Successful Response1320ms
422Validation Error45011ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request10517ms
500Internal Server Error119ms
404Not Found1816ms
Examples
Body: application/json
"breakfast"UpdatePlanEntry.entryType
""UpdatePlanEntry.text
""UpdatePlanEntry.title
Households: Recipe Actions 6 operations 5 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1347n/a{
2347n/a "anyOf": [
3254n/a {
4254n/a "type": "string"
5254n/a },
693254 {
793254 "type": "null"
893254 }
9347n/a ],
10347n/a}
orderByNullPosition5 / 5
1129247{
2129247 "anyOf": [
391285 {
591285 },
638338 {
738338 "type": "null"
838338 }
9129247 ],
10129247}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
191285{
291285 "enum": [
354n/a "first",
437n/a "last"
591285 ],
6338n/a "type": "string"
791285}
orderDirection2 / 2
OrderDirection
127864{
227864 "enum": [
3158n/a "asc",
4120n/a "desc"
527864 ],
6342n/a "type": "string"
727864}
queryFilter3 / 3
1293n/a{
2293n/a "anyOf": [
3238n/a {
4238n/a "type": "string"
5238n/a },
655238 {
755238 "type": "null"
855238 }
9293n/a ],
10293n/a}
paginationSeed3 / 3
1352n/a{
2352n/a "anyOf": [
3276n/a {
4276n/a "type": "string"
5276n/a },
676276 {
776276 "type": "null"
876276 }
9352n/a ],
10352n/a}
page1 / 1
125337{
225337 "type": "integer"
325337}
perPage1 / 1
125235{
225235 "type": "integer"
325235}
Headers
accept-language3 / 3
1500n/a{
2500n/a "anyOf": [
3326n/a {
4326n/a "type": "string"
5326n/a },
6174326 {
7174326 "type": "null"
8174326 }
9500n/a ],
10500n/a}
Responses
codedescriptionhitsavg
200Successful Response27515ms
422Validation Error31413ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6219ms
500Internal Server Error1015ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1418n/a{
2418n/a "anyOf": [
3260n/a {
4260n/a "type": "string"
5260n/a },
6158260 {
7158260 "type": "null"
8158260 }
9418n/a ],
10418n/a}
Body
application/json8 / 8
CreateGroupRecipeAction
1457117{
250452 "properties": {
348132 "actionType": {
548132 },
653516 "title": {
753516 "type": "string"
853516 },
951313 "url": {
1051313 "type": "string"
1151313 }
1250452 },
1350948 "required": [
1451344 "actionType",
155516 "title",
1652631 "url"
1750948 ],
1855717 "type": "object"
19457117}
Referenced Components (1)3 of 3 keywords
GroupRecipeActionType3 of 3 keywords
148132{
248132 "enum": [
3377n/a "link",
4104n/a "post"
548132 ],
65085 "type": "string"
748132}
Responses
codedescriptionhitsavg
201Successful Response45735ms
422Validation Error2856ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request131ms
Path Parameters
item_id1 / 2
#validinvalidschema
1500{
2500 "format": "uuid4",
350n/a "type": "string"
4500}
Headers
accept-language3 / 3
126n/a{
226n/a "anyOf": [
316n/a {
416n/a "type": "string"
516n/a },
61016 {
71016 "type": "null"
81016 }
926n/a ],
1026n/a}
Responses
codedescriptionhitsavg
200Successful Response2627ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2410ms
Path Parameters
item_id2 / 2
#validinvalidschema
149034{
249034 "format": "uuid4",
3524n/a "type": "string"
449034}
Headers
accept-language3 / 3
1136n/a{
2136n/a "anyOf": [
392n/a {
492n/a "type": "string"
592n/a },
64492 {
74492 "type": "null"
84492 }
9136n/a ],
10136n/a}
Responses
codedescriptionhitsavg
200Successful Response14412ms
422Validation Error3412ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found34614ms
Path Parameters
item_id2 / 2
#validinvalidschema
150710{
250710 "format": "uuid4",
3517n/a "type": "string"
450710}
Headers
accept-language3 / 3
1279n/a{
2279n/a "anyOf": [
3186n/a {
4186n/a "type": "string"
5186n/a },
693186 {
793186 "type": "null"
893186 }
9279n/a ],
10279n/a}
Body
application/json12 / 12
SaveGroupRecipeAction
138871{
239951 "properties": {
342915 "actionType": {
542915 },
643118 "groupId": {
74312 "format": "uuid4",
843316 "type": "string"
943118 },
1043217 "householdId": {
114323 "format": "uuid4",
1243514 "type": "string"
1343217 },
1443711 "title": {
1543711 "type": "string"
1643711 },
174418 "url": {
184418 "type": "string"
194418 }
2039951 },
2143911 "required": [
224446 "actionType",
234482 "title",
244491 "url",
254491 "groupId",
264491 "householdId"
2743911 ],
284509 "type": "object"
2938871}
Referenced Components (1)3 of 3 keywords
GroupRecipeActionType3 of 3 keywords
142915{
242915 "enum": [
3310n/a "link",
4119n/a "post"
542915 ],
64395 "type": "string"
742915}
Responses
codedescriptionhitsavg
200Successful Response12127ms
422Validation Error1216ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found26312ms
400Bad Request121ms
Path Parameters
item_id2 / 2
#validinvalidschema
158922{
258922 "format": "uuid4",
3611n/a "type": "string"
458922}
recipe_slug1 / 1
1611n/a{
2611n/a "type": "string"
3611n/a}
Headers
accept-language3 / 3
1249n/a{
2249n/a "anyOf": [
3165n/a {
4165n/a "type": "string"
5165n/a },
684165 {
784165 "type": "null"
884165 }
9249n/a ],
10249n/a}
Body
application/json3 / 3
Body_trigger_action_api_households_recipe_actions__item_id__trigger__recipe_slug__post
133322{
21268 "properties": {
31268 "recipe_scale": {
41268 "type": "number"
51268 }
61268 },
734114 "type": "object"
833322}
Responses
codedescriptionhitsavg
202Successful Response5282ms
422Validation Error825ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1778ms
404Not Found30016ms
Examples
Body: application/json
1Body_trigger_action_api_households_recipe_actions__item_id__trigger__recipe_slug__post.recipe_scale
Households: Self Service 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1358n/a{
2358n/a "anyOf": [
3265n/a {
4265n/a "type": "string"
5265n/a },
693265 {
793265 "type": "null"
893265 }
9358n/a ],
10358n/a}
orderByNullPosition5 / 5
1151246{
2151246 "anyOf": [
3108289 {
5108289 },
643354 {
743354 "type": "null"
843354 }
9151246 ],
10151246}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1108289{
2108289 "enum": [
362n/a "first",
446n/a "last"
5108289 ],
6354n/a "type": "string"
7108289}
orderDirection2 / 2
OrderDirection
126354{
226354 "enum": [
3170n/a "asc",
493n/a "desc"
526354 ],
6317n/a "type": "string"
726354}
queryFilter3 / 3
1309n/a{
2309n/a "anyOf": [
3238n/a {
4238n/a "type": "string"
5238n/a },
671238 {
771238 "type": "null"
871238 }
9309n/a ],
10309n/a}
paginationSeed3 / 3
1281n/a{
2281n/a "anyOf": [
3215n/a {
4215n/a "type": "string"
5215n/a },
666215 {
766215 "type": "null"
866215 }
9281n/a ],
10281n/a}
page1 / 1
126247{
226247 "type": "integer"
326247}
perPage1 / 1
1209123{
2209123 "type": "integer"
3209123}
Headers
accept-language3 / 3
1520n/a{
2520n/a "anyOf": [
3334n/a {
4334n/a "type": "string"
5334n/a },
6186334 {
7186334 "type": "null"
8186334 }
9520n/a ],
10520n/a}
Responses
codedescriptionhitsavg
200Successful Response26826ms
422Validation Error34511ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5515ms
500Internal Server Error1120ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1260n/a{
2260n/a "anyOf": [
3190n/a {
4190n/a "type": "string"
5190n/a },
670190 {
770190 "type": "null"
870190 }
9260n/a ],
10260n/a}
Body
application/json9 / 9
SetPermissions
146568{
247048 "properties": {
324113 "canInvite": {
424113 "type": "boolean"
524113 },
616516 "canManage": {
716516 "type": "boolean"
816516 },
92138 "canManageHousehold": {
102138 "type": "boolean"
112138 },
1217415 "canOrganize": {
1317415 "type": "boolean"
1417415 },
1549815 "userId": {
164986 "format": "uuid4",
175049 "type": "string"
1849815 }
1947048 },
2051315 "required": [
2151315 "userId"
2251315 ],
235285 "type": "object"
2446568}
Responses
codedescriptionhitsavg
200Successful Response13417ms
422Validation Error916ms
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden206ms
404Not Found31815ms
400Bad Request111ms
Examples
Body: application/json
falseSetPermissions.canInvite
falseSetPermissions.canManage
falseSetPermissions.canManageHousehold
falseSetPermissions.canOrganize
Headers
accept-language3 / 3
#validinvalidschema
1360n/a{
2360n/a "anyOf": [
3236n/a {
4236n/a "type": "string"
5236n/a },
6124236 {
7124236 "type": "null"
8124236 }
9360n/a ],
10360n/a}
Responses
codedescriptionhitsavg
200Successful Response40933ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1610n/a{
2610n/a "anyOf": [
3382n/a {
4382n/a "type": "string"
5382n/a },
6228382 {
7228382 "type": "null"
8228382 }
9610n/a ],
10610n/a}
Body
application/json10 / 10
UpdateHouseholdPreferences
1165313{
2115278 "properties": {
322850 "firstDayOfWeek": {
422850 "type": "integer"
522850 },
6148132 "lockRecipeEditsFromOtherHouseholds": {
7148132 "type": "boolean"
8148132 },
916771 "privateHousehold": {
1016771 "type": "boolean"
1116771 },
12174100 "recipeDisableComments": {
13174100 "type": "boolean"
14174100 },
1516334 "recipeLandscapeView": {
1616334 "type": "boolean"
1716334 },
1818076 "recipePublic": {
1918076 "type": "boolean"
2018076 },
2117554 "recipeShowAssets": {
2217554 "type": "boolean"
2317554 },
2415869 "recipeShowNutrition": {
2515869 "type": "boolean"
2615869 }
27115278 },
2844335 "type": "object"
29165313}
Responses
codedescriptionhitsavg
200Successful Response17730ms
422Validation Error33712ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error516ms
400Bad Request231ms
Examples
Body: application/json
0UpdateHouseholdPreferences.firstDayOfWeek
trueUpdateHouseholdPreferences.lockRecipeEditsFromOtherHouseholds
trueUpdateHouseholdPreferences.privateHousehold
falseUpdateHouseholdPreferences.recipeDisableComments
falseUpdateHouseholdPreferences.recipeLandscapeView
trueUpdateHouseholdPreferences.recipePublic
falseUpdateHouseholdPreferences.recipeShowAssets
falseUpdateHouseholdPreferences.recipeShowNutrition
Headers
accept-language3 / 3
#validinvalidschema
1427n/a{
2427n/a "anyOf": [
3276n/a {
4276n/a "type": "string"
5276n/a },
6151276 {
7151276 "type": "null"
8151276 }
9427n/a ],
10427n/a}
Responses
codedescriptionhitsavg
200Successful Response60041ms
422Validation Error0never seen
Path Parameters
recipe_slug1 / 1
#validinvalidschema
1499n/a{
2499n/a "type": "string"
3499n/a}
Headers
accept-language3 / 3
1215n/a{
2215n/a "anyOf": [
3143n/a {
4143n/a "type": "string"
5143n/a },
672143 {
772143 "type": "null"
872143 }
9215n/a ],
10215n/a}
Responses
codedescriptionhitsavg
200Successful Response43922ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6013ms
Headers
accept-language3 / 3
#validinvalidschema
1501n/a{
2501n/a "anyOf": [
3331n/a {
4331n/a "type": "string"
5331n/a },
6170331 {
7170331 "type": "null"
8170331 }
9501n/a ],
10501n/a}
Responses
codedescriptionhitsavg
200Successful Response52114ms
422Validation Error0never seen
Households: Shopping List Items 8 operations 3 covered 5 partial 0 uncovered 0 not measured 86% #
Query Parameters
ids3 / 3
#validinvalidschema
152395{
252395 "items": {
32861411 "format": "uuid4",
41697n/a "type": "string"
552395 },
6447n/a "type": "array"
752395}
Headers
accept-language3 / 3
1266n/a{
2266n/a "anyOf": [
3165n/a {
4165n/a "type": "string"
5165n/a },
6101165 {
7101165 "type": "null"
8101165 }
9266n/a ],
10266n/a}
Responses
codedescriptionhitsavg
200Successful Response15812ms
422Validation Error39513ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error317ms
Query Parameters
orderBy3 / 3
#validinvalidschema
1281n/a{
2281n/a "anyOf": [
3215n/a {
4215n/a "type": "string"
5215n/a },
666215 {
766215 "type": "null"
866215 }
9281n/a ],
10281n/a}
orderByNullPosition5 / 5
1167117{
2167117 "anyOf": [
3129155 {
5129155 },
638246 {
738246 "type": "null"
838246 }
9167117 ],
10167117}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1129155{
2129155 "enum": [
364n/a "first",
465n/a "last"
5129155 ],
6246n/a "type": "string"
7129155}
orderDirection2 / 2
OrderDirection
127547{
227547 "enum": [
3132n/a "asc",
4143n/a "desc"
527547 ],
6322n/a "type": "string"
727547}
queryFilter3 / 3
1195n/a{
2195n/a "anyOf": [
3162n/a {
4162n/a "type": "string"
5162n/a },
633162 {
733162 "type": "null"
833162 }
9195n/a ],
10195n/a}
paginationSeed3 / 3
1207n/a{
2207n/a "anyOf": [
3164n/a {
4164n/a "type": "string"
5164n/a },
643164 {
743164 "type": "null"
843164 }
9207n/a ],
10207n/a}
page1 / 1
1204135{
2204135 "type": "integer"
3204135}
perPage1 / 1
120932{
220932 "type": "integer"
320932}
Headers
accept-language3 / 3
1395n/a{
2395n/a "anyOf": [
3289n/a {
4289n/a "type": "string"
5289n/a },
6106289 {
7106289 "type": "null"
8106289 }
9395n/a ],
10395n/a}
Responses
codedescriptionhitsavg
200Successful Response16516ms
422Validation Error25412ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5815ms
500Internal Server Error18923ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1677n/a{
2677n/a "anyOf": [
3601n/a {
4601n/a "type": "string"
5601n/a },
676601 {
776601 "type": "null"
876601 }
9677n/a ],
10677n/a}
Body
application/json162 / 190
ShoppingListItemCreate
1488370{
2490360 "properties": {
36585 "checked": {
46585 "type": "boolean"
56585 },
65375 "display": {
75375 "type": "string"
85375 },
95634 "extras": {
105634 "anyOf": [
1150958 {
121n/a "additionalProperties": true,
1350958 "type": "object"
1450958 },
1554513 {
1654513 "type": "null"
1754513 }
185634 ],
195634 },
20532113 "food": {
21532113 "anyOf": [
22114531 {
24114531 },
25134511 {
27134511 },
28398247 {
29398247 "type": "null"
30398247 }
31532113 ],
32532113 },
335314 "foodId": {
345314 "anyOf": [
3545976 {
364590 "format": "uuid4",
3745976 "type": "string"
3845976 },
3972463 {
4072463 "type": "null"
4172463 }
425314 ],
435314 },
445384 "id": {
455384 "anyOf": [
4651527 {
475150 "format": "uuid4",
4851527 "type": "string"
4951527 },
5023519 {
5123519 "type": "null"
5223519 }
535384 ],
545384 },
555544 "labelId": {
565544 "anyOf": [
5747682 {
584760 "format": "uuid4",
5947682 "type": "string"
6047682 },
6178480 {
6278480 "type": "null"
6378480 }
645544 ],
655544 },
665484 "note": {
675484 "anyOf": [
6852527 {
6952527 "type": "string"
7052527 },
7123529 {
7223529 "type": "null"
7323529 }
745484 ],
755484 },
765578 "position": {
775578 "type": "integer"
785578 },
796515 "quantity": {
806515 "type": "number"
816515 },
8272867 "recipeReferences": {
8372862 "items": {
8572862 },
867905 "type": "array"
8772867 },
888435 "shoppingListId": {
898430 "format": "uuid4",
908435 "type": "string"
918435 },
92425129 "unit": {
93425129 "anyOf": [
9462492 {
9662492 },
9781473 {
9981473 },
100344210 {
101344210 "type": "null"
102344210 }
103425129 ],
104425129 },
1055385 "unitId": {
1065385 "anyOf": [
10745885 {
1084580 "format": "uuid4",
10945885 "type": "string"
11045885 },
11180463 {
11280463 "type": "null"
11380463 }
1145385 ],
1155385 }
116490360 },
1178485 "required": [
1188485 "shoppingListId"
1198485 ],
1208535 "type": "object"
121488370}
Referenced Components (10)159 of 189 keywords
CreateIngredientFood28 of 30 keywords
1134511{
2136106 "properties": {
313732 "aliases": {
413722 "items": {
613722 },
715910 "type": "array"
813732 },
915110 "description": {
1015110 "type": "string"
1115110 },
1220010 "extras": {
1320010 "anyOf": [
1413872 {
151n/a "additionalProperties": true,
1613872 "type": "object"
1713872 },
1862148 {
1962148 "type": "null"
2062148 }
2120010 ],
2220010 },
2313620 "householdsWithIngredientFood": {
2413610 "items": {
259010 "type": "string"
2613610 },
2714610 "type": "array"
2813620 },
292178 "id": {
302178 "anyOf": [
3121411 {
322140 "format": "uuid4",
3321411 "type": "string"
3421411 },
353222 {
363222 "type": "null"
373222 }
382178 ],
392178 },
401428 "labelId": {
411428 "anyOf": [
4212921 {
431290 "format": "uuid4",
4412921 "type": "string"
4512921 },
4613137 {
4713137 "type": "null"
4813137 }
491428 ],
501428 },
5123010 "name": {
5223010 "type": "string"
5323010 },
541478 "pluralName": {
551478 "anyOf": [
5616139 {
5716139 "type": "string"
5816139 },
5913124 {
6013124 "type": "null"
6113124 }
621478 ],
631478 }
64136106 },
652403 "required": [
662403 "name"
672403 ],
68243402 "type": "object"
69134511}
CreateIngredientFoodAlias6 of 6 keywords
19022{
29010 "properties": {
39010 "name": {
49010 "type": "string"
59010 }
69010 },
71002 "required": [
81002 "name"
91002 ],
1010210 "type": "object"
119022}
CreateIngredientUnit29 of 30 keywords
181473{
283122 "properties": {
315510 "abbreviation": {
415510 "type": "string"
515510 },
613732 "aliases": {
713722 "items": {
913722 },
1015910 "type": "array"
1113732 },
1215010 "description": {
1315010 "type": "string"
1415010 },
151558 "extras": {
161558 "anyOf": [
1714221 {
181n/a "additionalProperties": true,
1914221 "type": "object"
2014221 },
2113150 {
2213150 "type": "null"
2313150 }
241558 ],
251558 },
2615210 "fraction": {
2715210 "type": "boolean"
2815210 },
291728 "id": {
301728 "anyOf": [
3117010 {
321700 "format": "uuid4",
3317010 "type": "string"
3417010 },
352178 {
362178 "type": "null"
372178 }
381728 ],
391728 },
4019310 "name": {
4119310 "type": "string"
4219310 },
4314816 "pluralAbbreviation": {
4414816 "anyOf": [
4514321 {
4614321 "type": "string"
4714321 },
485159 {
495159 "type": "null"
505159 }
5114816 ],
5214816 },
531438 "pluralName": {
541438 "anyOf": [
559142 {
569142 "type": "string"
579142 },
5813417 {
5913417 "type": "null"
6013417 }
611438 ],
621438 },
6314510 "useAbbreviation": {
6414510 "type": "boolean"
6514510 }
6683122 },
672033 "required": [
682033 "name"
692033 ],
70206348 "type": "object"
7181473}
CreateIngredientUnitAlias6 of 6 keywords
16922{
26910 "properties": {
36910 "name": {
46910 "type": "string"
56910 }
66910 },
7792 "required": [
8792 "name"
9792 ],
108110 "type": "object"
116922}
IngredientFood-Input31 of 41 keywords
1114531{
2133109 "properties": {
313732 "aliases": {
413722 "items": {
613722 },
715910 "type": "array"
813732 },
9830 "createdAt": {
10830 "anyOf": [
11812 {
12810 "format": "date-time",
13812 "type": "string"
14812 },
15281 {
16281 "type": "null"
17281 }
18830 ],
19830 },
2015110 "description": {
2115110 "type": "string"
2215110 },
2320010 "extras": {
2420010 "anyOf": [
2513872 {
261n/a "additionalProperties": true,
2713872 "type": "object"
2813872 },
2962148 {
3062148 "type": "null"
3162148 }
3220010 ],
3320010 },
3413620 "householdsWithIngredientFood": {
3513610 "items": {
369010 "type": "string"
3713610 },
3814610 "type": "array"
3913620 },
4021411 "id": {
412140 "format": "uuid4",
4221411 "type": "string"
4321411 },
44800 "label": {
45800 "anyOf": [
46575 {
48575 },
49755 {
50755 "type": "null"
51755 }
52800 ]
53800 },
541428 "labelId": {
551428 "anyOf": [
5612921 {
571290 "format": "uuid4",
5812921 "type": "string"
5912921 },
6013137 {
6113137 "type": "null"
6213137 }
631428 ],
641428 },
6523010 "name": {
6623010 "type": "string"
6723010 },
681478 "pluralName": {
691478 "anyOf": [
7016139 {
7116139 "type": "string"
7216139 },
7313124 {
7413124 "type": "null"
7513124 }
761478 ],
771478 },
78780 "update_at": {
79780 "anyOf": [
80753 {
81750 "format": "date-time",
82753 "type": "string"
83753 },
84375 {
85375 "type": "null"
86375 }
87780 ],
88780 }
89133109 },
9022320 "required": [
9122518 "id",
922403 "name"
9322320 ],
94243402 "type": "object"
95114531}
IngredientFoodAlias6 of 6 keywords
19022{
29010 "properties": {
39010 "name": {
49010 "type": "string"
59010 }
69010 },
71002 "required": [
81002 "name"
91002 ],
1010210 "type": "object"
119022}
IngredientUnit-Input30 of 37 keywords
162492{
281124 "properties": {
315510 "abbreviation": {
415510 "type": "string"
515510 },
613732 "aliases": {
713722 "items": {
913722 },
1015910 "type": "array"
1113732 },
12820 "createdAt": {
13820 "anyOf": [
14802 {
15800 "format": "date-time",
16802 "type": "string"
17802 },
18280 {
19280 "type": "null"
20280 }
21820 ],
22820 },
2315010 "description": {
2415010 "type": "string"
2515010 },
261558 "extras": {
271558 "anyOf": [
2814221 {
291n/a "additionalProperties": true,
3014221 "type": "object"
3114221 },
3213150 {
3313150 "type": "null"
3413150 }
351558 ],
361558 },
3715210 "fraction": {
3815210 "type": "boolean"
3915210 },
4017010 "id": {
411700 "format": "uuid4",
4217010 "type": "string"
4317010 },
4419310 "name": {
4519310 "type": "string"
4619310 },
4714816 "pluralAbbreviation": {
4814816 "anyOf": [
4914321 {
5014321 "type": "string"
5114321 },
525159 {
535159 "type": "null"
545159 }
5514816 ],
5614816 },
571438 "pluralName": {
581438 "anyOf": [
599142 {
609142 "type": "string"
619142 },
6213417 {
6313417 "type": "null"
6413417 }
651438 ],
661438 },
67760 "update_at": {
68760 "anyOf": [
69724 {
70720 "format": "date-time",
71724 "type": "string"
72724 },
73472 {
74472 "type": "null"
75472 }
76760 ],
77760 },
7814510 "useAbbreviation": {
7914510 "type": "boolean"
8014510 }
8181124 },
8217828 "required": [
8318026 "id",
842033 "name"
8517828 ],
86206348 "type": "object"
8762492}
IngredientUnitAlias6 of 6 keywords
16922{
26910 "properties": {
36910 "name": {
46910 "type": "string"
56910 }
66910 },
7792 "required": [
8792 "name"
9792 ],
108110 "type": "object"
116922}
MultiPurposeLabelSummary1 of 11 keywords
1575{
250 "properties": {
340 "color": {
440 "type": "string"
540 },
650 "groupId": {
750 "format": "uuid4",
850 "type": "string"
950 },
1050 "id": {
1150 "format": "uuid4",
1250 "type": "string"
1350 },
1450 "name": {
1550 "type": "string"
1650 }
1750 },
1850 "required": [
1950 "name",
2050 "groupId",
2150 "id"
2250 ],
23575 "type": "object"
24575}
ShoppingListItemRecipeRefCreate16 of 16 keywords
1752145{
2753139 "properties": {
3777114 "recipeId": {
4777109 "format": "uuid4",
58865 "type": "string"
6777114 },
735016 "recipeNote": {
835016 "anyOf": [
9215151 {
10215151 "type": "string"
11215151 },
12135231 {
13135231 "type": "null"
14135231 }
1535016 ],
1635016 },
173385 "recipeQuantity": {
183385 "type": "number"
193385 },
203574 "recipeScale": {
213574 "anyOf": [
22185176 {
23185176 "type": "number"
24185176 },
25172189 {
26172189 "type": "null"
27172189 }
283574 ],
293574 }
30753139 },
318911 "required": [
328911 "recipeId"
338911 ],
348925 "type": "object"
35752145}
Responses
codedescriptionhitsavg
201Successful Response34332ms
422Validation Error3265ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error20369ms
400Bad Request51ms
Examples
Body: application/json
falseShoppingListItemCreate.checked
""ShoppingListItemCreate.display
{}ShoppingListItemCreate.extras
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""ShoppingListItemCreate.note
0ShoppingListItemCreate.position
1ShoppingListItemCreate.quantity
[]ShoppingListItemCreate.recipeReferences
0ShoppingListItemRecipeRefCreate.recipeQuantity
1ShoppingListItemRecipeRefCreate.recipeScale
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Headers
accept-language3 / 3
#validinvalidschema
1770n/a{
2770n/a "anyOf": [
3656n/a {
4656n/a "type": "string"
5656n/a },
6114656 {
7114656 "type": "null"
8114656 }
9770n/a ],
10770n/a}
Body
application/json179 / 208
1497360{
2497354 "items": {
4497354 },
58516 "type": "array"
6497360}
Referenced Components (12)227 of 261 keywords
CreateIngredientFood29 of 30 keywords
1402757{
2404106 "properties": {
326232 "aliases": {
426222 "items": {
626222 },
728410 "type": "array"
826232 },
928610 "description": {
1028610 "type": "string"
1128610 },
1229510 "extras": {
1329510 "anyOf": [
1424362 {
151n/a "additionalProperties": true,
1624362 "type": "object"
1724362 },
1852253 {
1952253 "type": "null"
2052253 }
2129510 ],
2229510 },
2324320 "householdsWithIngredientFood": {
2424310 "items": {
2545210 "type": "string"
2624310 },
2725310 "type": "array"
2824320 },
294618 "id": {
304618 "anyOf": [
3143930 {
324390 "format": "uuid4",
3343930 "type": "string"
3443930 },
3522447 {
3622447 "type": "null"
3722447 }
384618 ],
394618 },
4028510 "labelId": {
4128510 "anyOf": [
4220392 {
432032 "format": "uuid4",
4420590 "type": "string"
4520392 },
4682213 {
4782213 "type": "null"
4882213 }
4928510 ],
5028510 },
5149810 "name": {
5249810 "type": "string"
5349810 },
542298 "pluralName": {
552298 "anyOf": [
5635202 {
5735202 "type": "string"
5835202 },
5919443 {
6019443 "type": "null"
6119443 }
622298 ],
632298 }
64404106 },
655083 "required": [
665083 "name"
675083 ],
68511648 "type": "object"
69402757}
CreateIngredientFoodAlias6 of 6 keywords
151922{
251910 "properties": {
351910 "name": {
451910 "type": "string"
551910 }
651910 },
75292 "required": [
85292 "name"
95292 ],
1053110 "type": "object"
1151922}
CreateIngredientUnit29 of 30 keywords
1486581{
2488120 "properties": {
327010 "abbreviation": {
427010 "type": "string"
527010 },
628138 "aliases": {
728122 "items": {
928122 },
1030316 "type": "array"
1128138 },
1231110 "description": {
1331110 "type": "string"
1431110 },
153208 "extras": {
163208 "anyOf": [
1726860 {
181n/a "additionalProperties": true,
1926860 "type": "object"
2026860 },
2152276 {
2252276 "type": "null"
2352276 }
243208 ],
253208 },
2630510 "fraction": {
2730510 "type": "boolean"
2830510 },
294678 "id": {
304678 "anyOf": [
3140372 {
324030 "format": "uuid4",
3340372 "type": "string"
3440372 },
3564411 {
3664411 "type": "null"
3764411 }
384678 ],
394678 },
4059610 "name": {
4159610 "type": "string"
4259610 },
432748 "pluralAbbreviation": {
442748 "anyOf": [
4523844 {
4623844 "type": "string"
4723844 },
4836246 {
4936246 "type": "null"
5036246 }
512748 ],
522748 },
533708 "pluralName": {
543708 "anyOf": [
55142236 {
56142236 "type": "string"
57142236 },
58228150 {
59228150 "type": "null"
60228150 }
613708 ],
623708 },
6336910 "useAbbreviation": {
6436910 "type": "boolean"
6536910 }
66488120 },
676063 "required": [
686063 "name"
696063 ],
70609458 "type": "object"
71486581}
CreateIngredientUnitAlias6 of 6 keywords
158022{
258010 "properties": {
358010 "name": {
458010 "type": "string"
558010 }
658010 },
75902 "required": [
85902 "name"
95902 ],
1059210 "type": "object"
1158022}
IngredientFood-Input34 of 41 keywords
1337822{
2378132 "properties": {
326232 "aliases": {
426222 "items": {
626222 },
728410 "type": "array"
826232 },
91750 "createdAt": {
101750 "anyOf": [
1114629 {
121460 "format": "date-time",
1314629 "type": "string"
1414629 },
1529146 {
1629146 "type": "null"
1729146 }
181750 ],
191750 },
2028610 "description": {
2128610 "type": "string"
2228610 },
2329510 "extras": {
2429510 "anyOf": [
2524362 {
261n/a "additionalProperties": true,
2724362 "type": "object"
2824362 },
2952253 {
3052253 "type": "null"
3152253 }
3229510 ],
3329510 },
3424320 "householdsWithIngredientFood": {
3524310 "items": {
3645210 "type": "string"
3724310 },
3825310 "type": "array"
3924320 },
4043930 "id": {
414390 "format": "uuid4",
4243930 "type": "string"
4343930 },
441884 "label": {
451884 "anyOf": [
4640152 {
4840152 },
4914844 {
5014844 "type": "null"
5114844 }
521884 ]
531884 },
5428510 "labelId": {
5528510 "anyOf": [
5620392 {
572032 "format": "uuid4",
5820590 "type": "string"
5920392 },
6082213 {
6182213 "type": "null"
6282213 }
6328510 ],
6428510 },
6549810 "name": {
6649810 "type": "string"
6749810 },
682298 "pluralName": {
692298 "anyOf": [
7035202 {
7135202 "type": "string"
7235202 },
7319443 {
7419443 "type": "null"
7519443 }
762298 ],
772298 },
781950 "update_at": {
791950 "anyOf": [
8010095 {
811000 "format": "date-time",
8210095 "type": "string"
8310095 },
8495100 {
8595100 "type": "null"
8695100 }
871950 ],
881950 }
89378132 },
9046744 "required": [
9146942 "id",
925083 "name"
9346744 ],
94511648 "type": "object"
95337822}
IngredientFoodAlias6 of 6 keywords
151922{
251910 "properties": {
351910 "name": {
451910 "type": "string"
551910 }
651910 },
75292 "required": [
85292 "name"
95292 ],
1053110 "type": "object"
1151922}
IngredientUnit-Input30 of 37 keywords
1289778{
2424184 "properties": {
327010 "abbreviation": {
427010 "type": "string"
527010 },
628138 "aliases": {
728122 "items": {
928122 },
1030316 "type": "array"
1128138 },
121890 "createdAt": {
131890 "anyOf": [
1415039 {
151500 "format": "date-time",
1615039 "type": "string"
1715039 },
1839150 {
1939150 "type": "null"
2039150 }
211890 ],
221890 },
2331110 "description": {
2431110 "type": "string"
2531110 },
263208 "extras": {
273208 "anyOf": [
2826860 {
291n/a "additionalProperties": true,
3026860 "type": "object"
3126860 },
3252276 {
3352276 "type": "null"
3452276 }
353208 ],
363208 },
3730510 "fraction": {
3830510 "type": "boolean"
3930510 },
4040372 "id": {
414030 "format": "uuid4",
4240372 "type": "string"
4340372 },
4459610 "name": {
4559610 "type": "string"
4659610 },
472748 "pluralAbbreviation": {
482748 "anyOf": [
4923844 {
5023844 "type": "string"
5123844 },
5236246 {
5336246 "type": "null"
5436246 }
552748 ],
562748 },
573708 "pluralName": {
583708 "anyOf": [
59142236 {
60142236 "type": "string"
61142236 },
62228150 {
63228150 "type": "null"
64228150 }
653708 ],
663708 },
672360 "update_at": {
682360 "anyOf": [
6914492 {
701440 "format": "date-time",
7114492 "type": "string"
7214492 },
7392144 {
7492144 "type": "null"
7592144 }
762360 ],
772360 },
7836910 "useAbbreviation": {
7936910 "type": "boolean"
8036910 }
81424184 },
82473136 "required": [
83475134 "id",
846063 "name"
85473136 ],
86609458 "type": "object"
87289778}
IngredientUnitAlias6 of 6 keywords
158022{
258010 "properties": {
358010 "name": {
458010 "type": "string"
558010 }
658010 },
75902 "required": [
85902 "name"
95902 ],
1059210 "type": "object"
1158022}
MultiPurposeLabelSummary4 of 11 keywords
140152{
2404 "properties": {
3330 "color": {
4330 "type": "string"
5330 },
6404 "groupId": {
7404 "format": "uuid4",
8440 "type": "string"
9404 },
10440 "id": {
11440 "format": "uuid4",
12440 "type": "string"
13440 },
14440 "name": {
15440 "type": "string"
16440 }
17404 },
18440 "required": [
19440 "name",
20440 "groupId",
21440 "id"
22440 ],
2344148 "type": "object"
2440152}
ShoppingListItemRecipeRefCreate15 of 16 keywords
12475105{
2249377 "properties": {
3254210 "recipeId": {
425420 "format": "uuid4",
5254210 "type": "string"
6254210 },
7134349 "recipeNote": {
8134349 "anyOf": [
9497895 {
10497895 "type": "string"
11497895 },
12846546 {
13846546 "type": "null"
14846546 }
15134349 ],
16134349 },
17103510 "recipeQuantity": {
18103510 "type": "number"
19103510 },
2011318 "recipeScale": {
2111318 "anyOf": [
22443696 {
23443696 "type": "number"
24443696 },
25688451 {
26688451 "type": "null"
27688451 }
2811318 ],
2911318 }
30249377 },
31255223 "required": [
32255223 "recipeId"
33255223 ],
3425755 "type": "object"
352475105}
ShoppingListItemRecipeRefUpdate15 of 20 keywords
110611519{
2249377 "properties": {
310800 "id": {
410800 "format": "uuid4",
510800 "type": "string"
610800 },
7254210 "recipeId": {
825420 "format": "uuid4",
9254210 "type": "string"
10254210 },
11134349 "recipeNote": {
12134349 "anyOf": [
13497895 {
14497895 "type": "string"
15497895 },
16846546 {
17846546 "type": "null"
18846546 }
19134349 ],
20134349 },
21103510 "recipeQuantity": {
22103510 "type": "number"
23103510 },
2411318 "recipeScale": {
2511318 "anyOf": [
26443696 {
27443696 "type": "number"
28443696 },
29688451 {
30688451 "type": "null"
31688451 }
3211318 ],
3311318 },
3410800 "shoppingListItemId": {
3510800 "format": "uuid4",
3610800 "type": "string"
3710800 }
38249377 },
3910791496 "required": [
40255223 "recipeId",
4110801495 "id",
4210801495 "shoppingListItemId"
4310791496 ],
4425755 "type": "object"
4510611519}
ShoppingListItemUpdateBulk47 of 52 keywords
11522415{
21528404 "properties": {
39495 "checked": {
49495 "type": "boolean"
59495 },
610115 "display": {
710115 "type": "string"
810115 },
910354 "extras": {
1010354 "anyOf": [
11716323 {
121n/a "additionalProperties": true,
13716323 "type": "object"
14716323 },
15319720 {
16319720 "type": "null"
17319720 }
1810354 ],
1910354 },
201046113 "food": {
211046113 "anyOf": [
22337822 {
24337822 },
25402757 {
27402757 },
28644515 {
29644515 "type": "null"
30644515 }
311046113 ],
321046113 },
33111765 "foodId": {
34111765 "anyOf": [
35738444 {
367380 "format": "uuid4",
37738444 "type": "string"
38738444 },
39379803 {
40379803 "type": "null"
41379803 }
42111765 ],
43111765 },
4419255 "id": {
4519250 "format": "uuid4",
4619255 "type": "string"
4719255 },
4810894 "labelId": {
4910894 "anyOf": [
50783310 {
517830 "format": "uuid4",
52783310 "type": "string"
53783310 },
54306787 {
55306787 "type": "null"
56306787 }
5710894 ],
5810894 },
5910724 "note": {
6010724 "anyOf": [
61690386 {
62690386 "type": "string"
63690386 },
64382694 {
65382694 "type": "null"
66382694 }
6710724 ],
6810724 },
6912776 "position": {
7012776 "type": "integer"
7112776 },
7211455 "quantity": {
7311455 "type": "number"
7411455 },
75102860 "recipeReferences": {
76102855 "items": {
772475105 "anyOf": [
782475105 {
802475105 },
8110611519 {
8310611519 }
842475105 ]
85102855 },
8610835 "type": "array"
87102860 },
8819225 "shoppingListId": {
8919220 "format": "uuid4",
9019225 "type": "string"
9119225 },
92940127 "unit": {
93940127 "anyOf": [
94289778 {
96289778 },
97486581 {
99486581 },
100454613 {
101454613 "type": "null"
102454613 }
103940127 ],
104940127 },
10510884 "unitId": {
10610884 "anyOf": [
107856236 {
1088560 "format": "uuid4",
109856236 "type": "string"
110856236 },
111232860 {
112232860 "type": "null"
113232860 }
11410884 ],
11510884 }
1161528404 },
11719266 "required": [
11819275 "shoppingListId",
11919302 "id"
12019266 ],
12119325 "type": "object"
1221522415}
Responses
codedescriptionhitsavg
200Successful Response51633ms
422Validation Error3344ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3742ms
400Bad Request121ms
Examples
Body: application/json
falseShoppingListItemUpdateBulk.checked
""ShoppingListItemUpdateBulk.display
{}ShoppingListItemUpdateBulk.extras
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""ShoppingListItemUpdateBulk.note
0ShoppingListItemUpdateBulk.position
1ShoppingListItemUpdateBulk.quantity
[]ShoppingListItemUpdateBulk.recipeReferences
0ShoppingListItemRecipeRefCreate.recipeQuantity
1ShoppingListItemRecipeRefCreate.recipeScale
0ShoppingListItemRecipeRefUpdate.recipeQuantity
1ShoppingListItemRecipeRefUpdate.recipeScale
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Headers
accept-language3 / 3
#validinvalidschema
1793n/a{
2793n/a "anyOf": [
3662n/a {
4662n/a "type": "string"
5662n/a },
6131662 {
7131662 "type": "null"
8131662 }
9793n/a ],
10793n/a}
Body
application/json166 / 192
1397404{
2397394 "items": {
4397394 },
579110 "type": "array"
6397404}
Referenced Components (11)209 of 241 keywords
CreateIngredientFood28 of 30 keywords
1343532{
2345112 "properties": {
321532 "aliases": {
421522 "items": {
621522 },
723710 "type": "array"
821532 },
924910 "description": {
1024910 "type": "string"
1124910 },
122249 "extras": {
132249 "anyOf": [
1419043 {
151n/a "additionalProperties": true,
1619043 "type": "object"
1719043 },
1834199 {
1934199 "type": "null"
2034199 }
212249 ],
222249 },
2324727 "householdsWithIngredientFood": {
2424710 "items": {
2548010 "type": "string"
2624710 },
2725717 "type": "array"
2824727 },
293368 "id": {
303368 "anyOf": [
3131133 {
323110 "format": "uuid4",
3331133 "type": "string"
3431133 },
3525319 {
3625319 "type": "null"
3725319 }
383368 ],
393368 },
402328 "labelId": {
412328 "anyOf": [
4214892 {
431480 "format": "uuid4",
4414892 "type": "string"
4514892 },
4684156 {
4784156 "type": "null"
4884156 }
492328 ],
502328 },
5144411 "name": {
5244411 "type": "string"
5344411 },
542278 "pluralName": {
552278 "anyOf": [
5671164 {
5771164 "type": "string"
5871164 },
5915679 {
6015679 "type": "null"
6115679 }
622278 ],
632278 }
64345112 },
654553 "required": [
664553 "name"
674553 ],
68458417 "type": "object"
69343532}
CreateIngredientFoodAlias6 of 6 keywords
140722{
240710 "properties": {
340710 "name": {
440710 "type": "string"
540710 }
640710 },
74172 "required": [
84172 "name"
94172 ],
1041910 "type": "object"
1140722}
CreateIngredientUnit29 of 30 keywords
1349574{
2351121 "properties": {
331510 "abbreviation": {
431510 "type": "string"
531510 },
627639 "aliases": {
727629 "items": {
927629 },
1030510 "type": "array"
1127639 },
1226410 "description": {
1326410 "type": "string"
1426410 },
152888 "extras": {
162888 "anyOf": [
1719898 {
181n/a "additionalProperties": true,
1919898 "type": "object"
2019898 },
2190206 {
2290206 "type": "null"
2390206 }
242888 ],
252888 },
2630910 "fraction": {
2730910 "type": "boolean"
2830910 },
293518 "id": {
303518 "anyOf": [
3133920 {
323390 "format": "uuid4",
3333920 "type": "string"
3433920 },
3512347 {
3612347 "type": "null"
3712347 }
383518 ],
393518 },
4046010 "name": {
4146010 "type": "string"
4246010 },
432718 "pluralAbbreviation": {
442718 "anyOf": [
4518792 {
4618792 "type": "string"
4718792 },
4884195 {
4984195 "type": "null"
5084195 }
512718 ],
522718 },
532558 "pluralName": {
542558 "anyOf": [
5539224 {
5639224 "type": "string"
5739224 },
5821647 {
5921647 "type": "null"
6021647 }
612558 ],
622558 },
6328110 "useAbbreviation": {
6428110 "type": "boolean"
6528110 }
66351121 },
674703 "required": [
684703 "name"
694703 ],
70473450 "type": "object"
71349574}
CreateIngredientUnitAlias6 of 6 keywords
182954{
282910 "properties": {
382910 "name": {
482910 "type": "string"
582910 }
682910 },
783919 "required": [
883919 "name"
983919 ],
1085825 "type": "object"
1182954}
IngredientFood-Input31 of 41 keywords
1212663{
2320137 "properties": {
321532 "aliases": {
421522 "items": {
621522 },
723710 "type": "array"
821532 },
91400 "createdAt": {
101400 "anyOf": [
1111624 {
121160 "format": "date-time",
1311624 "type": "string"
1411624 },
1524116 {
1624116 "type": "null"
1724116 }
181400 ],
191400 },
2024910 "description": {
2124910 "type": "string"
2224910 },
232249 "extras": {
242249 "anyOf": [
2519043 {
261n/a "additionalProperties": true,
2719043 "type": "object"
2819043 },
2934199 {
3034199 "type": "null"
3134199 }
322249 ],
332249 },
3424727 "householdsWithIngredientFood": {
3524710 "items": {
3648010 "type": "string"
3724710 },
3825717 "type": "array"
3924727 },
4031133 "id": {
413110 "format": "uuid4",
4231133 "type": "string"
4331133 },
441510 "label": {
451510 "anyOf": [
4640111 {
4840111 },
4911140 {
5011140 "type": "null"
5111140 }
521510 ]
531510 },
542328 "labelId": {
552328 "anyOf": [
5614892 {
571480 "format": "uuid4",
5814892 "type": "string"
5914892 },
6084156 {
6184156 "type": "null"
6284156 }
632328 ],
642328 },
6544411 "name": {
6644411 "type": "string"
6744411 },
682278 "pluralName": {
692278 "anyOf": [
7071164 {
7171164 "type": "string"
7271164 },
7315679 {
7415679 "type": "null"
7515679 }
762278 ],
772278 },
781570 "update_at": {
791570 "anyOf": [
807879 {
81780 "format": "date-time",
827879 "type": "string"
837879 },
847978 {
857978 "type": "null"
867978 }
871570 ],
881570 }
89320137 },
90342116 "required": [
91344114 "id",
924553 "name"
93342116 ],
94458417 "type": "object"
95212663}
IngredientFoodAlias6 of 6 keywords
140722{
240710 "properties": {
340710 "name": {
440710 "type": "string"
540710 }
640710 },
74172 "required": [
84172 "name"
94172 ],
1041910 "type": "object"
1140722}
IngredientUnit-Input33 of 37 keywords
1221702{
2334138 "properties": {
331510 "abbreviation": {
431510 "type": "string"
531510 },
627639 "aliases": {
727629 "items": {
927629 },
1030510 "type": "array"
1127639 },
121529 "createdAt": {
131529 "anyOf": [
1412437 {
151249 "format": "date-time",
1613328 "type": "string"
1712437 },
1828133 {
1928133 "type": "null"
2028133 }
211529 ],
221529 },
2326410 "description": {
2426410 "type": "string"
2526410 },
262888 "extras": {
272888 "anyOf": [
2819898 {
291n/a "additionalProperties": true,
3019898 "type": "object"
3119898 },
3290206 {
3390206 "type": "null"
3490206 }
352888 ],
362888 },
3730910 "fraction": {
3830910 "type": "boolean"
3930910 },
4033920 "id": {
413390 "format": "uuid4",
4233920 "type": "string"
4333920 },
4446010 "name": {
4546010 "type": "string"
4646010 },
472718 "pluralAbbreviation": {
482718 "anyOf": [
4918792 {
5018792 "type": "string"
5118792 },
5284195 {
5384195 "type": "null"
5484195 }
552718 ],
562718 },
572558 "pluralName": {
582558 "anyOf": [
5939224 {
6039224 "type": "string"
6139224 },
6221647 {
6321647 "type": "null"
6421647 }
652558 ],
662558 },
671640 "update_at": {
681640 "anyOf": [
6913034 {
701300 "format": "date-time",
7113034 "type": "string"
7213034 },
7334130 {
7434130 "type": "null"
7534130 }
761640 ],
771640 },
7828110 "useAbbreviation": {
7928110 "type": "boolean"
8028110 }
81334138 },
82357116 "required": [
83359114 "id",
844703 "name"
85357116 ],
86473450 "type": "object"
87221702}
IngredientUnitAlias6 of 6 keywords
182954{
282910 "properties": {
382910 "name": {
482910 "type": "string"
582910 }
682910 },
783919 "required": [
883919 "name"
983919 ],
1085825 "type": "object"
1182954}
MultiPurposeLabelSummary1 of 11 keywords
140111{
2400 "properties": {
3270 "color": {
4270 "type": "string"
5270 },
6400 "groupId": {
7400 "format": "uuid4",
8400 "type": "string"
9400 },
10400 "id": {
11400 "format": "uuid4",
12400 "type": "string"
13400 },
14400 "name": {
15400 "type": "string"
16400 }
17400 },
18400 "required": [
19400 "name",
20400 "groupId",
21400 "id"
22400 ],
2340111 "type": "object"
2440111}
ShoppingListItemCreate47 of 52 keywords
11380434{
21406380 "properties": {
38225 "checked": {
48225 "type": "boolean"
58225 },
68505 "display": {
78505 "type": "string"
88505 },
98924 "extras": {
108924 "anyOf": [
11635261 {
121n/a "additionalProperties": true,
13635261 "type": "object"
14635261 },
15257639 {
16257639 "type": "null"
17257639 }
188924 ],
198924 },
20756119 "food": {
21756119 "anyOf": [
22212663 {
24212663 },
25343532 {
27343532 },
28413462 {
29413462 "type": "null"
30413462 }
31756119 ],
32756119 },
338644 "foodId": {
348644 "anyOf": [
35696172 {
366960 "format": "uuid4",
37696172 "type": "string"
38696172 },
39168700 {
40168700 "type": "null"
41168700 }
428644 ],
438644 },
448594 "id": {
458594 "anyOf": [
46697166 {
476970 "format": "uuid4",
48697166 "type": "string"
49697166 },
50162701 {
51162701 "type": "null"
52162701 }
538594 ],
548594 },
558614 "labelId": {
568614 "anyOf": [
57651214 {
586510 "format": "uuid4",
59651214 "type": "string"
60651214 },
61210655 {
62210655 "type": "null"
63210655 }
648614 ],
658614 },
669267 "note": {
679267 "anyOf": [
68671262 {
69671262 "type": "string"
70671262 },
71255678 {
72255678 "type": "null"
73255678 }
749267 ],
759267 },
7688813 "position": {
7788813 "type": "integer"
7888813 },
798555 "quantity": {
808555 "type": "number"
818555 },
82142687 "recipeReferences": {
83142678 "items": {
85142678 },
8615049 "type": "array"
87142687 },
8817555 "shoppingListId": {
8917550 "format": "uuid4",
9017555 "type": "string"
9117555 },
92795128 "unit": {
93795128 "anyOf": [
94221702 {
96221702 },
97349574 {
99349574 },
100446477 {
101446477 "type": "null"
102446477 }
103795128 ],
104795128 },
1058624 "unitId": {
1068624 "anyOf": [
107650216 {
1086500 "format": "uuid4",
109650216 "type": "string"
110650216 },
111212654 {
112212654 "type": "null"
113212654 }
1148624 ],
1158624 }
1161406380 },
117176049 "required": [
118176049 "shoppingListId"
119176049 ],
12018095 "type": "object"
1211380434}
ShoppingListItemRecipeRefCreate16 of 16 keywords
12627154{
22632142 "properties": {
32640129 "recipeId": {
42640124 "format": "uuid4",
527645 "type": "string"
62640129 },
710994 "recipeNote": {
810994 "anyOf": [
9561542 {
10561542 "type": "string"
11561542 },
12538565 {
13538565 "type": "null"
14538565 }
1510994 ],
1610994 },
179515 "recipeQuantity": {
189515 "type": "number"
199515 },
209214 "recipeScale": {
219214 "anyOf": [
22448477 {
23448477 "type": "number"
24448477 },
25473452 {
26473452 "type": "null"
27473452 }
289214 ],
299214 }
302632142 },
3127697 "required": [
3227697 "recipeId"
3327697 ],
3427765 "type": "object"
352627154}
Responses
codedescriptionhitsavg
201Successful Response27432ms
422Validation Error3717ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error18037ms
400Bad Request121ms
Examples
Body: application/json
falseShoppingListItemCreate.checked
""ShoppingListItemCreate.display
{}ShoppingListItemCreate.extras
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""ShoppingListItemCreate.note
0ShoppingListItemCreate.position
1ShoppingListItemCreate.quantity
[]ShoppingListItemCreate.recipeReferences
0ShoppingListItemRecipeRefCreate.recipeQuantity
1ShoppingListItemRecipeRefCreate.recipeScale
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Path Parameters
item_id1 / 2
#validinvalidschema
1250{
2250 "format": "uuid4",
325n/a "type": "string"
4250}
Headers
accept-language3 / 3
114n/a{
214n/a "anyOf": [
310n/a {
410n/a "type": "string"
510n/a },
6410 {
7410 "type": "null"
8410 }
914n/a ],
1014n/a}
Responses
codedescriptionhitsavg
200Successful Response1521ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1024ms
Path Parameters
item_id2 / 2
#validinvalidschema
151313{
251313 "format": "uuid4",
3526n/a "type": "string"
451313}
Headers
accept-language3 / 3
1113n/a{
2113n/a "anyOf": [
381n/a {
481n/a "type": "string"
581n/a },
63281 {
73281 "type": "null"
83281 }
9113n/a ],
10113n/a}
Responses
codedescriptionhitsavg
200Successful Response13420ms
422Validation Error1312ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found37913ms
Path Parameters
item_id2 / 2
#validinvalidschema
192522{
292522 "format": "uuid4",
3947n/a "type": "string"
492522}
Headers
accept-language3 / 3
1610n/a{
2610n/a "anyOf": [
3563n/a {
4563n/a "type": "string"
5563n/a },
647563 {
747563 "type": "null"
847563 }
9610n/a ],
10610n/a}
Body
application/json176 / 204
ShoppingListItemUpdate
1555351{
2564337 "properties": {
35215 "checked": {
45215 "type": "boolean"
55215 },
65125 "display": {
75125 "type": "string"
85125 },
95154 "extras": {
105154 "anyOf": [
1148435 {
121n/a "additionalProperties": true,
1348435 "type": "object"
1448435 },
1531488 {
1631488 "type": "null"
1731488 }
185154 ],
195154 },
20410121 "food": {
21410121 "anyOf": [
2259472 {
2459472 },
2592439 {
2792439 },
28318213 {
29318213 "type": "null"
30318213 }
31410121 ],
32410121 },
335014 "foodId": {
345014 "anyOf": [
3548124 {
364810 "format": "uuid4",
3748124 "type": "string"
3848124 },
3920485 {
4020485 "type": "null"
4120485 }
425014 ],
435014 },
444984 "labelId": {
454984 "anyOf": [
4647725 {
474770 "format": "uuid4",
4847725 "type": "string"
4947725 },
5021481 {
5121481 "type": "null"
5221481 }
534984 ],
544984 },
554974 "note": {
564974 "anyOf": [
5749011 {
5849011 "type": "string"
5949011 },
607494 {
617494 "type": "null"
627494 }
634974 ],
644974 },
654836 "position": {
664836 "type": "integer"
674836 },
685035 "quantity": {
695035 "type": "number"
705035 },
7150049 "recipeReferences": {
7250044 "items": {
7318645 "anyOf": [
7418645 {
7618645 },
7764167 {
7964167 }
8018645 ]
8150044 },
825445 "type": "array"
8350049 },
848875 "shoppingListId": {
858870 "format": "uuid4",
868875 "type": "string"
878875 },
88379124 "unit": {
89379124 "anyOf": [
9055448 {
9255448 },
9380423 {
9580423 },
96299204 {
97299204 "type": "null"
98299204 }
99379124 ],
100379124 },
1014954 "unitId": {
1024954 "anyOf": [
10347722 {
1044770 "format": "uuid4",
10547722 "type": "string"
10647722 },
10718481 {
10818481 "type": "null"
10918481 }
1104954 ],
1114954 }
112564337 },
1138929 "required": [
1148929 "shoppingListId"
1158929 ],
1169015 "type": "object"
117555351}
Referenced Components (11)180 of 209 keywords
CreateIngredientFood29 of 30 keywords
192439{
294114 "properties": {
313037 "aliases": {
413027 "items": {
613027 },
715710 "type": "array"
813037 },
914410 "description": {
1014410 "type": "string"
1114410 },
1215510 "extras": {
1315510 "anyOf": [
1413827 {
151n/a "additionalProperties": true,
1613827 "type": "object"
1713827 },
1817148 {
1917148 "type": "null"
2017148 }
2115510 ],
2215510 },
2312825 "householdsWithIngredientFood": {
2412815 "items": {
257730 "type": "string"
2612815 },
2714310 "type": "array"
2812825 },
291669 "id": {
301669 "anyOf": [
3116411 {
321641 "format": "uuid4",
3316510 "type": "string"
3416411 },
352173 {
362173 "type": "null"
372173 }
381669 ],
391669 },
4014110 "labelId": {
4114110 "anyOf": [
4212922 {
431290 "format": "uuid4",
4412922 "type": "string"
4512922 },
4612139 {
4712139 "type": "null"
4812139 }
4914110 ],
5014110 },
5119610 "name": {
5219610 "type": "string"
5319610 },
541378 "pluralName": {
551378 "anyOf": [
5617128 {
5717128 "type": "string"
5817128 },
5912025 {
6012025 "type": "null"
6112025 }
621378 ],
631378 }
6494114 },
652063 "required": [
662063 "name"
672063 ],
68209322 "type": "object"
6992439}
CreateIngredientFoodAlias6 of 6 keywords
116627{
216610 "properties": {
316610 "name": {
416610 "type": "string"
516610 }
616610 },
71762 "required": [
81762 "name"
91762 ],
1017815 "type": "object"
1116627}
CreateIngredientUnit29 of 30 keywords
180423{
282117 "properties": {
314910 "abbreviation": {
414910 "type": "string"
514910 },
612534 "aliases": {
712524 "items": {
912524 },
1014910 "type": "array"
1112534 },
1214610 "description": {
1314610 "type": "string"
1414610 },
151478 "extras": {
161478 "anyOf": [
1713718 {
181n/a "additionalProperties": true,
1913718 "type": "object"
2013718 },
2110145 {
2210145 "type": "null"
2310145 }
241478 ],
251478 },
2614210 "fraction": {
2714210 "type": "boolean"
2814210 },
291728 "id": {
301728 "anyOf": [
3116911 {
321690 "format": "uuid4",
3316911 "type": "string"
3416911 },
353177 {
363177 "type": "null"
373177 }
381728 ],
391728 },
4018710 "name": {
4118710 "type": "string"
4218710 },
431448 "pluralAbbreviation": {
441448 "anyOf": [
4514111 {
4614111 "type": "string"
4714111 },
483149 {
493149 "type": "null"
503149 }
511448 ],
521448 },
531418 "pluralName": {
541418 "anyOf": [
5511138 {
5611138 "type": "string"
5711138 },
5813019 {
5913019 "type": "null"
6013019 }
611418 ],
621418 },
6313611 "useAbbreviation": {
6413611 "type": "boolean"
6513611 }
6682117 },
671973 "required": [
681973 "name"
691973 ],
70200303 "type": "object"
7180423}
CreateIngredientUnitAlias6 of 6 keywords
11424{
21412 "properties": {
31412 "name": {
41412 "type": "string"
51412 }
61412 },
7262 "required": [
8262 "name"
9262 ],
102810 "type": "object"
111424}
IngredientFood-Input34 of 41 keywords
159472{
292116 "properties": {
313037 "aliases": {
413027 "items": {
613027 },
715710 "type": "array"
813037 },
9890 "createdAt": {
10890 "anyOf": [
11863 {
12860 "format": "date-time",
13863 "type": "string"
14863 },
15386 {
16386 "type": "null"
17386 }
18890 ],
19890 },
2014410 "description": {
2114410 "type": "string"
2214410 },
2315510 "extras": {
2415510 "anyOf": [
2513827 {
261n/a "additionalProperties": true,
2713827 "type": "object"
2813827 },
2917148 {
3017148 "type": "null"
3117148 }
3215510 ],
3315510 },
3412825 "householdsWithIngredientFood": {
3512815 "items": {
367730 "type": "string"
3712815 },
3814310 "type": "array"
3912825 },
4016411 "id": {
411641 "format": "uuid4",
4216510 "type": "string"
4316411 },
44800 "label": {
45800 "anyOf": [
46773 {
48773 },
49737 {
50737 "type": "null"
51737 }
52800 ]
53800 },
5414110 "labelId": {
5514110 "anyOf": [
5612922 {
571290 "format": "uuid4",
5812922 "type": "string"
5912922 },
6012139 {
6112139 "type": "null"
6212139 }
6314110 ],
6414110 },
6519610 "name": {
6619610 "type": "string"
6719610 },
681378 "pluralName": {
691378 "anyOf": [
7017128 {
7117128 "type": "string"
7217128 },
7312025 {
7412025 "type": "null"
7512025 }
761378 ],
771378 },
78732 "update_at": {
79732 "anyOf": [
80714 {
81710 "format": "date-time",
82714 "type": "string"
83714 },
84273 {
85273 "type": "null"
86273 }
87732 ],
88732 }
8992116 },
9017336 "required": [
9117534 "id",
922063 "name"
9317336 ],
94209322 "type": "object"
9559472}
IngredientFoodAlias6 of 6 keywords
116627{
216610 "properties": {
316610 "name": {
416610 "type": "string"
516610 }
616610 },
71762 "required": [
81762 "name"
91762 ],
1017815 "type": "object"
1116627}
IngredientUnit-Input33 of 37 keywords
155448{
274125 "properties": {
314910 "abbreviation": {
414910 "type": "string"
514910 },
612534 "aliases": {
712524 "items": {
912524 },
1014910 "type": "array"
1112534 },
12875 "createdAt": {
13875 "anyOf": [
148111 {
15815 "format": "date-time",
16866 "type": "string"
178111 },
18686 {
19686 "type": "null"
20686 }
21875 ],
22875 },
2314610 "description": {
2414610 "type": "string"
2514610 },
261478 "extras": {
271478 "anyOf": [
2813718 {
291n/a "additionalProperties": true,
3013718 "type": "object"
3113718 },
3210145 {
3310145 "type": "null"
3410145 }
351478 ],
361478 },
3714210 "fraction": {
3814210 "type": "boolean"
3914210 },
4016911 "id": {
411690 "format": "uuid4",
4216911 "type": "string"
4316911 },
4418710 "name": {
4518710 "type": "string"
4618710 },
471448 "pluralAbbreviation": {
481448 "anyOf": [
4914111 {
5014111 "type": "string"
5114111 },
523149 {
533149 "type": "null"
543149 }
551448 ],
561448 },
571418 "pluralName": {
581418 "anyOf": [
5911138 {
6011138 "type": "string"
6111138 },
6213019 {
6313019 "type": "null"
6413019 }
651418 ],
661418 },
67790 "update_at": {
68790 "anyOf": [
69772 {
70770 "format": "date-time",
71772 "type": "string"
72772 },
73277 {
74277 "type": "null"
75277 }
76790 ],
77790 },
7813611 "useAbbreviation": {
7913611 "type": "boolean"
8013611 }
8174125 },
8217822 "required": [
8318020 "id",
841973 "name"
8517822 ],
86200303 "type": "object"
8755448}
IngredientUnitAlias6 of 6 keywords
11424{
21412 "properties": {
31412 "name": {
41412 "type": "string"
51412 }
61412 },
7262 "required": [
8262 "name"
9262 ],
102810 "type": "object"
111424}
MultiPurposeLabelSummary1 of 11 keywords
1773{
270 "properties": {
330 "color": {
430 "type": "string"
530 },
670 "groupId": {
770 "format": "uuid4",
870 "type": "string"
970 },
1070 "id": {
1170 "format": "uuid4",
1270 "type": "string"
1370 },
1470 "name": {
1570 "type": "string"
1670 }
1770 },
1870 "required": [
1970 "name",
2070 "groupId",
2170 "id"
2270 ],
23773 "type": "object"
24773}
ShoppingListItemRecipeRefCreate15 of 16 keywords
118645{
218838 "properties": {
321410 "recipeId": {
42140 "format": "uuid4",
521410 "type": "string"
621410 },
7978 "recipeNote": {
8978 "anyOf": [
92976 {
102976 "type": "string"
112976 },
126837 {
136837 "type": "null"
146837 }
15978 ],
16978 },
179910 "recipeQuantity": {
189910 "type": "number"
199910 },
209610 "recipeScale": {
219610 "anyOf": [
226838 {
236838 "type": "number"
246838 },
252878 {
262878 "type": "null"
272878 }
289610 ],
299610 }
3018838 },
312242 "required": [
322242 "recipeId"
332242 ],
342265 "type": "object"
3518645}
ShoppingListItemRecipeRefUpdate15 of 20 keywords
164167{
218838 "properties": {
3850 "id": {
4850 "format": "uuid4",
5850 "type": "string"
6850 },
721410 "recipeId": {
82140 "format": "uuid4",
921410 "type": "string"
1021410 },
11978 "recipeNote": {
12978 "anyOf": [
132976 {
142976 "type": "string"
152976 },
166837 {
176837 "type": "null"
186837 }
19978 ],
20978 },
219910 "recipeQuantity": {
229910 "type": "number"
239910 },
249610 "recipeScale": {
259610 "anyOf": [
266838 {
276838 "type": "number"
286838 },
292878 {
302878 "type": "null"
312878 }
329610 ],
339610 },
34850 "shoppingListItemId": {
35850 "format": "uuid4",
36850 "type": "string"
37850 }
3818838 },
3984142 "required": [
402242 "recipeId",
4185141 "id",
4285141 "shoppingListItemId"
4384142 ],
442265 "type": "object"
4564167}
Responses
codedescriptionhitsavg
200Successful Response49334ms
422Validation Error3314ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error10731ms
400Bad Request161ms
Examples
Body: application/json
falseShoppingListItemUpdate.checked
""ShoppingListItemUpdate.display
{}ShoppingListItemUpdate.extras
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""ShoppingListItemUpdate.note
0ShoppingListItemUpdate.position
1ShoppingListItemUpdate.quantity
[]ShoppingListItemUpdate.recipeReferences
0ShoppingListItemRecipeRefCreate.recipeQuantity
1ShoppingListItemRecipeRefCreate.recipeScale
0ShoppingListItemRecipeRefUpdate.recipeQuantity
1ShoppingListItemRecipeRefUpdate.recipeScale
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Households: Shopping Lists 9 operations 4 covered 5 partial 0 uncovered 0 not measured 91% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1226n/a{
2226n/a "anyOf": [
3180n/a {
4180n/a "type": "string"
5180n/a },
646180 {
746180 "type": "null"
846180 }
9226n/a ],
10226n/a}
orderByNullPosition5 / 5
1139147{
2139147 "anyOf": [
384202 {
584202 },
655231 {
755231 "type": "null"
855231 }
9139147 ],
10139147}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
184202{
284202 "enum": [
351n/a "first",
433n/a "last"
584202 ],
6231n/a "type": "string"
784202}
orderDirection2 / 2
OrderDirection
117026{
217026 "enum": [
3121n/a "asc",
449n/a "desc"
517026 ],
6196n/a "type": "string"
717026}
queryFilter3 / 3
1164n/a{
2164n/a "anyOf": [
3130n/a {
4130n/a "type": "string"
5130n/a },
634130 {
734130 "type": "null"
834130 }
9164n/a ],
10164n/a}
paginationSeed3 / 3
1186n/a{
2186n/a "anyOf": [
3151n/a {
4151n/a "type": "string"
5151n/a },
635151 {
735151 "type": "null"
835151 }
9186n/a ],
10186n/a}
page1 / 1
116125{
216125 "type": "integer"
316125}
perPage1 / 1
111278{
211278 "type": "integer"
311278}
Headers
accept-language3 / 3
1399n/a{
2399n/a "anyOf": [
3267n/a {
4267n/a "type": "string"
5267n/a },
6132267 {
7132267 "type": "null"
8132267 }
9399n/a ],
10399n/a}
Responses
codedescriptionhitsavg
200Successful Response15596ms
422Validation Error1999ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3114ms
500Internal Server Error89230ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1379n/a{
2379n/a "anyOf": [
3253n/a {
4253n/a "type": "string"
5253n/a },
6126253 {
7126253 "type": "null"
8126253 }
9379n/a ],
10379n/a}
Body
application/json17 / 17
ShoppingListCreate
1349139{
2190115 "properties": {
315452 "createdAt": {
415452 "anyOf": [
512680 {
612619 "format": "date-time",
714561 "type": "string"
812680 },
928178 {
1028178 "type": "null"
1128178 }
1215452 ],
1315452 },
1414742 "extras": {
1514742 "anyOf": [
1680109 {
171n/a "additionalProperties": true,
1880109 "type": "object"
1980109 },
2067122 {
2167122 "type": "null"
2267122 }
2314742 ],
2414742 },
2515132 "name": {
2615132 "anyOf": [
279687 {
289687 "type": "string"
299687 },
3055128 {
3155128 "type": "null"
3255128 }
3315132 ],
3415132 },
3513849 "update_at": {
3613849 "anyOf": [
3711869 {
3811819 "format": "date-time",
3913750 "type": "string"
4011869 },
4120167 {
4220167 "type": "null"
4320167 }
4413849 ],
4513849 }
46190115 },
4746424 "type": "object"
48349139}
Responses
codedescriptionhitsavg
201Successful Response32893ms
422Validation Error3293ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5314ms
400Bad Request141ms
Examples
Body: application/json
{}ShoppingListCreate.extras
Path Parameters
item_id1 / 2
#validinvalidschema
1540{
2540 "format": "uuid4",
354n/a "type": "string"
4540}
Headers
accept-language3 / 3
125n/a{
225n/a "anyOf": [
319n/a {
419n/a "type": "string"
519n/a },
6619 {
7619 "type": "null"
8619 }
925n/a ],
1025n/a}
Responses
codedescriptionhitsavg
200Successful Response1856ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3412ms
400Bad Request221ms
Path Parameters
item_id2 / 2
#validinvalidschema
146530{
246530 "format": "uuid4",
3495n/a "type": "string"
446530}
Headers
accept-language3 / 3
1126n/a{
2126n/a "anyOf": [
387n/a {
487n/a "type": "string"
587n/a },
63987 {
73987 "type": "null"
83987 }
9126n/a ],
10126n/a}
Responses
codedescriptionhitsavg
200Successful Response8220ms
422Validation Error3027ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found36213ms
500Internal Server Error2122ms
Path Parameters
item_id2 / 2
#validinvalidschema
1850103{
2850103 "format": "uuid4",
3953n/a "type": "string"
4850103}
Headers
accept-language3 / 3
1608n/a{
2608n/a "anyOf": [
3563n/a {
4563n/a "type": "string"
5563n/a },
645563 {
745563 "type": "null"
845563 }
9608n/a ],
10608n/a}
Body
application/json158 / 175
ShoppingListUpdate
1402385{
2407375 "properties": {
35598 "createdAt": {
45598 "anyOf": [
554621 {
65464 "format": "date-time",
755017 "type": "string"
854621 },
913554 {
1013554 "type": "null"
1113554 }
125598 ],
135598 },
145484 "extras": {
155484 "anyOf": [
1650250 {
171n/a "additionalProperties": true,
1850250 "type": "object"
1950250 },
2046506 {
2146506 "type": "null"
2246506 }
235484 ],
245484 },
257735 "groupId": {
267730 "format": "uuid4",
277735 "type": "string"
287735 },
297755 "id": {
307750 "format": "uuid4",
317755 "type": "string"
327755 },
33206338 "listItems": {
34206333 "items": {
36206333 },
375395 "type": "array"
38206338 },
395444 "name": {
405444 "anyOf": [
4151497 {
4251497 "type": "string"
4351497 },
4449355 {
4549355 "type": "null"
4649355 }
475444 ],
485444 },
495496 "update_at": {
505496 "anyOf": [
5153223 {
525322 "format": "date-time",
5353421 "type": "string"
5453223 },
5517538 {
5617538 "type": "null"
5717538 }
585496 ],
595496 },
607755 "userId": {
617750 "format": "uuid4",
627755 "type": "string"
637755 }
64407375 },
657766 "required": [
667784 "groupId",
677802 "userId",
687802 "id"
697766 ],
707825 "type": "object"
71402385}
Referenced Components (7)172 of 186 keywords
IngredientFood-Input39 of 41 keywords
164424{
26693 "properties": {
312416 "aliases": {
412411 "items": {
612411 },
71355 "type": "array"
812416 },
91356 "createdAt": {
101356 "anyOf": [
1112318 {
121232 "format": "date-time",
1312516 "type": "string"
1412318 },
1512129 {
1612129 "type": "null"
1712129 }
181356 ],
191356 },
201345 "description": {
211345 "type": "string"
221345 },
231334 "extras": {
241334 "anyOf": [
2512512 {
261n/a "additionalProperties": true,
2712512 "type": "object"
2812512 },
298129 {
308129 "type": "null"
318129 }
321334 ],
331334 },
3412410 "householdsWithIngredientFood": {
351245 "items": {
36695 "type": "string"
371245 },
381295 "type": "array"
3912410 },
401535 "id": {
411530 "format": "uuid4",
421535 "type": "string"
431535 },
4410928 "label": {
4510928 "anyOf": [
4611126 {
4811126 },
499839 {
509839 "type": "null"
519839 }
5210928 ]
5310928 },
541274 "labelId": {
551274 "anyOf": [
5611714 {
571170 "format": "uuid4",
5811714 "type": "string"
5911714 },
6010121 {
6110121 "type": "null"
6210121 }
631274 ],
641274 },
651535 "name": {
661535 "type": "string"
671535 },
681294 "pluralName": {
691294 "anyOf": [
7012121 {
7112121 "type": "string"
7212121 },
7311716 {
7411716 "type": "null"
7511716 }
761294 ],
771294 },
781246 "update_at": {
791246 "anyOf": [
8010624 {
811062 "format": "date-time",
8210822 "type": "string"
8310624 },
8418112 {
8518112 "type": "null"
8618112 }
871246 ],
881246 }
896693 },
901573 "required": [
911582 "id",
921582 "name"
931573 ],
94160328 "type": "object"
9564424}
IngredientFoodAlias6 of 6 keywords
17211{
2725 "properties": {
3725 "name": {
4725 "type": "string"
5725 }
6725 },
7771 "required": [
8771 "name"
9771 ],
10785 "type": "object"
117211}
IngredientUnit-Input36 of 37 keywords
163412{
26570 "properties": {
3955 "abbreviation": {
4955 "type": "string"
5955 },
68616 "aliases": {
78611 "items": {
98611 },
10975 "type": "array"
118616 },
12966 "createdAt": {
13966 "anyOf": [
149012 {
15902 "format": "date-time",
169210 "type": "string"
179012 },
18696 {
19696 "type": "null"
20696 }
21966 ],
22966 },
23965 "description": {
24965 "type": "string"
25965 },
26994 "extras": {
27994 "anyOf": [
288617 {
291n/a "additionalProperties": true,
308617 "type": "object"
318617 },
321390 {
331390 "type": "null"
341390 }
35994 ],
36994 },
37935 "fraction": {
38935 "type": "boolean"
39935 },
401295 "id": {
411290 "format": "uuid4",
421295 "type": "string"
431295 },
441295 "name": {
451295 "type": "string"
461295 },
47924 "pluralAbbreviation": {
48924 "anyOf": [
49906 {
50906 "type": "string"
51906 },
52294 {
53294 "type": "null"
54294 }
55924 ],
56924 },
57934 "pluralName": {
58934 "anyOf": [
591087 {
601087 "type": "string"
611087 },
628314 {
638314 "type": "null"
648314 }
65934 ],
66934 },
67866 "update_at": {
68866 "anyOf": [
697814 {
70782 "format": "date-time",
718012 "type": "string"
727814 },
73884 {
74884 "type": "null"
75884 }
76866 ],
77866 },
78895 "useAbbreviation": {
79895 "type": "boolean"
80895 }
816570 },
821333 "required": [
831342 "id",
841342 "name"
851333 ],
86136339 "type": "object"
8763412}
IngredientUnitAlias6 of 6 keywords
13411{
2345 "properties": {
3345 "name": {
4345 "type": "string"
5345 }
6345 },
7391 "required": [
8391 "name"
9391 ],
10405 "type": "object"
113411}
MultiPurposeLabelSummary9 of 11 keywords
155578{
26140 "properties": {
36010 "color": {
46010 "type": "string"
56010 },
68910 "groupId": {
7890 "format": "uuid4",
88910 "type": "string"
98910 },
108910 "id": {
11890 "format": "uuid4",
128910 "type": "string"
138910 },
148910 "name": {
158910 "type": "string"
168910 }
176140 },
18958 "required": [
19994 "name",
20994 "groupId",
21994 "id"
22958 ],
23103530 "type": "object"
2455578}
ShoppingListItemOut-Input58 of 65 keywords
1329333{
2334323 "properties": {
34765 "checked": {
44765 "type": "boolean"
54765 },
64876 "createdAt": {
74876 "anyOf": [
844152 {
94412 "format": "date-time",
1044350 "type": "string"
1144152 },
1246447 {
1346447 "type": "null"
1446447 }
154876 ],
164876 },
175025 "display": {
185025 "type": "string"
195025 },
204724 "extras": {
214724 "anyOf": [
2242056 {
231n/a "additionalProperties": true,
2442056 "type": "object"
2542056 },
2652424 {
2752424 "type": "null"
2852424 }
294724 ],
304724 },
31388100 "food": {
32388100 "anyOf": [
3364424 {
3564424 },
36324164 {
37324164 "type": "null"
38324164 }
39388100 ]
40388100 },
414894 "foodId": {
424894 "anyOf": [
4345934 {
444590 "format": "uuid4",
4545934 "type": "string"
4645934 },
4730463 {
4830463 "type": "null"
4930463 }
504894 ],
514894 },
526475 "groupId": {
536470 "format": "uuid4",
546475 "type": "string"
556475 },
566475 "householdId": {
576470 "format": "uuid4",
586475 "type": "string"
596475 },
606475 "id": {
616470 "format": "uuid4",
626475 "type": "string"
636475 },
6446828 "label": {
6546828 "anyOf": [
6644452 {
6844452 },
6942472 {
7042472 "type": "null"
7142472 }
7246828 ]
7346828 },
744624 "labelId": {
754624 "anyOf": [
7643531 {
774350 "format": "uuid4",
7843531 "type": "string"
7943531 },
8027439 {
8127439 "type": "null"
8227439 }
834624 ],
844624 },
854944 "note": {
864944 "anyOf": [
8744355 {
8844355 "type": "string"
8944355 },
9051447 {
9151447 "type": "null"
9251447 }
934944 ],
944944 },
954846 "position": {
964846 "type": "integer"
974846 },
984715 "quantity": {
994715 "type": "number"
1004715 },
10144745 "recipeReferences": {
10244740 "items": {
10444740 },
1054875 "type": "array"
10644745 },
1076485 "shoppingListId": {
1086480 "format": "uuid4",
1096485 "type": "string"
1106485 },
11139877 "unit": {
11239877 "anyOf": [
11363412 {
11563412 },
116335140 {
117335140 "type": "null"
118335140 }
11939877 ]
12039877 },
1214734 "unitId": {
1224734 "anyOf": [
12343443 {
1244340 "format": "uuid4",
12543443 "type": "string"
12643443 },
12739438 {
12839438 "type": "null"
12939438 }
1304734 ],
1314734 },
1324636 "update_at": {
1334636 "anyOf": [
13443633 {
1354362 "format": "date-time",
13643831 "type": "string"
13743633 },
13827442 {
13927442 "type": "null"
14027442 }
1414636 ],
1424636 }
143334323 },
1446498 "required": [
1456534 "shoppingListId",
1466525 "id",
1476525 "groupId",
1486525 "householdId"
1496498 ],
1506575 "type": "object"
151329333}
ShoppingListItemRecipeRefOut18 of 20 keywords
132640{
233130 "properties": {
33515 "id": {
43510 "format": "uuid4",
53515 "type": "string"
63515 },
73537 "recipeId": {
83532 "format": "uuid4",
93555 "type": "string"
103537 },
111764 "recipeNote": {
121764 "anyOf": [
1379101 {
1479101 "type": "string"
1579101 },
169783 {
179783 "type": "null"
189783 }
191764 ],
201764 },
211865 "recipeQuantity": {
221865 "type": "number"
231865 },
241714 "recipeScale": {
251714 "anyOf": [
2610570 {
2710570 "type": "number"
2810570 },
2966109 {
3066109 "type": "null"
3166109 }
321714 ],
331714 },
343515 "shoppingListItemId": {
353510 "format": "uuid4",
363515 "type": "string"
373515 }
3833130 },
393547 "required": [
403601 "recipeId",
413565 "id",
423565 "shoppingListItemId"
433547 ],
443615 "type": "object"
4532640}
Responses
codedescriptionhitsavg
200Successful Response14721ms
422Validation Error4343ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2013ms
400Bad Request13723ms
404Not Found21518ms
Examples
Body: application/json
{}ShoppingListUpdate.extras
[]ShoppingListUpdate.listItems
falseShoppingListItemOut-Input.checked
""ShoppingListItemOut-Input.display
{}ShoppingListItemOut-Input.extras
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
""ShoppingListItemOut-Input.note
0ShoppingListItemOut-Input.position
1ShoppingListItemOut-Input.quantity
[]ShoppingListItemOut-Input.recipeReferences
0ShoppingListItemRecipeRefOut.recipeQuantity
1ShoppingListItemRecipeRefOut.recipeScale
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
Path Parameters
item_id2 / 2
#validinvalidschema
149235{
249235 "format": "uuid4",
3527n/a "type": "string"
449235}
Headers
accept-language3 / 3
1272n/a{
2272n/a "anyOf": [
3179n/a {
4179n/a "type": "string"
5179n/a },
693179 {
793179 "type": "null"
893179 }
9272n/a ],
10272n/a}
Body
application/json9 / 12
145342{
245333 "items": {
445333 },
54869 "type": "array"
645342}
Referenced Components (1)9 of 12 keywords
ShoppingListMultiPurposeLabelUpdate9 of 12 keywords
171433{
272121 "properties": {
37365 "id": {
47360 "format": "uuid4",
57365 "type": "string"
67365 },
77365 "labelId": {
87360 "format": "uuid4",
97365 "type": "string"
107365 },
114086 "position": {
124086 "type": "integer"
134086 },
147325 "shoppingListId": {
157320 "format": "uuid4",
167325 "type": "string"
177325 }
1872121 },
197357 "required": [
207375 "shoppingListId",
217411 "labelId",
227411 "id"
237357 ],
247425 "type": "object"
2571433}
Responses
codedescriptionhitsavg
200Successful Response6224ms
422Validation Error10111ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request13412ms
404Not Found22516ms
500Internal Server Error521ms
Examples
Body: application/json
0ShoppingListMultiPurposeLabelUpdate.position
Path Parameters
item_id2 / 2
#validinvalidschema
196011{
296011 "format": "uuid4",
3971n/a "type": "string"
496011}
Headers
accept-language3 / 3
1631n/a{
2631n/a "anyOf": [
3565n/a {
4565n/a "type": "string"
5565n/a },
666565 {
766565 "type": "null"
866565 }
9631n/a ],
10631n/a}
Body
application/json160 / 173
1607312{
2607301 "items": {
4607301 },
590811 "type": "array"
6607312}
Referenced Components (11)202 of 218 keywords
CreateIngredientFood29 of 30 keywords
1153419{
2155121 "properties": {
314432 "aliases": {
414422 "items": {
614422 },
716610 "type": "array"
814432 },
917010 "description": {
1017010 "type": "string"
1117010 },
121709 "extras": {
131709 "anyOf": [
1414138 {
151n/a "additionalProperties": true,
1614138 "type": "object"
1714138 },
1829150 {
1929150 "type": "null"
2029150 }
211709 ],
221709 },
2314931 "householdsWithIngredientFood": {
2414910 "items": {
2522210 "type": "string"
2614910 },
2715921 "type": "array"
2814931 },
2922813 "id": {
3022813 "anyOf": [
3121625 {
322165 "format": "uuid4",
3322120 "type": "string"
3421625 },
3512229 {
3612229 "type": "null"
3712229 }
3822813 ],
3922813 },
401578 "labelId": {
411578 "anyOf": [
4213431 {
431340 "format": "uuid4",
4413431 "type": "string"
4513431 },
4623142 {
4723142 "type": "null"
4823142 }
491578 ],
501578 },
5126410 "name": {
5226410 "type": "string"
5326410 },
541608 "pluralName": {
551608 "anyOf": [
5622146 {
5722146 "type": "string"
5822146 },
5913830 {
6013830 "type": "null"
6113830 }
621608 ],
631608 }
64155121 },
652743 "required": [
662743 "name"
672743 ],
68277295 "type": "object"
69153419}
CreateIngredientFoodAlias6 of 6 keywords
113422{
213410 "properties": {
313410 "name": {
413410 "type": "string"
513410 }
613410 },
71442 "required": [
81442 "name"
91442 ],
1014610 "type": "object"
1113422}
CreateIngredientUnit29 of 30 keywords
1185372{
2187118 "properties": {
318413 "abbreviation": {
418413 "type": "string"
518413 },
616832 "aliases": {
716822 "items": {
916822 },
1019010 "type": "array"
1116832 },
1218110 "description": {
1318110 "type": "string"
1418110 },
151928 "extras": {
161928 "anyOf": [
1716040 {
181n/a "additionalProperties": true,
1916040 "type": "object"
2016040 },
2132168 {
2232168 "type": "null"
2332168 }
241928 ],
251928 },
2617710 "fraction": {
2717710 "type": "boolean"
2817710 },
292508 "id": {
302508 "anyOf": [
3123523 {
322350 "format": "uuid4",
3323523 "type": "string"
3423523 },
3515243 {
3615243 "type": "null"
3715243 }
382508 ],
392508 },
4029013 "name": {
4129013 "type": "string"
4229013 },
431819 "pluralAbbreviation": {
441819 "anyOf": [
4515634 {
4615634 "type": "string"
4715634 },
4825165 {
4925165 "type": "null"
5025165 }
511819 ],
521819 },
531808 "pluralName": {
541808 "anyOf": [
5537151 {
5637151 "type": "string"
5737151 },
5814345 {
5914345 "type": "null"
6014345 }
611808 ],
621808 },
6317610 "useAbbreviation": {
6417610 "type": "boolean"
6517610 }
66187118 },
673033 "required": [
683033 "name"
693033 ],
70306251 "type": "object"
71185372}
CreateIngredientUnitAlias6 of 6 keywords
123522{
223510 "properties": {
323510 "name": {
423510 "type": "string"
523510 }
623510 },
72452 "required": [
82452 "name"
92452 ],
1024710 "type": "object"
1123522}
IngredientFood-Input34 of 41 keywords
1105467{
2142134 "properties": {
314432 "aliases": {
414422 "items": {
614422 },
716610 "type": "array"
814432 },
9900 "createdAt": {
10900 "anyOf": [
118010 {
12800 "format": "date-time",
138010 "type": "string"
148010 },
151080 {
161080 "type": "null"
171080 }
18900 ],
19900 },
2017010 "description": {
2117010 "type": "string"
2217010 },
231709 "extras": {
241709 "anyOf": [
2514138 {
261n/a "additionalProperties": true,
2714138 "type": "object"
2814138 },
2929150 {
3029150 "type": "null"
3129150 }
321709 ],
331709 },
3414931 "householdsWithIngredientFood": {
3514910 "items": {
3622210 "type": "string"
3714910 },
3815921 "type": "array"
3914931 },
4021625 "id": {
412165 "format": "uuid4",
4222120 "type": "string"
4321625 },
448117 "label": {
458117 "anyOf": [
461385 {
481385 },
496830 {
506830 "type": "null"
516830 }
528117 ]
538117 },
541578 "labelId": {
551578 "anyOf": [
5613431 {
571340 "format": "uuid4",
5813431 "type": "string"
5913431 },
6023142 {
6123142 "type": "null"
6223142 }
631578 ],
641578 },
6526410 "name": {
6626410 "type": "string"
6726410 },
681608 "pluralName": {
691608 "anyOf": [
7022146 {
7122146 "type": "string"
7222146 },
7313830 {
7413830 "type": "null"
7513830 }
761608 ],
771608 },
78850 "update_at": {
79850 "anyOf": [
807213 {
81720 "format": "date-time",
827213 "type": "string"
837213 },
841372 {
851372 "type": "null"
861372 }
87850 ],
88850 }
89142134 },
9023938 "required": [
9124136 "id",
922743 "name"
9323938 ],
94277295 "type": "object"
95105467}
IngredientFoodAlias6 of 6 keywords
113422{
213410 "properties": {
313410 "name": {
413410 "type": "string"
513410 }
613410 },
71442 "required": [
81442 "name"
91442 ],
1014610 "type": "object"
1113422}
IngredientUnit-Input35 of 37 keywords
1114443{
2163142 "properties": {
318413 "abbreviation": {
418413 "type": "string"
518413 },
616832 "aliases": {
716822 "items": {
916822 },
1019010 "type": "array"
1116832 },
12911 "createdAt": {
13911 "anyOf": [
148111 {
15811 "format": "date-time",
168210 "type": "string"
178111 },
181082 {
191082 "type": "null"
201082 }
21911 ],
22911 },
2318110 "description": {
2418110 "type": "string"
2518110 },
261928 "extras": {
271928 "anyOf": [
2816040 {
291n/a "additionalProperties": true,
3016040 "type": "object"
3116040 },
3232168 {
3332168 "type": "null"
3432168 }
351928 ],
361928 },
3717710 "fraction": {
3817710 "type": "boolean"
3917710 },
4023523 "id": {
412350 "format": "uuid4",
4223523 "type": "string"
4323523 },
4429013 "name": {
4529013 "type": "string"
4629013 },
471819 "pluralAbbreviation": {
481819 "anyOf": [
4915634 {
5015634 "type": "string"
5115634 },
5225165 {
5325165 "type": "null"
5425165 }
551819 ],
561819 },
571808 "pluralName": {
581808 "anyOf": [
5937151 {
6037151 "type": "string"
6137151 },
6214345 {
6314345 "type": "null"
6414345 }
651808 ],
661808 },
679412 "update_at": {
689412 "anyOf": [
698422 {
70840 "format": "date-time",
718422 "type": "string"
728422 },
731096 {
741096 "type": "null"
751096 }
769412 ],
779412 },
7817610 "useAbbreviation": {
7917610 "type": "boolean"
8017610 }
81163142 },
8225650 "required": [
8325848 "id",
843033 "name"
8525650 ],
86306251 "type": "object"
87114443}
IngredientUnitAlias6 of 6 keywords
123522{
223510 "properties": {
323510 "name": {
423510 "type": "string"
523510 }
623510 },
72452 "required": [
82452 "name"
92452 ],
1024710 "type": "object"
1123522}
MultiPurposeLabelSummary6 of 11 keywords
11385{
21317 "properties": {
3131 "color": {
4131 "type": "string"
5131 },
6255 "groupId": {
7255 "format": "uuid4",
8300 "type": "string"
9255 },
10300 "id": {
11300 "format": "uuid4",
12300 "type": "string"
13300 },
141911 "name": {
151911 "type": "string"
161911 }
171317 },
18300 "required": [
19300 "name",
20300 "groupId",
21300 "id"
22300 ],
233068 "type": "object"
241385}
RecipeIngredient-Input32 of 32 keywords
1538286{
2450279 "properties": {
35765 "display": {
45765 "type": "string"
55765 },
6444128 "food": {
7444128 "anyOf": [
8105467 {
10105467 },
11153419 {
13153419 },
14291281 {
15291281 "type": "null"
16291281 }
17444128 ],
18444128 },
195554 "note": {
205554 "anyOf": [
2147188 {
2247188 "type": "string"
2347188 },
2484475 {
2584475 "type": "null"
2684475 }
275554 ],
285554 },
295514 "originalText": {
305514 "anyOf": [
3190465 {
3290465 "type": "string"
3390465 },
3446194 {
3546194 "type": "null"
3646194 }
375514 ],
385514 },
395524 "quantity": {
405524 "anyOf": [
4146987 {
4246987 "type": "number"
4346987 },
4483473 {
4583473 "type": "null"
4683473 }
475524 ],
485524 },
495626 "referenceId": {
505621 "format": "uuid",
515635 "type": "string"
525626 },
535504 "title": {
545504 "anyOf": [
5596458 {
5696458 "type": "string"
5796458 },
58454100 {
59454100 "type": "null"
60454100 }
615504 ],
625504 },
63432125 "unit": {
64432125 "anyOf": [
65114443 {
67114443 },
68185372 {
70185372 },
71247310 {
72247310 "type": "null"
73247310 }
74432125 ],
75432125 }
76450279 },
778177 "type": "object"
78538286}
ShoppingListAddRecipeParamsBulk13 of 13 keywords
1736316{
2738309 "properties": {
3103015 "recipeId": {
4103010 "format": "uuid4",
510405 "type": "string"
6103015 },
76666 "recipeIncrementQuantity": {
86666 "type": "number"
96666 },
10387288 "recipeIngredients": {
11387288 "anyOf": [
12259416 {
13259278 "items": {
15259278 },
16537138 "type": "array"
17259416 },
18128547 {
19128547 "type": "null"
20128547 }
21387288 ],
22387288 }
23738309 },
2410452 "required": [
2510452 "recipeId"
2610452 ],
2710475 "type": "object"
28736316}
Responses
codedescriptionhitsavg
200Successful Response22163ms
422Validation Error3274ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error41931ms
400Bad Request41ms
Examples
Body: application/json
1ShoppingListAddRecipeParamsBulk.recipeIncrementQuantity
""RecipeIngredient-Input.display
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""RecipeIngredient-Input.note
0RecipeIngredient-Input.quantity
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Path Parameters
item_id2 / 2
#validinvalidschema
1100512{
2100512 "format": "uuid4",
31017n/a "type": "string"
4100512}
recipe_id2 / 2
110089{
210089 "format": "uuid4",
31017n/a "type": "string"
410089}
Headers
accept-language3 / 3
1622n/a{
2622n/a "anyOf": [
3547n/a {
4547n/a "type": "string"
5547n/a },
675547 {
775547 "type": "null"
875547 }
9622n/a ],
10622n/a}
Body
application/json155 / 171
1632302{
2632302 "anyOf": [
3266668 {
5266668 },
6366568 {
7366568 "type": "null"
8366568 }
9632302 ],
10632302}
Referenced Components (11)196 of 214 keywords
CreateIngredientFood28 of 30 keywords
193360{
295109 "properties": {
313037 "aliases": {
413022 "items": {
613022 },
715215 "type": "array"
813037 },
915110 "description": {
1015110 "type": "string"
1115110 },
121518 "extras": {
131518 "anyOf": [
1413821 {
151n/a "additionalProperties": true,
1613821 "type": "object"
1713821 },
1813146 {
1913146 "type": "null"
2013146 }
211518 ],
221518 },
2313820 "householdsWithIngredientFood": {
2413810 "items": {
2511410 "type": "string"
2613810 },
2714810 "type": "array"
2813820 },
291708 "id": {
301708 "anyOf": [
3116414 {
321640 "format": "uuid4",
3316414 "type": "string"
3416414 },
356172 {
366172 "type": "null"
376172 }
381708 ],
391708 },
401418 "labelId": {
411418 "anyOf": [
4212623 {
431260 "format": "uuid4",
4412623 "type": "string"
4512623 },
4615134 {
4715134 "type": "null"
4815134 }
491418 ],
501418 },
5119210 "name": {
5219210 "type": "string"
5319210 },
541418 "pluralName": {
551418 "anyOf": [
5615134 {
5715134 "type": "string"
5815134 },
5912623 {
6012623 "type": "null"
6112623 }
621418 ],
631418 }
6495109 },
652023 "required": [
662023 "name"
672023 ],
68205248 "type": "object"
6993360}
CreateIngredientFoodAlias6 of 6 keywords
114522{
214510 "properties": {
314510 "name": {
414510 "type": "string"
514510 }
614510 },
71552 "required": [
81552 "name"
91552 ],
1015710 "type": "object"
1114522}
CreateIngredientUnit29 of 30 keywords
199354{
2101139 "properties": {
316811 "abbreviation": {
416811 "type": "string"
516811 },
615932 "aliases": {
715922 "items": {
915922 },
1018110 "type": "array"
1115932 },
1217112 "description": {
1317112 "type": "string"
1417112 },
151668 "extras": {
161668 "anyOf": [
1715024 {
181n/a "additionalProperties": true,
1915024 "type": "object"
2015024 },
2116158 {
2216158 "type": "null"
2316158 }
241668 ],
251668 },
2615732 "fraction": {
2715732 "type": "boolean"
2815732 },
292078 "id": {
302078 "anyOf": [
3120213 {
322020 "format": "uuid4",
3320213 "type": "string"
3420213 },
355210 {
365210 "type": "null"
375210 }
382078 ],
392078 },
4022710 "name": {
4122710 "type": "string"
4222710 },
431578 "pluralAbbreviation": {
441578 "anyOf": [
4514817 {
4614817 "type": "string"
4714817 },
489156 {
499156 "type": "null"
509156 }
511578 ],
521578 },
531678 "pluralName": {
541678 "anyOf": [
5520155 {
5620155 "type": "string"
5720155 },
5814728 {
5914728 "type": "null"
6014728 }
611678 ],
621678 },
6314910 "useAbbreviation": {
6414910 "type": "boolean"
6514910 }
66101139 },
672374 "required": [
682374 "name"
692374 ],
70241212 "type": "object"
7199354}
CreateIngredientUnitAlias6 of 6 keywords
116822{
216810 "properties": {
316810 "name": {
416810 "type": "string"
516810 }
616810 },
71782 "required": [
81782 "name"
91782 ],
1018010 "type": "object"
1116822}
IngredientFood-Input35 of 41 keywords
159394{
282122 "properties": {
313037 "aliases": {
413022 "items": {
613022 },
715215 "type": "array"
813037 },
9871 "createdAt": {
10871 "anyOf": [
117612 {
12760 "format": "date-time",
137612 "type": "string"
147612 },
151177 {
161177 "type": "null"
171177 }
18871 ],
19871 },
2015110 "description": {
2115110 "type": "string"
2215110 },
231518 "extras": {
241518 "anyOf": [
2513821 {
261n/a "additionalProperties": true,
2713821 "type": "object"
2813821 },
2913146 {
3013146 "type": "null"
3113146 }
321518 ],
331518 },
3413820 "householdsWithIngredientFood": {
3513810 "items": {
3611410 "type": "string"
3713810 },
3814810 "type": "array"
3913820 },
4016414 "id": {
411640 "format": "uuid4",
4216414 "type": "string"
4316414 },
44806 "label": {
45806 "anyOf": [
46977 {
48977 },
497115 {
507115 "type": "null"
517115 }
52806 ]
53806 },
541418 "labelId": {
551418 "anyOf": [
5612623 {
571260 "format": "uuid4",
5812623 "type": "string"
5912623 },
6015134 {
6115134 "type": "null"
6215134 }
631418 ],
641418 },
6519210 "name": {
6619210 "type": "string"
6719210 },
681418 "pluralName": {
691418 "anyOf": [
7015134 {
7115134 "type": "string"
7215134 },
7312623 {
7412623 "type": "null"
7512623 }
761418 ],
771418 },
78780 "update_at": {
79780 "anyOf": [
80699 {
81690 "format": "date-time",
82699 "type": "string"
83699 },
84969 {
85969 "type": "null"
86969 }
87780 ],
88780 }
8982122 },
9017629 "required": [
9117827 "id",
922023 "name"
9317629 ],
94205248 "type": "object"
9559394}
IngredientFoodAlias6 of 6 keywords
114522{
214510 "properties": {
314510 "name": {
414510 "type": "string"
514510 }
614510 },
71552 "required": [
81552 "name"
91552 ],
1015710 "type": "object"
1114522}
IngredientUnit-Input35 of 37 keywords
167386{
293147 "properties": {
316811 "abbreviation": {
416811 "type": "string"
516811 },
615932 "aliases": {
715922 "items": {
915922 },
1018110 "type": "array"
1115932 },
121022 "createdAt": {
131022 "anyOf": [
14959 {
15950 "format": "date-time",
16959 "type": "string"
17959 },
18797 {
19797 "type": "null"
20797 }
211022 ],
221022 },
2317112 "description": {
2417112 "type": "string"
2517112 },
261668 "extras": {
271668 "anyOf": [
2815024 {
291n/a "additionalProperties": true,
3015024 "type": "object"
3115024 },
3216158 {
3316158 "type": "null"
3416158 }
351668 ],
361668 },
3715732 "fraction": {
3815732 "type": "boolean"
3915732 },
4020213 "id": {
412020 "format": "uuid4",
4220213 "type": "string"
4320213 },
4422710 "name": {
4522710 "type": "string"
4622710 },
471578 "pluralAbbreviation": {
481578 "anyOf": [
4914817 {
5014817 "type": "string"
5114817 },
529156 {
539156 "type": "null"
549156 }
551578 ],
561578 },
571678 "pluralName": {
581678 "anyOf": [
5920155 {
6020155 "type": "string"
6120155 },
6214728 {
6314728 "type": "null"
6414728 }
651678 ],
661678 },
67891 "update_at": {
68891 "anyOf": [
697515 {
70751 "format": "date-time",
717614 "type": "string"
727515 },
731476 {
741476 "type": "null"
751476 }
76891 ],
77891 },
7814910 "useAbbreviation": {
7914910 "type": "boolean"
8014910 }
8193147 },
8221328 "required": [
8321526 "id",
842374 "name"
8521328 ],
86241212 "type": "object"
8767386}
IngredientUnitAlias6 of 6 keywords
116822{
216810 "properties": {
316810 "name": {
416810 "type": "string"
516810 }
616810 },
71782 "required": [
81782 "name"
91782 ],
1018010 "type": "object"
1116822}
MultiPurposeLabelSummary4 of 11 keywords
1977{
296 "properties": {
390 "color": {
490 "type": "string"
590 },
6150 "groupId": {
7150 "format": "uuid4",
8150 "type": "string"
9150 },
1096 "id": {
1190 "format": "uuid4",
1296 "type": "string"
1396 },
14150 "name": {
15150 "type": "string"
16150 }
1796 },
18150 "required": [
19150 "name",
20150 "groupId",
21150 "id"
22150 ],
231571 "type": "object"
24977}
RecipeIngredient-Input32 of 32 keywords
1240311{
2209304 "properties": {
34345 "display": {
44345 "type": "string"
54345 },
6337116 "food": {
7337116 "anyOf": [
859394 {
1059394 },
1193360 {
1393360 },
14244209 {
15244209 "type": "null"
16244209 }
17337116 ],
18337116 },
194416 "note": {
204416 "anyOf": [
2140938 {
2240938 "type": "string"
2340938 },
2432415 {
2532415 "type": "null"
2632415 }
274416 ],
284416 },
294424 "originalText": {
304424 "anyOf": [
3137409 {
3237409 "type": "string"
3337409 },
3440541 {
3540541 "type": "null"
3640541 }
374424 ],
384424 },
3943526 "quantity": {
4043526 "anyOf": [
4138774 {
4238774 "type": "number"
4338774 },
4448413 {
4548413 "type": "null"
4648413 }
4743526 ],
4843526 },
4944315 "referenceId": {
504438 "format": "uuid",
514517 "type": "string"
5244315 },
5343013 "title": {
5443013 "anyOf": [
5533410 {
5633410 "type": "string"
5733410 },
5839746 {
5939746 "type": "null"
6039746 }
6143013 ],
6243013 },
63305148 "unit": {
64305148 "anyOf": [
6567386 {
6767386 },
6899354 {
7099354 },
71206247 {
72206247 "type": "null"
73206247 }
74305148 ],
75305148 }
76209304 },
775447 "type": "object"
78240311}
ShoppingListAddRecipeParams9 of 9 keywords
1266668{
2213294 "properties": {
346814 "recipeIncrementQuantity": {
446814 "type": "number"
546814 },
6204288 "recipeIngredients": {
7204288 "anyOf": [
8160332 {
9160281 "items": {
11160281 },
1244151 "type": "array"
13160332 },
1444448 {
1544448 "type": "null"
1644448 }
17204288 ],
18204288 }
19213294 },
20560374 "type": "object"
21266668}
Responses
codedescriptionhitsavg
200Successful Response28180ms
422Validation Error3134ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error66735ms
400Bad Request91ms
Examples
Body: application/json
1ShoppingListAddRecipeParams.recipeIncrementQuantity
""RecipeIngredient-Input.display
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""RecipeIngredient-Input.note
0RecipeIngredient-Input.quantity
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Path Parameters
item_id2 / 2
#validinvalidschema
165720{
265720 "format": "uuid4",
3677n/a "type": "string"
465720}
recipe_id2 / 2
165720{
265720 "format": "uuid4",
3677n/a "type": "string"
465720}
Headers
accept-language3 / 3
1279n/a{
2279n/a "anyOf": [
3187n/a {
4187n/a "type": "string"
5187n/a },
692187 {
792187 "type": "null"
892187 }
9279n/a ],
10279n/a}
Body
application/json6 / 6
154744{
254744 "anyOf": [
3140451 {
5140451 },
6407184 {
7407184 "type": "null"
8407184 }
954744 ],
1054744}
Referenced Components (1)4 of 4 keywords
ShoppingListRemoveRecipeParams4 of 4 keywords
1140451{
26818 "properties": {
36818 "recipeDecrementQuantity": {
46818 "type": "number"
56818 }
66818 },
7158433 "type": "object"
8140451}
Responses
codedescriptionhitsavg
200Successful Response3974ms
422Validation Error1008ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error52921ms
400Bad Request91ms
Examples
Body: application/json
1ShoppingListRemoveRecipeParams.recipeDecrementQuantity
Households: Webhooks 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1326n/a{
2326n/a "anyOf": [
3262n/a {
4262n/a "type": "string"
5262n/a },
664262 {
764262 "type": "null"
864262 }
9326n/a ],
10326n/a}
orderByNullPosition5 / 5
1104208{
2104208 "anyOf": [
397215 {
597215 },
67305 {
77305 "type": "null"
87305 }
9104208 ],
10104208}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
197215{
297215 "enum": [
353n/a "first",
444n/a "last"
597215 ],
6305n/a "type": "string"
797215}
orderDirection2 / 2
OrderDirection
123691{
223691 "enum": [
3145n/a "asc",
491n/a "desc"
523691 ],
6327n/a "type": "string"
723691}
queryFilter3 / 3
1175n/a{
2175n/a "anyOf": [
3149n/a {
4149n/a "type": "string"
5149n/a },
626149 {
726149 "type": "null"
826149 }
9175n/a ],
10175n/a}
paginationSeed3 / 3
1291n/a{
2291n/a "anyOf": [
3227n/a {
4227n/a "type": "string"
5227n/a },
664227 {
764227 "type": "null"
864227 }
9291n/a ],
10291n/a}
page1 / 1
129036{
229036 "type": "integer"
329036}
perPage1 / 1
120033{
220033 "type": "integer"
320033}
Headers
accept-language3 / 3
1567n/a{
2567n/a "anyOf": [
3353n/a {
4353n/a "type": "string"
5353n/a },
6214353 {
7214353 "type": "null"
8214353 }
9567n/a ],
10567n/a}
Responses
codedescriptionhitsavg
200Successful Response28719ms
422Validation Error27711ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5612ms
500Internal Server Error1416ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1317n/a{
2317n/a "anyOf": [
3215n/a {
4215n/a "type": "string"
5215n/a },
6102215 {
7102215 "type": "null"
8102215 }
9317n/a ],
10317n/a}
Body
application/json11 / 11
CreateWebhook
152998{
254569 "properties": {
315914 "enabled": {
415914 "type": "boolean"
515914 },
613519 "name": {
713519 "type": "string"
813519 },
957919 "scheduledTime": {
105796 "format": "time",
1158513 "type": "string"
1257919 },
1313618 "url": {
1413618 "type": "string"
1513618 },
1613323 "webhookType": {
1813323 }
1954569 },
2059824 "required": [
2159824 "scheduledTime"
2259824 ],
236225 "type": "object"
2452998}
Referenced Components (1)3 of 3 keywords
WebhookType3 of 3 keywords
113323{
213323 "enum": [
3133n/a "mealplan"
413323 ],
514610 "type": "string"
613323}
Responses
codedescriptionhitsavg
201Successful Response53535ms
422Validation Error2724ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error44ms
400Bad Request111ms
Examples
Body: application/json
trueCreateWebhook.enabled
""CreateWebhook.name
""CreateWebhook.url
"mealplan"CreateWebhook.webhookType
Headers
accept-language3 / 3
#validinvalidschema
1164n/a{
2164n/a "anyOf": [
3113n/a {
4113n/a "type": "string"
5113n/a },
651113 {
751113 "type": "null"
851113 }
9164n/a ],
10164n/a}
Responses
codedescriptionhitsavg
200Successful Response10311ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error72916ms
Path Parameters
item_id2 / 2
#validinvalidschema
1521{
2521 "format": "uuid4",
353n/a "type": "string"
4521}
Headers
accept-language3 / 3
121n/a{
221n/a "anyOf": [
313n/a {
413n/a "type": "string"
513n/a },
6813 {
7813 "type": "null"
8813 }
921n/a ],
1021n/a}
Responses
codedescriptionhitsavg
200Successful Response5044ms
422Validation Error17ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found23ms
Path Parameters
item_id2 / 2
#validinvalidschema
150226{
250226 "format": "uuid4",
3528n/a "type": "string"
450226}
Headers
accept-language3 / 3
1145n/a{
2145n/a "anyOf": [
3101n/a {
4101n/a "type": "string"
5101n/a },
644101 {
744101 "type": "null"
844101 }
9145n/a ],
10145n/a}
Responses
codedescriptionhitsavg
200Successful Response44014ms
422Validation Error2611ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6214ms
Path Parameters
item_id2 / 2
#validinvalidschema
150618{
250618 "format": "uuid4",
3524n/a "type": "string"
450618}
Headers
accept-language3 / 3
1167n/a{
2167n/a "anyOf": [
3126n/a {
4126n/a "type": "string"
5126n/a },
641126 {
741126 "type": "null"
841126 }
9167n/a ],
10167n/a}
Body
application/json11 / 11
CreateWebhook
141280{
242057 "properties": {
3879 "enabled": {
4879 "type": "boolean"
5879 },
610110 "name": {
710110 "type": "string"
810110 },
944227 "scheduledTime": {
1044219 "format": "time",
114618 "type": "string"
1244227 },
131126 "url": {
141126 "type": "string"
151126 },
168413 "webhookType": {
188413 }
1942057 },
2046917 "required": [
2146917 "scheduledTime"
2246917 ],
234866 "type": "object"
2441280}
Referenced Components (1)3 of 3 keywords
WebhookType3 of 3 keywords
18413{
28413 "enum": [
384n/a "mealplan"
48413 ],
5889 "type": "string"
68413}
Responses
codedescriptionhitsavg
200Successful Response39925ms
422Validation Error907ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error57ms
404Not Found2215ms
400Bad Request81ms
Examples
Body: application/json
trueCreateWebhook.enabled
""CreateWebhook.name
""CreateWebhook.url
"mealplan"CreateWebhook.webhookType
Path Parameters
item_id2 / 2
#validinvalidschema
149117{
249117 "format": "uuid4",
3508n/a "type": "string"
449117}
Headers
accept-language3 / 3
1129n/a{
2129n/a "anyOf": [
389n/a {
489n/a "type": "string"
589n/a },
64089 {
74089 "type": "null"
84089 }
9129n/a ],
10129n/a}
Responses
codedescriptionhitsavg
200Successful Response44013ms
422Validation Error1715ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5114ms
Organizer: Categories 7 operations 5 covered 2 partial 0 uncovered 0 not measured 96% #
Query Parameters
search3 / 3
#validinvalidschema
1165n/a{
2165n/a "anyOf": [
3143n/a {
4143n/a "type": "string"
5143n/a },
622143 {
722143 "type": "null"
822143 }
9165n/a ],
10165n/a}
orderBy3 / 3
1162n/a{
2162n/a "anyOf": [
3143n/a {
4143n/a "type": "string"
5143n/a },
619143 {
719143 "type": "null"
819143 }
9162n/a ],
10162n/a}
orderByNullPosition5 / 5
1125148{
2125148 "anyOf": [
3111162 {
5111162 },
614259 {
714259 "type": "null"
814259 }
9125148 ],
10125148}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1111162{
2111162 "enum": [
364n/a "first",
447n/a "last"
5111162 ],
6259n/a "type": "string"
7111162}
orderDirection2 / 2
OrderDirection
118435{
218435 "enum": [
3105n/a "asc",
479n/a "desc"
518435 ],
6219n/a "type": "string"
718435}
queryFilter3 / 3
1361n/a{
2361n/a "anyOf": [
3343n/a {
4343n/a "type": "string"
5343n/a },
618343 {
718343 "type": "null"
818343 }
9361n/a ],
10361n/a}
paginationSeed3 / 3
1165n/a{
2165n/a "anyOf": [
3141n/a {
4141n/a "type": "string"
5141n/a },
624141 {
724141 "type": "null"
824141 }
9165n/a ],
10165n/a}
page1 / 1
116624{
216624 "type": "integer"
316624}
perPage1 / 1
1183226{
2183226 "type": "integer"
3183226}
Headers
accept-language3 / 3
1399n/a{
2399n/a "anyOf": [
3272n/a {
4272n/a "type": "string"
5272n/a },
6127272 {
7127272 "type": "null"
8127272 }
9399n/a ],
10399n/a}
Responses
codedescriptionhitsavg
200Successful Response28614ms
422Validation Error32012ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6515ms
500Internal Server Error1214ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1309n/a{
2309n/a "anyOf": [
3191n/a {
4191n/a "type": "string"
5191n/a },
6118191 {
7118191 "type": "null"
8118191 }
9309n/a ],
10309n/a}
Body
application/json4 / 4
CategoryIn
1195112{
219564 "properties": {
319564 "name": {
419564 "type": "string"
519564 }
619564 },
725937 "required": [
825937 "name"
925937 ],
1029611 "type": "object"
11195112}
Responses
codedescriptionhitsavg
201Successful Response10575ms
422Validation Error2734ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request10511ms
500Internal Server Error330005ms
Headers
accept-language3 / 3
#validinvalidschema
1476n/a{
2476n/a "anyOf": [
3314n/a {
4314n/a "type": "string"
5314n/a },
6162314 {
7162314 "type": "null"
8162314 }
9476n/a ],
10476n/a}
Responses
codedescriptionhitsavg
200Successful Response52514ms
422Validation Error0never seen
Path Parameters
category_slug1 / 1
#validinvalidschema
1537n/a{
2537n/a "type": "string"
3537n/a}
Headers
accept-language3 / 3
1206n/a{
2206n/a "anyOf": [
3129n/a {
4129n/a "type": "string"
5129n/a },
677129 {
777129 "type": "null"
877129 }
9206n/a ],
10206n/a}
Responses
codedescriptionhitsavg
200Successful Response38415ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found15313ms
Path Parameters
item_id1 / 2
#validinvalidschema
1440{
2440 "format": "uuid4",
344n/a "type": "string"
4440}
Headers
accept-language3 / 3
138n/a{
238n/a "anyOf": [
322n/a {
422n/a "type": "string"
522n/a },
61622 {
71622 "type": "null"
81622 }
938n/a ],
1038n/a}
Responses
codedescriptionhitsavg
200Successful Response2852ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1613ms
Path Parameters
item_id2 / 2
#validinvalidschema
150633{
250633 "format": "uuid4",
3539n/a "type": "string"
450633}
Headers
accept-language3 / 3
1136n/a{
2136n/a "anyOf": [
391n/a {
491n/a "type": "string"
591n/a },
64591 {
74591 "type": "null"
84591 }
9136n/a ],
10136n/a}
Responses
codedescriptionhitsavg
200Successful Response46713ms
422Validation Error3315ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3914ms
Path Parameters
item_id1 / 2
#validinvalidschema
14750{
24750 "format": "uuid4",
3475n/a "type": "string"
44750}
Headers
accept-language3 / 3
1197n/a{
2197n/a "anyOf": [
3133n/a {
4133n/a "type": "string"
5133n/a },
664133 {
764133 "type": "null"
864133 }
9197n/a ],
10197n/a}
Body
application/json4 / 4
CategoryIn
140924{
24099 "properties": {
34099 "name": {
44099 "type": "string"
54099 }
64099 },
74188 "required": [
84188 "name"
94188 ],
104267 "type": "object"
1140924}
Responses
codedescriptionhitsavg
200Successful Response13560ms
422Validation Error575ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5013ms
400Bad Request23315ms
Organizer: Tags 7 operations 6 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
search3 / 3
#validinvalidschema
1312n/a{
2312n/a "anyOf": [
3275n/a {
4275n/a "type": "string"
5275n/a },
637275 {
737275 "type": "null"
837275 }
9312n/a ],
10312n/a}
orderBy3 / 3
1296n/a{
2296n/a "anyOf": [
3232n/a {
4232n/a "type": "string"
5232n/a },
664232 {
764232 "type": "null"
864232 }
9296n/a ],
10296n/a}
orderByNullPosition5 / 5
1111146{
2111146 "anyOf": [
394163 {
594163 },
617240 {
717240 "type": "null"
817240 }
9111146 ],
10111146}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
194163{
294163 "enum": [
362n/a "first",
432n/a "last"
594163 ],
6240n/a "type": "string"
794163}
orderDirection2 / 2
OrderDirection
126237{
226237 "enum": [
3168n/a "asc",
494n/a "desc"
526237 ],
6299n/a "type": "string"
726237}
queryFilter3 / 3
1226n/a{
2226n/a "anyOf": [
3179n/a {
4179n/a "type": "string"
5179n/a },
647179 {
747179 "type": "null"
847179 }
9226n/a ],
10226n/a}
paginationSeed3 / 3
1352n/a{
2352n/a "anyOf": [
3247n/a {
4247n/a "type": "string"
5247n/a },
6105247 {
7105247 "type": "null"
8105247 }
9352n/a ],
10352n/a}
page1 / 1
119071{
219071 "type": "integer"
319071}
perPage1 / 1
119631{
219631 "type": "integer"
319631}
Headers
accept-language3 / 3
1424n/a{
2424n/a "anyOf": [
3307n/a {
4307n/a "type": "string"
5307n/a },
6117307 {
7117307 "type": "null"
8117307 }
9424n/a ],
10424n/a}
Responses
codedescriptionhitsavg
200Successful Response35916ms
422Validation Error21412ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request7313ms
500Internal Server Error317ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1349n/a{
2349n/a "anyOf": [
3221n/a {
4221n/a "type": "string"
5221n/a },
6128221 {
7128221 "type": "null"
8128221 }
9349n/a ],
10349n/a}
Body
application/json4 / 4
TagIn
122899{
222853 "properties": {
322853 "name": {
422853 "type": "string"
522853 }
622853 },
728135 "required": [
828135 "name"
928135 ],
1031611 "type": "object"
1122899}
Responses
codedescriptionhitsavg
201Successful Response12963ms
422Validation Error2385ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error101618ms
400Bad Request111ms
Headers
accept-language3 / 3
#validinvalidschema
1439n/a{
2439n/a "anyOf": [
3283n/a {
4283n/a "type": "string"
5283n/a },
6156283 {
7156283 "type": "null"
8156283 }
9439n/a ],
10439n/a}
Responses
codedescriptionhitsavg
200Successful Response46225ms
422Validation Error0never seen
Path Parameters
tag_slug1 / 1
#validinvalidschema
1509n/a{
2509n/a "type": "string"
3509n/a}
Headers
accept-language3 / 3
1178n/a{
2178n/a "anyOf": [
3121n/a {
4121n/a "type": "string"
5121n/a },
657121 {
757121 "type": "null"
857121 }
9178n/a ],
10178n/a}
Responses
codedescriptionhitsavg
200Successful Response44414ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error6519ms
Path Parameters
item_id1 / 2
#validinvalidschema
1390{
2390 "format": "uuid4",
339n/a "type": "string"
4390}
Headers
accept-language3 / 3
130n/a{
230n/a "anyOf": [
319n/a {
419n/a "type": "string"
519n/a },
61119 {
71119 "type": "null"
81119 }
930n/a ],
1030n/a}
Responses
codedescriptionhitsavg
200Successful Response2855ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1112ms
Path Parameters
item_id2 / 2
#validinvalidschema
149726{
249726 "format": "uuid4",
3523n/a "type": "string"
449726}
Headers
accept-language3 / 3
1130n/a{
2130n/a "anyOf": [
389n/a {
489n/a "type": "string"
589n/a },
64189 {
74189 "type": "null"
84189 }
9130n/a ],
10130n/a}
Responses
codedescriptionhitsavg
200Successful Response44814ms
422Validation Error2615ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4912ms
Path Parameters
item_id2 / 2
#validinvalidschema
148112{
248112 "format": "uuid4",
3493n/a "type": "string"
448112}
Headers
accept-language3 / 3
1135n/a{
2135n/a "anyOf": [
385n/a {
485n/a "type": "string"
585n/a },
65085 {
75085 "type": "null"
85085 }
9135n/a ],
10135n/a}
Body
application/json4 / 4
TagIn
141731{
24178 "properties": {
34178 "name": {
44178 "type": "string"
54178 }
64178 },
742513 "required": [
842513 "name"
942513 ],
1043810 "type": "object"
1141731}
Responses
codedescriptionhitsavg
200Successful Response13853ms
422Validation Error786ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error26914ms
400Bad Request81ms
Organizer: Tools 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
search3 / 3
#validinvalidschema
1304n/a{
2304n/a "anyOf": [
3244n/a {
4244n/a "type": "string"
5244n/a },
660244 {
760244 "type": "null"
860244 }
9304n/a ],
10304n/a}
orderBy3 / 3
1354n/a{
2354n/a "anyOf": [
3277n/a {
4277n/a "type": "string"
5277n/a },
677277 {
777277 "type": "null"
877277 }
9354n/a ],
10354n/a}
orderByNullPosition5 / 5
1197181{
2197181 "anyOf": [
3141237 {
5141237 },
656322 {
756322 "type": "null"
856322 }
9197181 ],
10197181}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1141237{
2141237 "enum": [
393n/a "first",
448n/a "last"
5141237 ],
6322n/a "type": "string"
7141237}
orderDirection2 / 2
OrderDirection
131937{
231937 "enum": [
3179n/a "asc",
4140n/a "desc"
531937 ],
6356n/a "type": "string"
731937}
queryFilter3 / 3
1237n/a{
2237n/a "anyOf": [
3176n/a {
4176n/a "type": "string"
5176n/a },
661176 {
761176 "type": "null"
861176 }
9237n/a ],
10237n/a}
paginationSeed3 / 3
1249n/a{
2249n/a "anyOf": [
3193n/a {
4193n/a "type": "string"
5193n/a },
656193 {
756193 "type": "null"
856193 }
9249n/a ],
10249n/a}
page1 / 1
120298{
220298 "type": "integer"
320298}
perPage1 / 1
123223{
223223 "type": "integer"
323223}
Headers
accept-language3 / 3
1678n/a{
2678n/a "anyOf": [
3421n/a {
4421n/a "type": "string"
5421n/a },
6257421 {
7257421 "type": "null"
8257421 }
9678n/a ],
10678n/a}
Responses
codedescriptionhitsavg
200Successful Response29922ms
422Validation Error27011ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request10014ms
500Internal Server Error716ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1661n/a{
2661n/a "anyOf": [
3384n/a {
4384n/a "type": "string"
5384n/a },
6277384 {
7277384 "type": "null"
8277384 }
9661n/a ],
10661n/a}
Body
application/json6 / 6
RecipeToolCreate
1307244{
2336171 "properties": {
3146161 "householdsWithTool": {
414621 "items": {
5550111 "type": "string"
614621 },
7167140 "type": "array"
8146161 },
9319159 "name": {
10319159 "type": "string"
11319159 }
12336171 },
1347852 "required": [
1447852 "name"
1547852 ],
1653021 "type": "object"
17307244}
Responses
codedescriptionhitsavg
201Successful Response14539ms
422Validation Error4436ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request17913ms
Examples
Body: application/json
[]RecipeToolCreate.householdsWithTool
Path Parameters
tool_slug1 / 1
#validinvalidschema
1542n/a{
2542n/a "type": "string"
3542n/a}
Headers
accept-language3 / 3
1356n/a{
2356n/a "anyOf": [
3224n/a {
4224n/a "type": "string"
5224n/a },
6132224 {
7132224 "type": "null"
8132224 }
9356n/a ],
10356n/a}
Responses
codedescriptionhitsavg
200Successful Response42615ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error11612ms
Path Parameters
item_id2 / 2
#validinvalidschema
127485{
227485 "format": "uuid4",
3359n/a "type": "string"
427485}
Headers
accept-language3 / 3
1107n/a{
2107n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
64364 {
74364 "type": "null"
84364 }
9107n/a ],
10107n/a}
Responses
codedescriptionhitsavg
200Successful Response3740ms
422Validation Error8519ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found23716ms
Path Parameters
item_id2 / 2
#validinvalidschema
149658{
249658 "format": "uuid4",
3554n/a "type": "string"
449658}
Headers
accept-language3 / 3
1130n/a{
2130n/a "anyOf": [
384n/a {
484n/a "type": "string"
584n/a },
64684 {
74684 "type": "null"
84684 }
9130n/a ],
10130n/a}
Responses
codedescriptionhitsavg
200Successful Response23212ms
422Validation Error5814ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found26416ms
Path Parameters
item_id2 / 2
#validinvalidschema
148417{
248417 "format": "uuid4",
3501n/a "type": "string"
448417}
Headers
accept-language3 / 3
1263n/a{
2263n/a "anyOf": [
3181n/a {
4181n/a "type": "string"
5181n/a },
682181 {
782181 "type": "null"
882181 }
9263n/a ],
10263n/a}
Body
application/json6 / 6
RecipeToolCreate
140636{
241221 "properties": {
315316 "householdsWithTool": {
41535 "items": {
55045 "type": "string"
61535 },
715811 "type": "array"
815316 },
941710 "name": {
1041710 "type": "string"
1141710 }
1241221 },
1342710 "required": [
1442710 "name"
1542710 ],
164375 "type": "object"
1740636}
Responses
codedescriptionhitsavg
200Successful Response14926ms
422Validation Error995ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request22719ms
404Not Found2612ms
Examples
Body: application/json
[]RecipeToolCreate.householdsWithTool
Recipe: Bulk Actions 8 operations 7 covered 1 partial 0 uncovered 0 not measured 98% #
Headers
accept-language3 / 3
#validinvalidschema
1533n/a{
2533n/a "anyOf": [
3319n/a {
4319n/a "type": "string"
5319n/a },
6214319 {
7214319 "type": "null"
8214319 }
9533n/a ],
10533n/a}
Body
application/json18 / 18
AssignCategories
1172280{
2205235 "properties": {
3214222 "categories": {
4214127 "items": {
6214127 },
734195 "type": "array"
8214222 },
9295116 "recipes": {
1029593 "items": {
111044448 "type": "string"
1229593 },
1338823 "type": "array"
14295116 }
15205235 },
1640737 "required": [
1741133 "recipes",
184368 "categories"
1940737 ],
204448 "type": "object"
21172280}
Referenced Components (1)14 of 14 keywords
CategoryBase14 of 14 keywords
1734213{
2811119 "properties": {
346962 "groupId": {
446962 "anyOf": [
5327204 {
63275 "format": "uuid4",
7332199 "type": "string"
8327204 },
9142389 {
10142389 "type": "null"
11142389 }
1246962 ],
1346962 },
1487059 "id": {
1587036 "format": "uuid4",
1690623 "type": "string"
1787059 },
1884428 "name": {
1984428 "type": "string"
2084428 },
2189814 "slug": {
2289814 "type": "string"
2389814 }
24811119 },
2585381 "required": [
2687262 "name",
279295 "id",
2891222 "slug"
2985381 ],
3093413 "type": "object"
31734213}
Responses
codedescriptionhitsavg
200Successful Response8830ms
422Validation Error2998ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8443ms
400Bad Request81ms
Headers
accept-language3 / 3
#validinvalidschema
1434n/a{
2434n/a "anyOf": [
3247n/a {
4247n/a "type": "string"
5247n/a },
6187247 {
7187247 "type": "null"
8187247 }
9434n/a ],
10434n/a}
Body
application/json5 / 5
DeleteRecipes
1210219{
2210120 "properties": {
3210120 "recipes": {
421015 "items": {
584990 "type": "string"
621015 },
7225105 "type": "array"
8210120 }
9210120 },
1033076 "required": [
1133076 "recipes"
1233076 ],
1340623 "type": "object"
14210219}
Responses
codedescriptionhitsavg
200Successful Response21034ms
422Validation Error2639ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request251ms
Headers
accept-language3 / 3
#validinvalidschema
1384n/a{
2384n/a "anyOf": [
3248n/a {
4248n/a "type": "string"
5248n/a },
6136248 {
7136248 "type": "null"
8136248 }
9384n/a ],
10384n/a}
Responses
codedescriptionhitsavg
200Successful Response40036ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1306n/a{
2306n/a "anyOf": [
3193n/a {
4193n/a "type": "string"
5193n/a },
6113193 {
7113193 "type": "null"
8113193 }
9306n/a ],
10306n/a}
Body
application/json8 / 8
ExportRecipes
1299118{
230582 "properties": {
311925 "exportType": {
511925 },
631467 "recipes": {
731449 "items": {
8495119 "type": "string"
931449 },
1036318 "type": "array"
1131467 }
1230582 },
1338125 "required": [
1438125 "recipes"
1538125 ],
1640611 "type": "object"
17299118}
Referenced Components (1)3 of 3 keywords
ExportTypes3 of 3 keywords
111925{
211925 "enum": [
3119n/a "json"
411925 ],
512816 "type": "string"
611925}
Responses
codedescriptionhitsavg
202Successful Response21338ms
422Validation Error1588ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8631ms
400Bad Request121ms
Examples
Body: application/json
"json"ExportRecipes.exportType
Query Parameters
path1 / 2
#validinvalidschema
15060{
200 "format": "path",
3506n/a "type": "string"
45060}
Headers
accept-language3 / 3
1395n/a{
2395n/a "anyOf": [
3245n/a {
4245n/a "type": "string"
5245n/a },
6150245 {
7150245 "type": "null"
8150245 }
9395n/a ],
10395n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error13ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request50114ms
500Internal Server Error512ms
Headers
accept-language3 / 3
#validinvalidschema
1305n/a{
2305n/a "anyOf": [
3201n/a {
4201n/a "type": "string"
5201n/a },
6104201 {
7104201 "type": "null"
8104201 }
9305n/a ],
10305n/a}
Responses
codedescriptionhitsavg
200Successful Response32868ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1406n/a{
2406n/a "anyOf": [
3264n/a {
4264n/a "type": "string"
5264n/a },
6142264 {
7142264 "type": "null"
8142264 }
9406n/a ],
10406n/a}
Body
application/json14 / 14
AssignSettings
1204227{
2269150 "properties": {
327385 "recipes": {
427348 "items": {
5574164 "type": "string"
627348 },
732137 "type": "array"
827385 },
9283132 "settings": {
11283132 }
12269150 },
1335469 "required": [
1435865 "recipes",
154158 "settings"
1635469 ],
174238 "type": "object"
18204227}
Referenced Components (1)9 of 9 keywords
RecipeSettings9 of 9 keywords
1283132{
2196121 "properties": {
322054 "disableComments": {
422054 "type": "boolean"
522054 },
619334 "landscapeView": {
719334 "type": "boolean"
819334 },
919320 "locked": {
1019320 "type": "boolean"
1119320 },
1218728 "public": {
1318728 "type": "boolean"
1418728 },
1519118 "showAssets": {
1619118 "type": "boolean"
1719118 },
1818341 "showNutrition": {
1918341 "type": "boolean"
2018341 }
21196121 },
2240411 "type": "object"
23283132}
Responses
codedescriptionhitsavg
200Successful Response11722ms
422Validation Error24410ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error9344ms
400Bad Request51ms
Examples
Body: application/json
trueRecipeSettings.disableComments
falseRecipeSettings.landscapeView
falseRecipeSettings.locked
falseRecipeSettings.public
falseRecipeSettings.showAssets
falseRecipeSettings.showNutrition
Headers
accept-language3 / 3
#validinvalidschema
1460n/a{
2460n/a "anyOf": [
3289n/a {
4289n/a "type": "string"
5289n/a },
6171289 {
7171289 "type": "null"
8171289 }
9460n/a ],
10460n/a}
Body
application/json18 / 18
AssignTags
1153276{
2177236 "properties": {
3280115 "recipes": {
428070 "items": {
5848326 "type": "string"
628070 },
735045 "type": "array"
8280115 },
9224183 "tags": {
10224168 "items": {
11714580 "$ref": "#/components/schemas/TagBase"
12224168 },
1339215 "type": "array"
14224183 }
15177236 },
1638929 "required": [
1739523 "recipes",
1840711 "tags"
1938929 ],
2041811 "type": "object"
21153276}
Referenced Components (1)14 of 14 keywords
TagBase14 of 14 keywords
1714580{
2789490 "properties": {
3530258 "groupId": {
4530258 "anyOf": [
5296492 {
629651 "format": "uuid4",
7347441 "type": "string"
8296492 },
9234554 {
10234554 "type": "null"
11234554 }
12530258 ],
13530258 },
141082190 "id": {
151082142 "format": "uuid4",
16122448 "type": "string"
171082190 },
181083147 "name": {
191083147 "type": "string"
201083147 },
21120053 "slug": {
22120053 "type": "string"
23120053 }
24789490 },
25120476 "required": [
26123050 "name",
2712728 "id",
28125327 "slug"
29120476 ],
30128014 "type": "object"
31714580}
Responses
codedescriptionhitsavg
200Successful Response5834ms
422Validation Error30810ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error9530ms
400Bad Request121ms
Recipe: Comments 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1344n/a{
2344n/a "anyOf": [
3272n/a {
4272n/a "type": "string"
5272n/a },
672272 {
772272 "type": "null"
872272 }
9344n/a ],
10344n/a}
orderByNullPosition5 / 5
1117260{
2117260 "anyOf": [
3100277 {
5100277 },
617360 {
717360 "type": "null"
817360 }
9117260 ],
10117260}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1100277{
2100277 "enum": [
356n/a "first",
444n/a "last"
5100277 ],
6360n/a "type": "string"
7100277}
orderDirection2 / 2
OrderDirection
124070{
224070 "enum": [
3145n/a "asc",
495n/a "desc"
524070 ],
6310n/a "type": "string"
724070}
queryFilter3 / 3
1198n/a{
2198n/a "anyOf": [
3157n/a {
4157n/a "type": "string"
5157n/a },
641157 {
741157 "type": "null"
841157 }
9198n/a ],
10198n/a}
paginationSeed3 / 3
1270n/a{
2270n/a "anyOf": [
3206n/a {
4206n/a "type": "string"
5206n/a },
664206 {
764206 "type": "null"
864206 }
9270n/a ],
10270n/a}
page1 / 1
121883{
221883 "type": "integer"
321883}
perPage1 / 1
119445{
219445 "type": "integer"
319445}
Headers
accept-language3 / 3
1517n/a{
2517n/a "anyOf": [
3331n/a {
4331n/a "type": "string"
5331n/a },
6186331 {
7186331 "type": "null"
8186331 }
9517n/a ],
10517n/a}
Responses
codedescriptionhitsavg
200Successful Response28420ms
422Validation Error33413ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request4914ms
500Internal Server Error522ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1479n/a{
2479n/a "anyOf": [
3293n/a {
4293n/a "type": "string"
5293n/a },
6186293 {
7186293 "type": "null"
8186293 }
9479n/a ],
10479n/a}
Body
application/json6 / 6
RecipeCommentCreate
153678{
256542 "properties": {
355335 "recipeId": {
455322 "format": "uuid4",
557513 "type": "string"
655335 },
758116 "text": {
858116 "type": "string"
958116 }
1056542 },
1157831 "required": [
1258821 "recipeId",
1359712 "text"
1457831 ],
156095 "type": "object"
1653678}
Responses
codedescriptionhitsavg
201Successful Response53629ms
422Validation Error2494ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request151ms
Path Parameters
item_id2 / 2
#validinvalidschema
122624{
222624 "format": "uuid4",
3250n/a "type": "string"
422624}
Headers
accept-language3 / 3
1117n/a{
2117n/a "anyOf": [
374n/a {
474n/a "type": "string"
574n/a },
64374 {
74374 "type": "null"
84374 }
9117n/a ],
10117n/a}
Responses
codedescriptionhitsavg
200Successful Response7454ms
422Validation Error2412ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error15211ms
Path Parameters
item_id2 / 2
#validinvalidschema
150820{
250820 "format": "uuid4",
3528n/a "type": "string"
450820}
Headers
accept-language3 / 3
1114n/a{
2114n/a "anyOf": [
376n/a {
476n/a "type": "string"
576n/a },
63876 {
73876 "type": "null"
83876 }
9114n/a ],
10114n/a}
Responses
codedescriptionhitsavg
200Successful Response28116ms
422Validation Error2032ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found22711ms
Path Parameters
item_id2 / 2
#validinvalidschema
142817{
242817 "format": "uuid4",
3445n/a "type": "string"
442817}
Headers
accept-language3 / 3
1203n/a{
2203n/a "anyOf": [
3155n/a {
4155n/a "type": "string"
5155n/a },
648155 {
748155 "type": "null"
848155 }
9203n/a ],
10203n/a}
Body
application/json6 / 6
RecipeCommentUpdate
132532{
233812 "properties": {
33317 "id": {
43312 "format": "uuid4",
53335 "type": "string"
63317 },
73427 "text": {
83427 "type": "string"
93427 }
1033812 },
1133714 "required": [
1233813 "id",
133492 "text"
1433714 ],
153516 "type": "object"
1632532}
Responses
codedescriptionhitsavg
200Successful Response15839ms
422Validation Error1025ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error15416ms
400Bad Request311ms
Path Parameters
slug1 / 1
#validinvalidschema
1504n/a{
2504n/a "type": "string"
3504n/a}
Headers
accept-language3 / 3
1305n/a{
2305n/a "anyOf": [
3189n/a {
4189n/a "type": "string"
5189n/a },
6116189 {
7116189 "type": "null"
8116189 }
9305n/a ],
10305n/a}
Responses
codedescriptionhitsavg
200Successful Response43821ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error6613ms
Recipe: CRUD 20 operations 12 covered 8 partial 0 uncovered 0 not measured 91% #
Query Parameters
categories5 / 7
#validinvalidschema
117796{
217796 "anyOf": [
317796 {
4177n/a "items": {
5550n/a "anyOf": [
696550 {
796454 "format": "uuid4",
8550n/a "type": "string"
996550 },
10550n/a {
11550n/a "type": "string"
12550n/a }
13550n/a ]
14177n/a },
152730 "type": "array"
1617796 },
170273 {
180273 "type": "null"
190273 }
2017796 ],
2117796}
tags5 / 7
114572{
214572 "anyOf": [
314572 {
4145n/a "items": {
5287n/a "anyOf": [
681282 {
781206 "format": "uuid4",
8287n/a "type": "string"
981282 },
10287n/a {
11287n/a "type": "string"
12287n/a }
13287n/a ]
14145n/a },
152170 "type": "array"
1614572 },
170217 {
180217 "type": "null"
190217 }
2014572 ],
2114572}
tools5 / 7
113393{
213393 "anyOf": [
313393 {
4133n/a "items": {
5335n/a "anyOf": [
681347 {
781254 "format": "uuid4",
8335n/a "type": "string"
981347 },
10335n/a {
11335n/a "type": "string"
12335n/a }
13335n/a ]
14133n/a },
152260 "type": "array"
1613393 },
170226 {
180226 "type": "null"
190226 }
2013393 ],
2113393}
foods5 / 7
1187147{
2187147 "anyOf": [
3187147 {
4187n/a "items": {
51035n/a "anyOf": [
6951225 {
795940 "format": "uuid4",
81035n/a "type": "string"
9951225 },
101035n/a {
111035n/a "type": "string"
121035n/a }
131035n/a ]
14187n/a },
153340 "type": "array"
16187147 },
170334 {
180334 "type": "null"
190334 }
20187147 ],
21187147}
households5 / 7
123874{
223874 "anyOf": [
323874 {
4238n/a "items": {
5707n/a "anyOf": [
694689 {
794613 "format": "uuid4",
8707n/a "type": "string"
994689 },
10707n/a {
11707n/a "type": "string"
12707n/a }
13707n/a ]
14238n/a },
153120 "type": "array"
1623874 },
170312 {
180312 "type": "null"
190312 }
2023874 ],
2123874}
orderBy3 / 3
1314n/a{
2314n/a "anyOf": [
3248n/a {
4248n/a "type": "string"
5248n/a },
666248 {
766248 "type": "null"
866248 }
9314n/a ],
10314n/a}
orderByNullPosition5 / 5
123982{
223982 "anyOf": [
3172149 {
5172149 },
667254 {
767254 "type": "null"
867254 }
923982 ],
1023982}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1172149{
2172149 "enum": [
3123n/a "first",
449n/a "last"
5172149 ],
6254n/a "type": "string"
7172149}
orderDirection2 / 2
OrderDirection
128321{
228321 "enum": [
3190n/a "asc",
493n/a "desc"
528321 ],
6304n/a "type": "string"
728321}
queryFilter3 / 3
1286n/a{
2286n/a "anyOf": [
3226n/a {
4226n/a "type": "string"
5226n/a },
660226 {
760226 "type": "null"
860226 }
9286n/a ],
10286n/a}
paginationSeed3 / 3
1299n/a{
2299n/a "anyOf": [
3238n/a {
4238n/a "type": "string"
5238n/a },
661238 {
761238 "type": "null"
861238 }
9299n/a ],
10299n/a}
page1 / 1
123768{
223768 "type": "integer"
323768}
perPage1 / 1
126521{
226521 "type": "integer"
326521}
cookbook5 / 5
1343n/a{
2343n/a "anyOf": [
3100243 {
4100156 "format": "uuid4",
5256n/a "type": "string"
6100243 },
7256n/a {
8256n/a "type": "string"
9256n/a },
1087256 {
1187256 "type": "null"
1287256 }
13343n/a ],
14343n/a}
requireAllCategories1 / 1
126318{
226318 "type": "boolean"
326318}
requireAllTags1 / 1
125819{
225819 "type": "boolean"
325819}
requireAllTools1 / 1
121112{
221112 "type": "boolean"
321112}
requireAllFoods1 / 1
122711{
222711 "type": "boolean"
322711}
search3 / 3
1302n/a{
2302n/a "anyOf": [
3236n/a {
4236n/a "type": "string"
5236n/a },
666236 {
766236 "type": "null"
866236 }
9302n/a ],
10302n/a}
Headers
accept-language3 / 3
1885n/a{
2885n/a "anyOf": [
3574n/a {
4574n/a "type": "string"
5574n/a },
6311574 {
7311574 "type": "null"
8311574 }
9885n/a ],
10885n/a}
Responses
codedescriptionhitsavg
200Successful Response27324ms
422Validation Error22710ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found13610ms
500Internal Server Error11721ms
400Bad Request2332ms
Examples
Query
"desc"orderDirection
1page
50perPage
falserequireAllCategories
falserequireAllTags
falserequireAllTools
falserequireAllFoods
Headers
accept-language3 / 3
#validinvalidschema
11445n/a{
21445n/a "anyOf": [
31263n/a {
41263n/a "type": "string"
51263n/a },
61821263 {
71821263 "type": "null"
81821263 }
91445n/a ],
101445n/a}
Body
application/json371 / 409
1666746{
2666740 "items": {
4666740 },
514066 "type": "array"
6666746}
Referenced Components (22)474 of 519 keywords
CreateIngredientFood28 of 30 keywords
1206425{
2208104 "properties": {
318432 "aliases": {
418422 "items": {
618422 },
720610 "type": "array"
818432 },
920110 "description": {
1020110 "type": "string"
1120110 },
122008 "extras": {
132008 "anyOf": [
1413276 {
151n/a "additionalProperties": true,
1613276 "type": "object"
1713276 },
1868140 {
1968140 "type": "null"
2068140 }
212008 ],
222008 },
2317120 "householdsWithIngredientFood": {
2417110 "items": {
2517510 "type": "string"
2617110 },
2718110 "type": "array"
2817120 },
292668 "id": {
302668 "anyOf": [
3125618 {
322560 "format": "uuid4",
3325618 "type": "string"
3425618 },
3510264 {
3610264 "type": "null"
3710264 }
382668 ],
392668 },
401938 "labelId": {
411938 "anyOf": [
4218615 {
431860 "format": "uuid4",
4418615 "type": "string"
4518615 },
467194 {
477194 "type": "null"
487194 }
491938 ],
501938 },
5130010 "name": {
5230010 "type": "string"
5330010 },
542098 "pluralName": {
552098 "anyOf": [
5648169 {
5748169 "type": "string"
5848169 },
5916156 {
6016156 "type": "null"
6116156 }
622098 ],
632098 }
64208104 },
653103 "required": [
663103 "name"
673103 ],
68313318 "type": "object"
69206425}
CreateIngredientFoodAlias6 of 6 keywords
135322{
235310 "properties": {
335310 "name": {
435310 "type": "string"
535310 }
635310 },
73632 "required": [
83632 "name"
93632 ],
1036510 "type": "object"
1135322}
CreateIngredientUnit29 of 30 keywords
1192424{
2194114 "properties": {
323210 "abbreviation": {
423210 "type": "string"
523210 },
619132 "aliases": {
719122 "items": {
919122 },
1021310 "type": "array"
1119132 },
1219210 "description": {
1319210 "type": "string"
1419210 },
152068 "extras": {
162068 "anyOf": [
1714470 {
181n/a "additionalProperties": true,
1914470 "type": "object"
2014470 },
2162152 {
2262152 "type": "null"
2362152 }
242068 ],
252068 },
2619010 "fraction": {
2719010 "type": "boolean"
2819010 },
292608 "id": {
302608 "anyOf": [
3121454 {
322140 "format": "uuid4",
3321454 "type": "string"
3421454 },
3546222 {
3646222 "type": "null"
3746222 }
382608 ],
392608 },
4029610 "name": {
4129610 "type": "string"
4229610 },
432218 "pluralAbbreviation": {
442218 "anyOf": [
4515673 {
4615673 "type": "string"
4715673 },
4865164 {
4965164 "type": "null"
5065164 }
512218 ],
522218 },
531658 "pluralName": {
541658 "anyOf": [
558165 {
568165 "type": "string"
578165 },
5815716 {
5915716 "type": "null"
6015716 }
611658 ],
621658 },
6315910 "useAbbreviation": {
6415910 "type": "boolean"
6515910 }
66194114 },
673063 "required": [
683063 "name"
693063 ],
70309307 "type": "object"
71192424}
CreateIngredientUnitAlias6 of 6 keywords
127022{
227010 "properties": {
327010 "name": {
427010 "type": "string"
527010 }
627010 },
72802 "required": [
82802 "name"
92802 ],
1028210 "type": "object"
1127022}
IngredientFood-Input31 of 41 keywords
1158473{
2198114 "properties": {
318432 "aliases": {
418422 "items": {
618422 },
720610 "type": "array"
818432 },
91480 "createdAt": {
101480 "anyOf": [
111435 {
121430 "format": "date-time",
131435 "type": "string"
141435 },
155143 {
165143 "type": "null"
175143 }
181480 ],
191480 },
2020110 "description": {
2120110 "type": "string"
2220110 },
232008 "extras": {
242008 "anyOf": [
2513276 {
261n/a "additionalProperties": true,
2713276 "type": "object"
2813276 },
2968140 {
3068140 "type": "null"
3168140 }
322008 ],
332008 },
3417120 "householdsWithIngredientFood": {
3517110 "items": {
3617510 "type": "string"
3717110 },
3818110 "type": "array"
3917120 },
4025618 "id": {
412560 "format": "uuid4",
4225618 "type": "string"
4325618 },
441140 "label": {
451140 "anyOf": [
462490 {
482490 },
499024 {
509024 "type": "null"
519024 }
521140 ]
531140 },
541938 "labelId": {
551938 "anyOf": [
5618615 {
571860 "format": "uuid4",
5818615 "type": "string"
5918615 },
607194 {
617194 "type": "null"
627194 }
631938 ],
641938 },
6530010 "name": {
6630010 "type": "string"
6730010 },
682098 "pluralName": {
692098 "anyOf": [
7048169 {
7148169 "type": "string"
7248169 },
7316156 {
7416156 "type": "null"
7516156 }
762098 ],
772098 },
781660 "update_at": {
791660 "anyOf": [
8012343 {
811230 "format": "date-time",
8212343 "type": "string"
8312343 },
8443123 {
8543123 "type": "null"
8643123 }
871660 ],
881660 }
89198114 },
9027241 "required": [
9127439 "id",
923103 "name"
9327241 ],
94313318 "type": "object"
95158473}
IngredientFoodAlias6 of 6 keywords
135322{
235310 "properties": {
335310 "name": {
435310 "type": "string"
535310 }
635310 },
73632 "required": [
83632 "name"
93632 ],
1036510 "type": "object"
1135322}
IngredientReferences7 of 8 keywords
16629{
24134 "properties": {
34134 "referenceId": {
44134 "anyOf": [
5114303 {
61140 "format": "uuid4",
7114303 "type": "string"
8114303 },
9299118 {
10299118 "type": "null"
11299118 }
124134 ],
134134 }
144134 },
156665 "type": "object"
166629}
IngredientUnit-Input30 of 37 keywords
1106510{
2148160 "properties": {
323210 "abbreviation": {
423210 "type": "string"
523210 },
619132 "aliases": {
719122 "items": {
919122 },
1021310 "type": "array"
1119132 },
121150 "createdAt": {
131150 "anyOf": [
141123 {
151120 "format": "date-time",
161123 "type": "string"
171123 },
183112 {
193112 "type": "null"
203112 }
211150 ],
221150 },
2319210 "description": {
2419210 "type": "string"
2519210 },
262068 "extras": {
272068 "anyOf": [
2814470 {
291n/a "additionalProperties": true,
3014470 "type": "object"
3114470 },
3262152 {
3362152 "type": "null"
3462152 }
352068 ],
362068 },
3719010 "fraction": {
3819010 "type": "boolean"
3919010 },
4021454 "id": {
412140 "format": "uuid4",
4221454 "type": "string"
4321454 },
4429610 "name": {
4529610 "type": "string"
4629610 },
472218 "pluralAbbreviation": {
482218 "anyOf": [
4915673 {
5015673 "type": "string"
5115673 },
5265164 {
5365164 "type": "null"
5465164 }
552218 ],
562218 },
571658 "pluralName": {
581658 "anyOf": [
598165 {
608165 "type": "string"
618165 },
6215716 {
6315716 "type": "null"
6415716 }
651658 ],
661658 },
67920 "update_at": {
68920 "anyOf": [
697121 {
70710 "format": "date-time",
717121 "type": "string"
727121 },
732171 {
742171 "type": "null"
752171 }
76920 ],
77920 },
7815910 "useAbbreviation": {
7915910 "type": "boolean"
8015910 }
81148160 },
8226643 "required": [
8326841 "id",
843063 "name"
8526643 ],
86309307 "type": "object"
87106510}
IngredientUnitAlias6 of 6 keywords
127022{
227010 "properties": {
327010 "name": {
427010 "type": "string"
527010 }
627010 },
72802 "required": [
82802 "name"
92802 ],
1028210 "type": "object"
1127022}
MultiPurposeLabelSummary1 of 11 keywords
12490{
2240 "properties": {
330 "color": {
430 "type": "string"
530 },
6240 "groupId": {
7240 "format": "uuid4",
8240 "type": "string"
9240 },
10240 "id": {
11240 "format": "uuid4",
12240 "type": "string"
13240 },
14240 "name": {
15240 "type": "string"
16240 }
17240 },
18240 "required": [
19240 "name",
20240 "groupId",
21240 "id"
22240 ],
232490 "type": "object"
242490}
Nutrition47 of 47 keywords
1661071{
26153 "properties": {
3734 "calories": {
4734 "anyOf": [
5869 {
6869 "type": "string"
7869 },
86512 {
96512 "type": "null"
106512 }
11734 ],
12734 },
13784 "carbohydrateContent": {
14784 "anyOf": [
15874 {
16874 "type": "string"
17874 },
187012 {
197012 "type": "null"
207012 }
21784 ],
22784 },
23834 "cholesterolContent": {
24834 "anyOf": [
25879 {
26879 "type": "string"
27879 },
287512 {
297512 "type": "null"
307512 }
31834 ],
32834 },
33724 "fatContent": {
34724 "anyOf": [
35571 {
36571 "type": "string"
37571 },
38679 {
39679 "type": "null"
40679 }
41724 ],
42724 },
43734 "fiberContent": {
44734 "anyOf": [
45968 {
46968 "type": "string"
47968 },
486413 {
496413 "type": "null"
506413 }
51734 ],
52734 },
53804 "proteinContent": {
54804 "anyOf": [
551371 {
561371 "type": "string"
571371 },
586717 {
596717 "type": "null"
606717 }
61804 ],
62804 },
63734 "saturatedFatContent": {
64734 "anyOf": [
651265 {
661265 "type": "string"
671265 },
686116 {
696116 "type": "null"
706116 }
71734 ],
72734 },
73704 "sodiumContent": {
74704 "anyOf": [
75668 {
76668 "type": "string"
77668 },
786410 {
796410 "type": "null"
806410 }
81704 ],
82704 },
836313 "sugarContent": {
846313 "anyOf": [
85670 {
86670 "type": "string"
87670 },
885719 {
895719 "type": "null"
905719 }
916313 ],
926313 },
93674 "transFatContent": {
94674 "anyOf": [
95764 {
96764 "type": "string"
97764 },
986011 {
996011 "type": "null"
1006011 }
101674 ],
102674 },
103774 "unsaturatedFatContent": {
104774 "anyOf": [
1051269 {
1061269 "type": "string"
1071269 },
1086516 {
1096516 "type": "null"
1106516 }
111774 ],
112774 }
1136153 },
1141191018 "type": "object"
115661071}
Recipe-Input124 of 128 keywords
11500752{
21295747 "properties": {
3121830 "assets": {
4121830 "anyOf": [
51116132 {
6111626 "items": {
8111626 },
91142106 "type": "array"
101116132 },
111021146 {
121021146 "type": "null"
131021146 }
14121830 ],
15121830 },
16112674 "comments": {
17112674 "anyOf": [
181069131 {
19106970 "items": {
21106970 },
22113961 "type": "array"
231069131 },
24571143 {
25571143 "type": "null"
26571143 }
27112674 ],
28112674 },
2911744 "cookTime": {
3011744 "anyOf": [
311111067 {
321111067 "type": "string"
331111067 },
341063115 {
351063115 "type": "null"
361063115 }
3711744 ],
3811744 },
3910806 "createdAt": {
4010806 "anyOf": [
41104145 {
4210412 "format": "date-time",
43104343 "type": "string"
44104145 },
45391047 {
46391047 "type": "null"
47391047 }
4810806 ],
4910806 },
5011466 "dateAdded": {
5111466 "anyOf": [
52108072 {
5310802 "format": "date",
54108270 "type": "string"
55108072 },
56661086 {
57661086 "type": "null"
58661086 }
5911466 ],
6011466 },
6111496 "dateUpdated": {
6211496 "anyOf": [
63108768 {
6410872 "format": "date-time",
65108966 "type": "string"
66108768 },
67621093 {
68621093 "type": "null"
69621093 }
7011496 ],
7111496 },
7211514 "description": {
7311514 "anyOf": [
741033122 {
751033122 "type": "string"
761033122 },
771181037 {
781181037 "type": "null"
791181037 }
8011514 ],
8111514 },
8211514 "extras": {
8311514 "anyOf": [
84107778 {
851n/a "additionalProperties": true,
86107778 "type": "object"
87107778 },
88741081 {
89741081 "type": "null"
90741081 }
9111514 ],
9211514 },
9311305 "groupId": {
9411300 "format": "uuid4",
9511305 "type": "string"
9611305 },
9711235 "householdId": {
9811230 "format": "uuid4",
9911235 "type": "string"
10011235 },
10111744 "id": {
10211744 "anyOf": [
103112256 {
10411220 "format": "uuid4",
105112256 "type": "string"
106112256 },
107521126 {
108521126 "type": "null"
109521126 }
11011744 ],
11111744 },
112987n/a "image": {
113987n/a "anyOf": [
114987n/a {},
1159816 {
1169816 "type": "null"
1179816 }
118987n/a ],
119987n/a },
12011176 "lastMade": {
12111176 "anyOf": [
122105568 {
12310552 "format": "date-time",
124105766 "type": "string"
125105568 },
126621061 {
127621061 "type": "null"
128621061 }
12911176 ],
13011176 },
131111115 "name": {
132111115 "anyOf": [
133551071 {
134551071 "type": "string"
135551071 },
136105670 {
137105670 "type": "null"
138105670 }
139111115 ],
140111115 },
141110826 "notes": {
142110826 "anyOf": [
1431018116 {
144101822 "items": {
146101822 },
147104094 "type": "array"
1481018116 },
149901044 {
150901044 "type": "null"
151901044 }
152110826 ],
153110826 },
154108057 "nutrition": {
155108057 "anyOf": [
156661071 {
157661071 "$ref": "#/components/schemas/Nutrition"
158661071 },
1591014123 {
1601014123 "type": "null"
1611014123 }
162108057 ]
163108057 },
16411734 "orgURL": {
16511734 "anyOf": [
166961081 {
167961081 "type": "string"
168961081 },
1691077100 {
1701077100 "type": "null"
1711077100 }
17211734 ],
17311734 },
17411774 "performTime": {
17511774 "anyOf": [
176961085 {
177961085 "type": "string"
178961085 },
1791081100 {
1801081100 "type": "null"
1811081100 }
18211774 ],
18311774 },
18411584 "prepTime": {
18511584 "anyOf": [
186681094 {
187681094 "type": "string"
188681094 },
189109072 {
190109072 "type": "null"
191109072 }
19211584 ],
19311584 },
19411184 "rating": {
19511184 "anyOf": [
196811041 {
197811041 "type": "number"
198811041 },
199103785 {
200103785 "type": "null"
201103785 }
20211184 ],
20311184 },
204109530 "recipeCategory": {
205109530 "anyOf": [
206990135 {
20799026 "items": {
20999026 },
2101016109 "type": "array"
211990135 },
2121051020 {
2131051020 "type": "null"
2141051020 }
215109530 ],
216109530 },
217886274 "recipeIngredient": {
218886269 "items": {
220886269 },
22111555 "type": "array"
222886274 },
223109444 "recipeInstructions": {
224109444 "anyOf": [
2251025113 {
226102540 "items": {
228102540 },
229106573 "type": "array"
2301025113 },
231691069 {
232691069 "type": "null"
233691069 }
234109444 ],
235109444 },
23611275 "recipeServings": {
23711275 "type": "number"
23811275 },
23911784 "recipeYield": {
24011784 "anyOf": [
241501132 {
242501132 "type": "string"
243501132 },
244112854 {
245112854 "type": "null"
246112854 }
24711784 ],
24811784 },
24911235 "recipeYieldQuantity": {
25011235 "type": "number"
25111235 },
252105534 "settings": {
253105534 "anyOf": [
254591030 {
256591030 },
25799693 {
25899693 "type": "null"
25999693 }
260105534 ]
261105534 },
26211025 "slug": {
26311025 "type": "string"
26411025 },
265112830 "tags": {
266112830 "anyOf": [
2671051107 {
268105126 "items": {
270105126 },
271107781 "type": "array"
2721051107 },
273771081 {
274771081 "type": "null"
275771081 }
276112830 ],
277112830 },
278116942 "tools": {
279116937 "items": {
281116937 },
28212065 "type": "array"
283116942 },
28411634 "totalTime": {
28511634 "anyOf": [
286821085 {
287821085 "type": "string"
288821085 },
289108186 {
290108186 "type": "null"
291108186 }
29211634 ],
29311634 },
29411476 "update_at": {
29511476 "anyOf": [
296107281 {
29710722 "format": "date-time",
298107479 "type": "string"
299107281 },
300751078 {
301751078 "type": "null"
302751078 }
30311476 ],
30411476 },
30517255 "userId": {
30617250 "format": "uuid4",
30717255 "type": "string"
30817255 }
3091295747 },
31022475 "type": "object"
3111500752}
RecipeAsset11 of 11 keywords
124627{
224814 "properties": {
31294 "fileName": {
41294 "anyOf": [
55083 {
65083 "type": "string"
75083 },
87954 {
97954 "type": "null"
107954 }
111294 ],
121294 },
132565 "icon": {
142565 "type": "string"
152565 },
162565 "name": {
172565 "type": "string"
182565 }
1924814 },
202602 "required": [
212611 "name",
222611 "icon"
232602 ],
2426211 "type": "object"
2524627}
RecipeCategory15 of 17 keywords
19327{
29518 "properties": {
3694 "groupId": {
4694 "anyOf": [
53439 {
6340 "format": "uuid4",
73439 "type": "string"
83439 },
93538 {
103538 "type": "null"
113538 }
12694 ],
13694 },
14554 "id": {
15554 "anyOf": [
163920 {
17390 "format": "uuid4",
183920 "type": "string"
193920 },
201643 {
211643 "type": "null"
221643 }
23554 ],
24554 },
251075 "name": {
261075 "type": "string"
271075 },
281075 "slug": {
291075 "type": "string"
301075 }
319518 },
321112 "required": [
331121 "name",
341121 "slug"
351112 ],
361137 "type": "object"
379327}
RecipeCommentOut-Input14 of 17 keywords
164071{
264757 "properties": {
36976 "createdAt": {
46971 "format": "date-time",
56985 "type": "string"
66976 },
76985 "id": {
86980 "format": "uuid4",
96985 "type": "string"
106985 },
116985 "recipeId": {
126980 "format": "uuid4",
136985 "type": "string"
146985 },
156985 "text": {
166985 "type": "string"
176985 },
186976 "update_at": {
196971 "format": "date-time",
206985 "type": "string"
216976 },
2267825 "user": {
2467825 },
256985 "userId": {
266980 "format": "uuid4",
276985 "type": "string"
286985 }
2964757 },
306977 "required": [
317031 "recipeId",
327031 "text",
337031 "id",
347031 "createdAt",
357031 "update_at",
367031 "userId",
377031 "user"
386977 ],
397047 "type": "object"
4064071}
RecipeIngredient-Input32 of 32 keywords
1687291{
2555259 "properties": {
36455 "display": {
46455 "type": "string"
56455 },
6520111 "food": {
7520111 "anyOf": [
8158473 {
10158473 },
11206425 {
13206425 },
14314317 {
15314317 "type": "null"
16314317 }
17520111 ],
18520111 },
196084 "note": {
206084 "anyOf": [
21484128 {
22484128 "type": "string"
23484128 },
24124488 {
25124488 "type": "null"
26124488 }
276084 ],
286084 },
296234 "originalText": {
306234 "anyOf": [
31118509 {
32118509 "type": "string"
33118509 },
34505122 {
35505122 "type": "null"
36505122 }
376234 ],
386234 },
396364 "quantity": {
406364 "anyOf": [
41477163 {
42477163 "type": "number"
43477163 },
44159481 {
45159481 "type": "null"
46159481 }
476364 ],
486364 },
496086 "referenceId": {
506081 "format": "uuid",
516095 "type": "string"
526086 },
536274 "title": {
546274 "anyOf": [
55119512 {
56119512 "type": "string"
57119512 },
58508123 {
59508123 "type": "null"
60508123 }
616274 ],
626274 },
63495121 "unit": {
64495121 "anyOf": [
65106510 {
67106510 },
68192424 {
70192424 },
71303313 {
72303313 "type": "null"
73303313 }
74495121 ],
75495121 }
76555259 },
7794632 "type": "object"
78687291}
RecipeNote7 of 7 keywords
118439{
218630 "properties": {
319025 "text": {
419025 "type": "string"
519025 },
62105 "title": {
72105 "type": "string"
82105 }
918630 },
102142 "required": [
112151 "title",
122151 "text"
132142 ],
142167 "type": "object"
1518439}
RecipeSettings9 of 9 keywords
1591030{
24730 "properties": {
3605 "disableComments": {
4605 "type": "boolean"
5605 },
6605 "landscapeView": {
7605 "type": "boolean"
8605 },
9605 "locked": {
10605 "type": "boolean"
11605 },
12595 "public": {
13595 "type": "boolean"
14595 },
15605 "showAssets": {
16605 "type": "boolean"
17605 },
18545 "showNutrition": {
19545 "type": "boolean"
20545 }
214730 },
22891000 "type": "object"
23591030}
RecipeStep21 of 21 keywords
122341{
222433 "properties": {
31246 "id": {
41246 "anyOf": [
55278 {
6522 "format": "uuid",
75476 "type": "string"
85278 },
97258 {
107258 "type": "null"
117258 }
121246 ],
131246 },
1411414 "ingredientReferences": {
151149 "items": {
171149 },
181235 "type": "array"
1911414 },
201384 "summary": {
211384 "anyOf": [
229250 {
239250 "type": "string"
249250 },
254696 {
264696 "type": "null"
274696 }
281384 ],
291384 },
302515 "text": {
312515 "type": "string"
322515 },
331374 "title": {
341374 "anyOf": [
358259 {
368259 "type": "string"
378259 },
385586 {
395586 "type": "null"
405586 }
411374 ],
421374 }
4322433 },
442561 "required": [
452561 "text"
462561 ],
472577 "type": "object"
4822341}
RecipeTag15 of 17 keywords
117127{
217318 "properties": {
3754 "groupId": {
4754 "anyOf": [
54831 {
6480 "format": "uuid4",
74831 "type": "string"
84831 },
92752 {
102752 "type": "null"
112752 }
12754 ],
13754 },
141014 "id": {
151014 "anyOf": [
167035 {
17700 "format": "uuid4",
187035 "type": "string"
197035 },
203174 {
213174 "type": "null"
223174 }
231014 ],
241014 },
251855 "name": {
261855 "type": "string"
271855 },
281855 "slug": {
291855 "type": "string"
301855 }
3117318 },
321892 "required": [
331901 "name",
341901 "slug"
351892 ],
361917 "type": "object"
3717127}
RecipeTool14 of 16 keywords
175937{
276229 "properties": {
34494 "groupId": {
44494 "anyOf": [
5241212 {
62410 "format": "uuid4",
7241212 "type": "string"
8241212 },
9208245 {
10208245 "type": "null"
11208245 }
124494 ],
134494 },
1439310 "householdsWithTool": {
153935 "items": {
1618265 "type": "string"
173935 },
183985 "type": "array"
1939310 },
207855 "id": {
217850 "format": "uuid4",
227855 "type": "string"
237855 },
247855 "name": {
257855 "type": "string"
267855 },
277855 "slug": {
287855 "type": "string"
297855 }
3076229 },
317883 "required": [
327901 "id",
337901 "name",
347901 "slug"
357883 ],
367915 "type": "object"
3775937}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
167825{
268018 "properties": {
36925 "admin": {
46925 "type": "boolean"
56925 },
63324 "fullName": {
73324 "anyOf": [
8124212 {
9124212 "type": "string"
10124212 },
11208128 {
12208128 "type": "null"
13208128 }
143324 ],
153324 },
166925 "id": {
176920 "format": "uuid4",
186925 "type": "string"
196925 },
203434 "username": {
213434 "anyOf": [
22112235 {
23112235 "type": "string"
24112235 },
25231116 {
26231116 "type": "null"
27231116 }
283434 ],
293434 }
3068018 },
316962 "required": [
326971 "id",
336971 "admin"
346962 ],
356985 "type": "object"
3667825}
Responses
codedescriptionhitsavg
200Successful Response4911ms
422Validation Error6823ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error71723ms
400Bad Request71ms
Examples
Body: application/json
[]Recipe-Input.assets
[]Recipe-Input.comments
""Recipe-Input.description
{}Recipe-Input.extras
[]Recipe-Input.notes
[]Recipe-Input.recipeCategory
[]Recipe-Input.recipeIngredient
""RecipeIngredient-Input.display
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""RecipeIngredient-Input.note
0RecipeIngredient-Input.quantity
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
[]RecipeStep.ingredientReferences
""RecipeStep.summary
""RecipeStep.title
[]Recipe-Input.recipeInstructions
0Recipe-Input.recipeServings
0Recipe-Input.recipeYieldQuantity
trueRecipeSettings.disableComments
falseRecipeSettings.landscapeView
falseRecipeSettings.locked
falseRecipeSettings.public
falseRecipeSettings.showAssets
falseRecipeSettings.showNutrition
""Recipe-Input.slug
[]Recipe-Input.tags
[]Recipe-Input.tools
[]RecipeTool.householdsWithTool
Headers
accept-language3 / 3
#validinvalidschema
1415n/a{
2415n/a "anyOf": [
3243n/a {
4243n/a "type": "string"
5243n/a },
6172243 {
7172243 "type": "null"
8172243 }
9415n/a ],
10415n/a}
Body
application/json4 / 4
CreateRecipe
1239104{
223913 "properties": {
323913 "name": {
423913 "type": "string"
523913 }
623913 },
725266 "required": [
825266 "name"
925266 ],
1031825 "type": "object"
11239104}
Responses
codedescriptionhitsavg
201Successful Response173112ms
422Validation Error2418ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error35886ms
400Bad Request3831ms
Headers
accept-language3 / 3
#validinvalidschema
11272n/a{
21272n/a "anyOf": [
31178n/a {
41178n/a "type": "string"
51178n/a },
6941178 {
7941178 "type": "null"
8941178 }
91272n/a ],
101272n/a}
Body
application/json378 / 409
1535844{
2535796 "items": {
4535796 },
5133148 "type": "array"
6535844}
Referenced Components (22)481 of 519 keywords
CreateIngredientFood29 of 30 keywords
1131360{
2133111 "properties": {
316732 "aliases": {
416722 "items": {
616722 },
718910 "type": "array"
816732 },
917410 "description": {
1017410 "type": "string"
1117410 },
1218112 "extras": {
1318112 "anyOf": [
1415142 {
151n/a "additionalProperties": true,
1615142 "type": "object"
1715142 },
1830163 {
1930163 "type": "null"
2030163 }
2118112 ],
2218112 },
2316422 "householdsWithIngredientFood": {
2416410 "items": {
2540910 "type": "string"
2616410 },
2717412 "type": "array"
2816422 },
292068 "id": {
302068 "anyOf": [
3119519 {
321950 "format": "uuid4",
3319519 "type": "string"
3419519 },
3511203 {
3611203 "type": "null"
3711203 }
382068 ],
392068 },
401649 "labelId": {
411649 "anyOf": [
4214231 {
431421 "format": "uuid4",
4414330 "type": "string"
4514231 },
4622151 {
4722151 "type": "null"
4822151 }
491649 ],
501649 },
5123210 "name": {
5223210 "type": "string"
5323210 },
541818 "pluralName": {
551818 "anyOf": [
5626163 {
5726163 "type": "string"
5826163 },
5915534 {
6015534 "type": "null"
6115534 }
621818 ],
631818 }
64133111 },
652423 "required": [
662423 "name"
672423 ],
68245246 "type": "object"
69131360}
CreateIngredientFoodAlias6 of 6 keywords
140722{
240710 "properties": {
340710 "name": {
440710 "type": "string"
540710 }
640710 },
74172 "required": [
84172 "name"
94172 ],
1041910 "type": "object"
1140722}
CreateIngredientUnit29 of 30 keywords
1129402{
2132151 "properties": {
317310 "abbreviation": {
417310 "type": "string"
517310 },
616332 "aliases": {
716322 "items": {
916322 },
1018510 "type": "array"
1116332 },
1216710 "description": {
1316710 "type": "string"
1416710 },
1517644 "extras": {
1617644 "anyOf": [
1715466 {
181n/a "additionalProperties": true,
1915466 "type": "object"
2015466 },
2122198 {
2222198 "type": "null"
2322198 }
2417644 ],
2517644 },
2619210 "fraction": {
2719210 "type": "boolean"
2819210 },
292458 "id": {
302458 "anyOf": [
3124013 {
322400 "format": "uuid4",
3324013 "type": "string"
3424013 },
355248 {
365248 "type": "null"
375248 }
382458 ],
392458 },
4027010 "name": {
4127010 "type": "string"
4227010 },
431738 "pluralAbbreviation": {
441738 "anyOf": [
4514833 {
4614833 "type": "string"
4714833 },
4825156 {
4925156 "type": "null"
5025156 }
511738 ],
521738 },
531849 "pluralName": {
541849 "anyOf": [
5536157 {
5636157 "type": "string"
5736157 },
5814845 {
5914845 "type": "null"
6014845 }
611849 ],
621849 },
6317710 "useAbbreviation": {
6417710 "type": "boolean"
6517710 }
66132151 },
672804 "required": [
682804 "name"
692804 ],
70284247 "type": "object"
71129402}
CreateIngredientUnitAlias6 of 6 keywords
114222{
214210 "properties": {
314210 "name": {
414210 "type": "string"
514210 }
614210 },
71522 "required": [
81522 "name"
91522 ],
1015410 "type": "object"
1114222}
IngredientFood-Input32 of 41 keywords
191400{
2122122 "properties": {
316732 "aliases": {
416722 "items": {
616722 },
718910 "type": "array"
816732 },
9880 "createdAt": {
10880 "anyOf": [
11799 {
12790 "format": "date-time",
13799 "type": "string"
14799 },
15979 {
16979 "type": "null"
17979 }
18880 ],
19880 },
2017410 "description": {
2117410 "type": "string"
2217410 },
2318112 "extras": {
2418112 "anyOf": [
2515142 {
261n/a "additionalProperties": true,
2715142 "type": "object"
2815142 },
2930163 {
3030163 "type": "null"
3130163 }
3218112 ],
3318112 },
3416422 "householdsWithIngredientFood": {
3516410 "items": {
3640910 "type": "string"
3716410 },
3817412 "type": "array"
3916422 },
4019519 "id": {
411950 "format": "uuid4",
4219519 "type": "string"
4319519 },
44890 "label": {
45890 "anyOf": [
46881 {
48881 },
49818 {
50818 "type": "null"
51818 }
52890 ]
53890 },
541649 "labelId": {
551649 "anyOf": [
5614231 {
571421 "format": "uuid4",
5814330 "type": "string"
5914231 },
6022151 {
6122151 "type": "null"
6222151 }
631649 ],
641649 },
6523210 "name": {
6623210 "type": "string"
6723210 },
681818 "pluralName": {
691818 "anyOf": [
7026163 {
7126163 "type": "string"
7226163 },
7315534 {
7415534 "type": "null"
7515534 }
761818 ],
771818 },
78810 "update_at": {
79810 "anyOf": [
80729 {
81720 "format": "date-time",
82729 "type": "string"
83729 },
84972 {
85972 "type": "null"
86972 }
87810 ],
88810 }
89122122 },
9021233 "required": [
9121431 "id",
922423 "name"
9321233 ],
94245246 "type": "object"
9591400}
IngredientFoodAlias6 of 6 keywords
140722{
240710 "properties": {
340710 "name": {
440710 "type": "string"
540710 }
640710 },
74172 "required": [
84172 "name"
94172 ],
1041910 "type": "object"
1140722}
IngredientReferences7 of 8 keywords
16714{
2434 "properties": {
3434 "referenceId": {
4434 "anyOf": [
52225 {
6220 "format": "uuid4",
72225 "type": "string"
82225 },
92126 {
102126 "type": "null"
112126 }
12434 ],
13434 }
14434 },
157110 "type": "object"
166714}
IngredientUnit-Input30 of 37 keywords
194437{
2127156 "properties": {
317310 "abbreviation": {
417310 "type": "string"
517310 },
616332 "aliases": {
716322 "items": {
916322 },
1018510 "type": "array"
1116332 },
121170 "createdAt": {
131170 "anyOf": [
1410116 {
151010 "format": "date-time",
1610116 "type": "string"
1710116 },
1816101 {
1916101 "type": "null"
2016101 }
211170 ],
221170 },
2316710 "description": {
2416710 "type": "string"
2516710 },
2617644 "extras": {
2717644 "anyOf": [
2815466 {
291n/a "additionalProperties": true,
3015466 "type": "object"
3115466 },
3222198 {
3322198 "type": "null"
3422198 }
3517644 ],
3617644 },
3719210 "fraction": {
3819210 "type": "boolean"
3919210 },
4024013 "id": {
412400 "format": "uuid4",
4224013 "type": "string"
4324013 },
4427010 "name": {
4527010 "type": "string"
4627010 },
471738 "pluralAbbreviation": {
481738 "anyOf": [
4914833 {
5014833 "type": "string"
5114833 },
5225156 {
5325156 "type": "null"
5425156 }
551738 ],
561738 },
571849 "pluralName": {
581849 "anyOf": [
5936157 {
6036157 "type": "string"
6136157 },
6214845 {
6314845 "type": "null"
6414845 }
651849 ],
661849 },
67960 "update_at": {
68960 "anyOf": [
69897 {
70890 "format": "date-time",
71897 "type": "string"
72897 },
73789 {
74789 "type": "null"
75789 }
76960 ],
77960 },
7817710 "useAbbreviation": {
7917710 "type": "boolean"
8017710 }
81127156 },
8225034 "required": [
8325331 "id",
842804 "name"
8525034 ],
86284247 "type": "object"
8794437}
IngredientUnitAlias6 of 6 keywords
114222{
214210 "properties": {
314210 "name": {
414210 "type": "string"
514210 }
614210 },
71522 "required": [
81522 "name"
91522 ],
1015410 "type": "object"
1114222}
MultiPurposeLabelSummary1 of 11 keywords
1881{
280 "properties": {
330 "color": {
430 "type": "string"
530 },
680 "groupId": {
780 "format": "uuid4",
880 "type": "string"
980 },
1080 "id": {
1180 "format": "uuid4",
1280 "type": "string"
1380 },
1480 "name": {
1580 "type": "string"
1680 }
1780 },
1880 "required": [
1980 "name",
2080 "groupId",
2180 "id"
2280 ],
23881 "type": "object"
24881}
Nutrition47 of 47 keywords
161982{
25747 "properties": {
3794 "calories": {
4794 "anyOf": [
5776 {
6776 "type": "string"
7776 },
87211 {
97211 "type": "null"
107211 }
11794 ],
12794 },
13754 "carbohydrateContent": {
14754 "anyOf": [
15871 {
16871 "type": "string"
17871 },
186712 {
196712 "type": "null"
206712 }
21754 ],
22754 },
23794 "cholesterolContent": {
24794 "anyOf": [
25380 {
26380 "type": "string"
27380 },
28767 {
29767 "type": "null"
30767 }
31794 ],
32794 },
33674 "fatContent": {
34674 "anyOf": [
35368 {
36368 "type": "string"
37368 },
38647 {
39647 "type": "null"
40647 }
41674 ],
42674 },
43764 "fiberContent": {
44764 "anyOf": [
45872 {
46872 "type": "string"
47872 },
486812 {
496812 "type": "null"
506812 }
51764 ],
52764 },
53794 "proteinContent": {
54794 "anyOf": [
55974 {
56974 "type": "string"
57974 },
587013 {
597013 "type": "null"
607013 }
61794 ],
62794 },
63725 "saturatedFatContent": {
64725 "anyOf": [
65968 {
66968 "type": "string"
67968 },
686314 {
696314 "type": "null"
706314 }
71725 ],
72725 },
73714 "sodiumContent": {
74714 "anyOf": [
75966 {
76966 "type": "string"
77966 },
786213 {
796213 "type": "null"
806213 }
81714 ],
82714 },
83676 "sugarContent": {
84676 "anyOf": [
851261 {
861261 "type": "string"
871261 },
885518 {
895518 "type": "null"
905518 }
91676 ],
92676 },
93694 "transFatContent": {
94694 "anyOf": [
951162 {
961162 "type": "string"
971162 },
985815 {
995815 "type": "null"
1005815 }
101694 ],
102694 },
103654 "unsaturatedFatContent": {
104654 "anyOf": [
105960 {
106960 "type": "string"
107960 },
1085613 {
1095613 "type": "null"
1105613 }
111654 ],
112654 }
1135747 },
114108935 "type": "object"
11561982}
Recipe-Input127 of 128 keywords
11001817{
2957803 "properties": {
3112126 "assets": {
4112126 "anyOf": [
51037110 {
6103722 "items": {
8103722 },
9105988 "type": "array"
101037110 },
11841063 {
12841063 "type": "null"
13841063 }
14112126 ],
15112126 },
16105976 "comments": {
17105976 "anyOf": [
18989146 {
1998972 "items": {
2198972 },
22106174 "type": "array"
23989146 },
24701065 {
25701065 "type": "null"
26701065 }
27105976 ],
28105976 },
2911054 "cookTime": {
3011054 "anyOf": [
31711038 {
32711038 "type": "string"
33711038 },
34103475 {
35103475 "type": "null"
36103475 }
3711054 ],
3811054 },
3911298 "createdAt": {
4011298 "anyOf": [
41107958 {
4210794 "format": "date-time",
43108354 "type": "string"
44107958 },
45501087 {
46501087 "type": "null"
47501087 }
4811298 ],
4911298 },
5011228 "dateAdded": {
5111228 "anyOf": [
52106466 {
5310642 "format": "date",
54106664 "type": "string"
55106466 },
56581072 {
57581072 "type": "null"
58581072 }
5911228 ],
6011228 },
6111106 "dateUpdated": {
6211106 "anyOf": [
63103977 {
6410392 "format": "date-time",
65104175 "type": "string"
66103977 },
67711045 {
68711045 "type": "null"
69711045 }
7011106 ],
7111106 },
7211055 "description": {
7311055 "anyOf": [
74102783 {
75102783 "type": "string"
76102783 },
77781032 {
78781032 "type": "null"
79781032 }
8011055 ],
8111055 },
8210714 "extras": {
8310714 "anyOf": [
84101956 {
851n/a "additionalProperties": true,
86101956 "type": "object"
87101956 },
88521023 {
89521023 "type": "null"
90521023 }
9110714 ],
9210714 },
9310865 "groupId": {
9410860 "format": "uuid4",
9510865 "type": "string"
9610865 },
9710726 "householdId": {
9810721 "format": "uuid4",
9910735 "type": "string"
10010726 },
10110368 "id": {
10210368 "anyOf": [
103100440 {
10410043 "format": "uuid4",
105100737 "type": "string"
106100440 },
107321012 {
108321012 "type": "null"
109321012 }
11010368 ],
11110368 },
112987n/a "image": {
113987n/a "anyOf": [
114987n/a {},
1159816 {
1169816 "type": "null"
1179816 }
118987n/a ],
119987n/a },
12010757 "lastMade": {
12110757 "anyOf": [
122101567 {
12310153 "format": "date-time",
124101864 "type": "string"
125101567 },
126601022 {
127601022 "type": "null"
128601022 }
12910757 ],
13010757 },
131105813 "name": {
132105813 "anyOf": [
133261045 {
134261045 "type": "string"
135261045 },
136103239 {
137103239 "type": "null"
138103239 }
139105813 ],
140105813 },
141105925 "notes": {
142105925 "anyOf": [
143102460 {
144102421 "items": {
146102421 },
147104539 "type": "array"
148102460 },
149351049 {
150351049 "type": "null"
151351049 }
152105925 ],
153105925 },
15498954 "nutrition": {
15598954 "anyOf": [
15661982 {
15861982 },
159928115 {
160928115 "type": "null"
161928115 }
16298954 ]
16398954 },
16410954 "orgURL": {
16510954 "anyOf": [
166551044 {
167551044 "type": "string"
168551044 },
169104059 {
170104059 "type": "null"
171104059 }
17210954 ],
17310954 },
17411114 "performTime": {
17511114 "anyOf": [
176551060 {
177551060 "type": "string"
178551060 },
179105659 {
180105659 "type": "null"
181105659 }
18211114 ],
18311114 },
18411204 "prepTime": {
18511204 "anyOf": [
186431081 {
187431081 "type": "string"
188431081 },
189107747 {
190107747 "type": "null"
191107747 }
19211204 ],
19311204 },
19410674 "rating": {
19510674 "anyOf": [
196331038 {
197331038 "type": "number"
198331038 },
199103437 {
200103437 "type": "null"
201103437 }
20210674 ],
20310674 },
204103630 "recipeCategory": {
205103630 "anyOf": [
20699967 {
20799926 "items": {
20999926 },
210102541 "type": "array"
21199967 },
212371029 {
213371029 "type": "null"
214371029 }
215103630 ],
216103630 },
217780297 "recipeIngredient": {
218780291 "items": {
220780291 },
22110716 "type": "array"
222780297 },
223102057 "recipeInstructions": {
224102057 "anyOf": [
225967110 {
22696741 "items": {
22896741 },
229100869 "type": "array"
230967110 },
231531024 {
232531024 "type": "null"
233531024 }
234102057 ],
235102057 },
23610495 "recipeServings": {
23710495 "type": "number"
23810495 },
23910504 "recipeYield": {
24010504 "anyOf": [
241441010 {
242441010 "type": "string"
243441010 },
244100648 {
245100648 "type": "null"
246100648 }
24710504 ],
24810504 },
24910455 "recipeYieldQuantity": {
25010455 "type": "number"
25110455 },
25299435 "settings": {
25399435 "anyOf": [
25446983 {
25646983 },
25794881 {
25894881 "type": "null"
25994881 }
26099435 ]
26199435 },
26210285 "slug": {
26310285 "type": "string"
26410285 },
265103147 "tags": {
266103147 "anyOf": [
26798890 {
26898829 "items": {
27098829 },
271101761 "type": "array"
27298890 },
273431035 {
274431035 "type": "null"
275431035 }
276103147 ],
277103147 },
278102670 "tools": {
279102665 "items": {
281102665 },
28210915 "type": "array"
283102670 },
28410684 "totalTime": {
28510684 "anyOf": [
286571015 {
287571015 "type": "string"
288571015 },
289101161 {
290101161 "type": "null"
291101161 }
29210684 ],
29310684 },
294104510 "update_at": {
295104510 "anyOf": [
296101045 {
29710106 "format": "date-time",
298101639 "type": "string"
299101045 },
300351020 {
301351020 "type": "null"
302351020 }
303104510 ],
304104510 },
305136614 "userId": {
30613669 "format": "uuid4",
30713755 "type": "string"
308136614 }
309957803 },
310180414 "type": "object"
3111001817}
RecipeAsset11 of 11 keywords
124223{
224414 "properties": {
31174 "fileName": {
41174 "anyOf": [
53982 {
63982 "type": "string"
73982 },
87843 {
97843 "type": "null"
107843 }
111174 ],
121174 },
132525 "icon": {
142525 "type": "string"
152525 },
162525 "name": {
172525 "type": "string"
182525 }
1924414 },
202562 "required": [
212571 "name",
222571 "icon"
232562 ],
242587 "type": "object"
2524223}
RecipeCategory15 of 17 keywords
120227{
220418 "properties": {
31054 "groupId": {
41054 "anyOf": [
56049 {
6600 "format": "uuid4",
76049 "type": "string"
86049 },
94564 {
104564 "type": "null"
114564 }
121054 ],
131054 },
141344 "id": {
151344 "anyOf": [
167563 {
17750 "format": "uuid4",
187563 "type": "string"
197563 },
205979 {
215979 "type": "null"
225979 }
231344 ],
241344 },
252165 "name": {
262165 "type": "string"
272165 },
282165 "slug": {
292165 "type": "string"
302165 }
3120418 },
322202 "required": [
332211 "name",
342211 "slug"
352202 ],
362227 "type": "object"
3720227}
RecipeCommentOut-Input14 of 17 keywords
130478{
231164 "properties": {
33686 "createdAt": {
43681 "format": "date-time",
53695 "type": "string"
63686 },
73695 "id": {
83690 "format": "uuid4",
93695 "type": "string"
103695 },
113695 "recipeId": {
123690 "format": "uuid4",
133695 "type": "string"
143695 },
153695 "text": {
163695 "type": "string"
173695 },
183686 "update_at": {
193681 "format": "date-time",
203695 "type": "string"
213686 },
2234232 "user": {
2434232 },
253695 "userId": {
263690 "format": "uuid4",
273695 "type": "string"
283695 }
2931164 },
303687 "required": [
313741 "recipeId",
323741 "text",
333741 "id",
343741 "createdAt",
353741 "update_at",
363741 "userId",
373741 "user"
383687 ],
393757 "type": "object"
4030478}
RecipeIngredient-Input32 of 32 keywords
1338319{
2293314 "properties": {
34825 "display": {
44825 "type": "string"
54825 },
6373118 "food": {
7373118 "anyOf": [
891400 {
1091400 },
11131360 {
13131360 },
14242249 {
15242249 "type": "null"
16242249 }
17373118 ],
18373118 },
194984 "note": {
204984 "anyOf": [
2143171 {
2243171 "type": "string"
2343171 },
2467435 {
2567435 "type": "null"
2667435 }
274984 ],
284984 },
294854 "originalText": {
304854 "anyOf": [
3155434 {
3255434 "type": "string"
3355434 },
3443059 {
3543059 "type": "null"
3643059 }
374854 ],
384854 },
394904 "quantity": {
404904 "anyOf": [
4142173 {
4242173 "type": "number"
4342173 },
4469425 {
4569425 "type": "null"
4669425 }
474904 ],
484904 },
4946717 "referenceId": {
5046712 "format": "uuid",
514795 "type": "string"
5246717 },
534804 "title": {
544804 "anyOf": [
5574410 {
5674410 "type": "string"
5774410 },
5840678 {
5940678 "type": "null"
6040678 }
614804 ],
624804 },
63372159 "unit": {
64372159 "anyOf": [
6594437 {
6794437 },
68129402 {
70129402 },
71243288 {
72243288 "type": "null"
73243288 }
74372159 ],
75372159 }
76293314 },
776525 "type": "object"
78338319}
RecipeNote7 of 7 keywords
114052{
214243 "properties": {
31795 "text": {
41795 "type": "string"
51795 },
614638 "title": {
714638 "type": "string"
814638 }
914243 },
101832 "required": [
111841 "title",
121841 "text"
131832 ],
141857 "type": "object"
1514052}
RecipeSettings9 of 9 keywords
146983{
23131 "properties": {
3465 "disableComments": {
4465 "type": "boolean"
5465 },
6466 "landscapeView": {
7466 "type": "boolean"
8466 },
9445 "locked": {
10445 "type": "boolean"
11445 },
12445 "public": {
13445 "type": "boolean"
14445 },
15455 "showAssets": {
16455 "type": "boolean"
17455 },
18405 "showNutrition": {
19405 "type": "boolean"
20405 }
213131 },
2277952 "type": "object"
2346983}
RecipeStep21 of 21 keywords
16643{
26735 "properties": {
3586 "id": {
4586 "anyOf": [
54420 {
6442 "format": "uuid",
74618 "type": "string"
84420 },
91450 {
101450 "type": "null"
111450 }
12586 ],
13586 },
144716 "ingredientReferences": {
154711 "items": {
174711 },
18585 "type": "array"
194716 },
20534 "summary": {
21534 "anyOf": [
224512 {
234512 "type": "string"
244512 },
25849 {
26849 "type": "null"
27849 }
28534 ],
29534 },
30965 "text": {
31965 "type": "string"
32965 },
33574 "title": {
34574 "anyOf": [
354615 {
364615 "type": "string"
374615 },
381150 {
391150 "type": "null"
401150 }
41574 ],
42574 }
436735 },
441011 "required": [
451011 "text"
461011 ],
471027 "type": "object"
486643}
RecipeTag16 of 17 keywords
114838{
215029 "properties": {
3874 "groupId": {
4874 "anyOf": [
55833 {
6580 "format": "uuid4",
75833 "type": "string"
85833 },
92962 {
102962 "type": "null"
112962 }
12874 ],
13874 },
148812 "id": {
158812 "anyOf": [
165347 {
17538 "format": "uuid4",
186139 "type": "string"
195347 },
203565 {
213565 "type": "null"
223565 }
238812 ],
248812 },
251708 "name": {
261708 "type": "string"
271708 },
281735 "slug": {
291735 "type": "string"
301735 }
3115029 },
321772 "required": [
331781 "name",
341781 "slug"
351772 ],
361797 "type": "object"
3714838}
RecipeTool15 of 16 keywords
138386{
241945 "properties": {
325720 "groupId": {
425720 "anyOf": [
5134143 {
613416 "format": "uuid4",
7150127 "type": "string"
8134143 },
9123154 {
10123154 "type": "null"
11123154 }
1225720 ],
1325720 },
1426410 "householdsWithTool": {
152645 "items": {
1612255 "type": "string"
172645 },
182695 "type": "array"
1926410 },
204415 "id": {
214410 "format": "uuid4",
224415 "type": "string"
234415 },
244585 "name": {
254585 "type": "string"
264585 },
274425 "slug": {
284425 "type": "string"
294425 }
3041945 },
3142836 "required": [
3244618 "id",
334631 "name",
3444717 "slug"
3542836 ],
364645 "type": "object"
3738386}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
134232{
234425 "properties": {
33635 "admin": {
43635 "type": "boolean"
53635 },
61717 "fullName": {
71717 "anyOf": [
839139 {
939139 "type": "string"
1039139 },
1113246 {
1213246 "type": "null"
1313246 }
141717 ],
151717 },
163635 "id": {
173630 "format": "uuid4",
183635 "type": "string"
193635 },
201948 "username": {
211948 "anyOf": [
2283119 {
2383119 "type": "string"
2483119 },
2511191 {
2611191 "type": "null"
2711191 }
281948 ],
291948 }
3034425 },
313672 "required": [
323681 "id",
333681 "admin"
343672 ],
353695 "type": "object"
3634232}
Responses
codedescriptionhitsavg
200Successful Response5111ms
422Validation Error7544ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error59920ms
400Bad Request41ms
Examples
Body: application/json
[]Recipe-Input.assets
[]Recipe-Input.comments
""Recipe-Input.description
{}Recipe-Input.extras
[]Recipe-Input.notes
[]Recipe-Input.recipeCategory
[]Recipe-Input.recipeIngredient
""RecipeIngredient-Input.display
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""RecipeIngredient-Input.note
0RecipeIngredient-Input.quantity
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
[]RecipeStep.ingredientReferences
""RecipeStep.summary
""RecipeStep.title
[]Recipe-Input.recipeInstructions
0Recipe-Input.recipeServings
0Recipe-Input.recipeYieldQuantity
trueRecipeSettings.disableComments
falseRecipeSettings.landscapeView
falseRecipeSettings.locked
falseRecipeSettings.public
falseRecipeSettings.showAssets
falseRecipeSettings.showNutrition
""Recipe-Input.slug
[]Recipe-Input.tags
[]Recipe-Input.tools
[]RecipeTool.householdsWithTool
Headers
accept-language3 / 3
#validinvalidschema
1282n/a{
2282n/a "anyOf": [
3185n/a {
4185n/a "type": "string"
5185n/a },
697185 {
797185 "type": "null"
897185 }
9282n/a ],
10282n/a}
Body
application/json5 / 5
ScrapeRecipeData
115796{
218138 "properties": {
316728 "data": {
416728 "type": "string"
516728 },
611023 "includeTags": {
711023 "type": "boolean"
811023 }
918138 },
1019553 "required": [
1119553 "data"
1219553 ],
132485 "type": "object"
1415796}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error2385ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3267ms
Examples
Body: application/json
falseScrapeRecipeData.includeTags
Query Parameters
translateLanguage2 / 3
#validinvalidschema
1184n/a{
2184n/a "anyOf": [
3184n/a {
4184n/a "type": "string"
5184n/a },
60184 {
70184 "type": "null"
80184 }
9184n/a ],
10184n/a}
Headers
accept-language3 / 3
1265n/a{
2265n/a "anyOf": [
3171n/a {
4171n/a "type": "string"
5171n/a },
694171 {
794171 "type": "null"
894171 }
9265n/a ],
10265n/a}
Body
multipart/form-data4 / 6
Body_create_recipe_from_image_api_recipes_create_image_post
1216160{
22160 "properties": {
32160 "images": {
4216n/a "items": {
51607n/a "format": "binary",
61607n/a "type": "string"
7216n/a },
82160 "type": "array"
92160 }
102160 },
11216160 "required": [
12216160 "images"
13216160 ],
14376n/a "type": "object"
15216160}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error22010ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request30316ms
Headers
accept-language3 / 3
#validinvalidschema
1456n/a{
2456n/a "anyOf": [
3286n/a {
4286n/a "type": "string"
5286n/a },
6170286 {
7170286 "type": "null"
8170286 }
9456n/a ],
10456n/a}
Body
application/json5 / 5
ScrapeRecipe
1356117{
238246 "properties": {
317440 "includeTags": {
417440 "type": "boolean"
517440 },
636537 "url": {
736537 "type": "string"
836537 }
938246 },
1040258 "required": [
1140258 "url"
1240258 ],
1346013 "type": "object"
14356117}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error3486ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request41035ms
Examples
Body: application/json
{ "includeTags": true, "url": "https://myfavoriterecipes.com/recipes" }ScrapeRecipe
falseScrapeRecipe.includeTags
Headers
accept-language3 / 3
#validinvalidschema
1376n/a{
2376n/a "anyOf": [
3254n/a {
4254n/a "type": "string"
5254n/a },
6122254 {
7122254 "type": "null"
8122254 }
9376n/a ],
10376n/a}
Body
application/json40 / 43
CreateRecipeByUrlBulk
1196117{
2196106 "properties": {
3196106 "imports": {
4196101 "items": {
6196101 },
72975 "type": "array"
8196106 }
9196106 },
103026 "required": [
113026 "imports"
123026 ],
133085 "type": "object"
14196117}
Referenced Components (3)47 of 50 keywords
CreateRecipeBulk16 of 16 keywords
1535176{
2540165 "properties": {
336196 "categories": {
436196 "anyOf": [
5196261 {
619632 "items": {
819632 },
9228229 "type": "array"
10196261 },
11165292 {
12165292 "type": "null"
13165292 }
1436196 ],
1536196 },
16308104 "tags": {
17308104 "anyOf": [
18122290 {
1912262 "items": {
2112262 },
22184228 "type": "array"
23122290 },
24186226 {
25186226 "type": "null"
26186226 }
27308104 ],
28308104 },
2966436 "url": {
3066436 "type": "string"
3166436 }
32540165 },
337006 "required": [
347006 "url"
357006 ],
367065 "type": "object"
37535176}
RecipeCategory16 of 17 keywords
146534{
246725 "properties": {
327211 "groupId": {
427211 "anyOf": [
519588 {
61957 "format": "uuid4",
720281 "type": "string"
819588 },
977206 {
1077206 "type": "null"
1177206 }
1227211 ],
1327211 },
142454 "id": {
152454 "anyOf": [
1615297 {
171520 "format": "uuid4",
1815297 "type": "string"
1915297 },
2093156 {
2193156 "type": "null"
2293156 }
232454 ],
242454 },
254865 "name": {
264865 "type": "string"
274865 },
2847912 "slug": {
2947912 "type": "string"
3047912 }
3146725 },
324902 "required": [
334911 "name",
344911 "slug"
354902 ],
364927 "type": "object"
3746534}
RecipeTag15 of 17 keywords
1291172{
230532 "properties": {
31624 "groupId": {
41624 "anyOf": [
59670 {
6960 "format": "uuid4",
79670 "type": "string"
89670 },
966100 {
1066100 "type": "null"
1166100 }
121624 ],
131624 },
141604 "id": {
151604 "anyOf": [
169668 {
17960 "format": "uuid4",
189668 "type": "string"
199668 },
2064100 {
2164100 "type": "null"
2264100 }
231604 ],
241604 },
2531012 "name": {
2631012 "type": "string"
2731012 },
2831012 "slug": {
2931012 "type": "string"
3031012 }
3130532 },
3230989 "required": [
3332276 "name",
3432276 "slug"
3530989 ],
3639865 "type": "object"
37291172}
Responses
codedescriptionhitsavg
202Successful Response196115ms
422Validation Error14410ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request168ms
Headers
accept-language3 / 3
#validinvalidschema
1271n/a{
2271n/a "anyOf": [
3167n/a {
4167n/a "type": "string"
5167n/a },
6104167 {
7104167 "type": "null"
8104167 }
9271n/a ],
10271n/a}
Body
multipart/form-data5 / 5
Body_create_recipe_from_zip_api_recipes_create_zip_post
1112126{
2112n/a "properties": {
3112n/a "archive": {
4112n/a "format": "binary",
5112n/a "type": "string"
6112n/a }
7112n/a },
8112126 "required": [
9112126 "archive"
10112126 ],
11238n/a "type": "object"
12112126}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error20616ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error19432ms
400Bad Request171ms
Query Parameters
foods3 / 5
#validinvalidschema
1132197{
2132197 "anyOf": [
3132197 {
4132197 "items": {
5498509 "format": "uuid4",
61007n/a "type": "string"
7132197 },
83290 "type": "array"
9132197 },
100329 {
110329 "type": "null"
120329 }
13132197 ],
14132197}
tools3 / 5
1112225{
2112225 "anyOf": [
3112225 {
4112225 "items": {
5452362 "format": "uuid4",
6814n/a "type": "string"
7112225 },
83370 "type": "array"
9112225 },
100337 {
110337 "type": "null"
120337 }
13112225 ],
14112225}
orderBy3 / 3
1264n/a{
2264n/a "anyOf": [
3214n/a {
4214n/a "type": "string"
5214n/a },
650214 {
750214 "type": "null"
850214 }
9264n/a ],
10264n/a}
orderByNullPosition5 / 5
1271217{
2271217 "anyOf": [
3153335 {
5153335 },
6118370 {
7118370 "type": "null"
8118370 }
9271217 ],
10271217}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1153335{
2153335 "enum": [
385n/a "first",
468n/a "last"
5153335 ],
6370n/a "type": "string"
7153335}
orderDirection2 / 2
OrderDirection
119320{
219320 "enum": [
3135n/a "asc",
458n/a "desc"
519320 ],
6213n/a "type": "string"
719320}
queryFilter3 / 3
1189n/a{
2189n/a "anyOf": [
3153n/a {
4153n/a "type": "string"
5153n/a },
636153 {
736153 "type": "null"
836153 }
9189n/a ],
10189n/a}
paginationSeed3 / 3
1166n/a{
2166n/a "anyOf": [
3140n/a {
4140n/a "type": "string"
5140n/a },
626140 {
726140 "type": "null"
826140 }
9166n/a ],
10166n/a}
limit1 / 1
126827{
226827 "type": "integer"
326827}
maxMissingFoods1 / 1
126331{
226331 "type": "integer"
326331}
maxMissingTools1 / 1
1186123{
2186123 "type": "integer"
3186123}
includeFoodsOnHand1 / 1
132824{
232824 "type": "boolean"
332824}
includeToolsOnHand1 / 1
127815{
227815 "type": "boolean"
327815}
Headers
accept-language3 / 3
1596n/a{
2596n/a "anyOf": [
3410n/a {
4410n/a "type": "string"
5410n/a },
6186410 {
7186410 "type": "null"
8186410 }
9596n/a ],
10596n/a}
Responses
codedescriptionhitsavg
200Successful Response23022ms
422Validation Error41513ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request3814ms
500Internal Server Error1430ms
Examples
Query
"desc"orderDirection
10limit
5maxMissingFoods
5maxMissingTools
trueincludeFoodsOnHand
trueincludeToolsOnHand
Headers
accept-language3 / 3
#validinvalidschema
1447n/a{
2447n/a "anyOf": [
3275n/a {
4275n/a "type": "string"
5275n/a },
6172275 {
7172275 "type": "null"
8172275 }
9447n/a ],
10447n/a}
Body
application/json5 / 5
ScrapeRecipeTest
143067{
244612 "properties": {
34357 "url": {
44357 "type": "string"
54357 },
62527 "useOpenAI": {
72527 "type": "boolean"
82527 }
944612 },
1044247 "required": [
1144247 "url"
1244247 ],
134898 "type": "object"
1443067}
Responses
codedescriptionhitsavg
200Successful Response18213ms
422Validation Error1017ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error24916ms
400Bad Request11ms
Examples
Body: application/json
falseScrapeRecipeTest.useOpenAI
Path Parameters
slug1 / 1
#validinvalidschema
134n/a{
234n/a "type": "string"
334n/a}
Headers
accept-language3 / 3
113n/a{
213n/a "anyOf": [
310n/a {
410n/a "type": "string"
510n/a },
6310 {
7310 "type": "null"
8310 }
913n/a ],
1013n/a}
Responses
codedescriptionhitsavg
200Successful Response26101ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found719ms
500Internal Server Error128ms
Path Parameters
slug1 / 1
#validinvalidschema
1429n/a{
2429n/a "type": "string"
3429n/a}
Headers
accept-language3 / 3
1224n/a{
2224n/a "anyOf": [
3145n/a {
4145n/a "type": "string"
5145n/a },
679145 {
779145 "type": "null"
879145 }
9224n/a ],
10224n/a}
Responses
codedescriptionhitsavg
200Successful Response38847ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4156ms
Path Parameters
slug1 / 1
#validinvalidschema
11443n/a{
21443n/a "type": "string"
31443n/a}
Headers
accept-language3 / 3
11142n/a{
21142n/a "anyOf": [
31102n/a {
41102n/a "type": "string"
51102n/a },
6401102 {
7401102 "type": "null"
8401102 }
91142n/a ],
101142n/a}
Body
application/json375 / 407
Recipe-Input
1615759{
2393748 "properties": {
3100826 "assets": {
4100826 "anyOf": [
598648 {
698622 "items": {
898622 },
9100826 "type": "array"
1098648 },
11221012 {
12221012 "type": "null"
13221012 }
14100826 ],
15100826 },
1694974 "comments": {
1794974 "anyOf": [
1893885 {
1993870 "items": {
2193870 },
22100815 "type": "array"
2393885 },
24111012 {
25111012 "type": "null"
26111012 }
2794974 ],
2894974 },
2910114 "cookTime": {
3010114 "anyOf": [
31111004 {
32111004 "type": "string"
33111004 },
34100015 {
35100015 "type": "null"
36100015 }
3710114 ],
3810114 },
3910017 "createdAt": {
4010017 "anyOf": [
4199810 {
429983 "format": "date-time",
4310017 "type": "string"
4499810 },
4531005 {
4631005 "type": "null"
4731005 }
4810017 ],
4910017 },
5010106 "dateAdded": {
5110106 "anyOf": [
52100313 {
5310032 "format": "date",
54100511 "type": "string"
55100313 },
5671009 {
5771009 "type": "null"
5871009 }
5910106 ],
6010106 },
6110156 "dateUpdated": {
6210156 "anyOf": [
63101110 {
6410112 "format": "date-time",
6510138 "type": "string"
66101110 },
6741017 {
6841017 "type": "null"
6941017 }
7010156 ],
7110156 },
7210014 "description": {
7310014 "anyOf": [
749969 {
759969 "type": "string"
769969 },
7751000 {
7851000 "type": "null"
7951000 }
8010014 ],
8110014 },
8210114 "extras": {
8310114 "anyOf": [
8498926 {
851n/a "additionalProperties": true,
8698926 "type": "object"
8798926 },
8822993 {
8922993 "type": "null"
9022993 }
9110114 ],
9210114 },
9310105 "groupId": {
9410100 "format": "uuid4",
9510105 "type": "string"
9610105 },
9710005 "householdId": {
9810000 "format": "uuid4",
9910005 "type": "string"
10010005 },
10110025 "id": {
10210025 "anyOf": [
10399710 {
1049971 "format": "uuid4",
1059989 "type": "string"
10699710 },
10751002 {
10851002 "type": "null"
10951002 }
11010025 ],
11110025 },
112987n/a "image": {
113987n/a "anyOf": [
114987n/a {},
1159816 {
1169816 "type": "null"
1179816 }
118987n/a ],
119987n/a },
12010036 "lastMade": {
12110036 "anyOf": [
12299415 {
1239942 "format": "date-time",
12499613 "type": "string"
12599415 },
12691000 {
12791000 "type": "null"
12891000 }
12910036 ],
13010036 },
1319946 "name": {
1329946 "anyOf": [
13312988 {
13412988 "type": "string"
13512988 },
13698218 {
13798218 "type": "null"
13898218 }
1399946 ],
1409946 },
14199622 "notes": {
14299622 "anyOf": [
14398830 {
14498818 "items": {
14698818 },
147100612 "type": "array"
14898830 },
14981010 {
15081010 "type": "null"
15181010 }
15299622 ],
15399622 },
15494753 "nutrition": {
15594753 "anyOf": [
15635965 {
15835965 },
15991288 {
16091288 "type": "null"
16191288 }
16294753 ]
16394753 },
1649944 "orgURL": {
1659944 "anyOf": [
1665993 {
1675993 "type": "string"
1685993 },
1699899 {
1709899 "type": "null"
1719899 }
1729944 ],
1739944 },
17410014 "performTime": {
17510014 "anyOf": [
17613992 {
17713992 "type": "string"
17813992 },
17998817 {
18098817 "type": "null"
18198817 }
18210014 ],
18310014 },
18410064 "prepTime": {
18510064 "anyOf": [
18630980 {
18730980 "type": "string"
18830980 },
18997634 {
19097634 "type": "null"
19197634 }
19210064 ],
19310064 },
1949974 "rating": {
1959974 "anyOf": [
1965996 {
1975996 "type": "number"
1985996 },
1999929 {
2009929 "type": "null"
2019929 }
2029974 ],
2039974 },
20497130 "recipeCategory": {
20597130 "anyOf": [
20696239 {
20796226 "items": {
20996226 },
21098813 "type": "array"
21196239 },
2129992 {
2139992 "type": "null"
2149992 }
21597130 ],
21697130 },
217715275 "recipeIngredient": {
218715270 "items": {
220715270 },
2219855 "type": "array"
222715275 },
22394649 "recipeInstructions": {
22494649 "anyOf": [
22593857 {
22693845 "items": {
22893845 },
22998312 "type": "array"
23093857 },
2318987 {
2328987 "type": "null"
2338987 }
23494649 ],
23594649 },
2369915 "recipeServings": {
2379915 "type": "number"
2389915 },
2399914 "recipeYield": {
2409914 "anyOf": [
2416989 {
2426989 "type": "string"
2436989 },
24498510 {
24598510 "type": "null"
24698510 }
2479914 ],
2489914 },
2499865 "recipeYieldQuantity": {
2509865 "type": "number"
2519865 },
25294634 "settings": {
25394634 "anyOf": [
25422958 {
25622958 },
25792456 {
25892456 "type": "null"
25992456 }
26094634 ]
26194634 },
2629985 "slug": {
2639985 "type": "string"
2649985 },
26594531 "tags": {
26694531 "anyOf": [
26794234 {
26894226 "items": {
27094226 },
2719688 "type": "array"
27294234 },
2733973 {
2743973 "type": "null"
2753973 }
27694531 ],
27794531 },
27894252 "tools": {
27994246 "items": {
28194246 },
2829886 "type": "array"
28394252 },
2849804 "totalTime": {
2859804 "anyOf": [
2862982 {
2872982 "type": "string"
2882982 },
2899786 {
2909786 "type": "null"
2919786 }
2929804 ],
2939804 },
2949686 "update_at": {
2959686 "anyOf": [
2969677 {
2979672 "format": "date-time",
2989695 "type": "string"
2999677 },
3001973 {
3011973 "type": "null"
3021973 }
3039686 ],
3049686 },
3059925 "userId": {
3069920 "format": "uuid4",
3079925 "type": "string"
3089925 }
309393748 },
310136311 "type": "object"
311615759}
Referenced Components (21)356 of 391 keywords
CreateIngredientFood29 of 30 keywords
157336{
259116 "properties": {
311638 "aliases": {
411622 "items": {
611622 },
713816 "type": "array"
811638 },
914010 "description": {
1014010 "type": "string"
1114010 },
121408 "extras": {
131408 "anyOf": [
1413216 {
151n/a "additionalProperties": true,
1613216 "type": "object"
1713216 },
188140 {
198140 "type": "null"
208140 }
211408 ],
221408 },
2312222 "householdsWithIngredientFood": {
2412212 "items": {
255717 "type": "string"
2612212 },
2713410 "type": "array"
2812222 },
291548 "id": {
301548 "anyOf": [
311539 {
321530 "format": "uuid4",
331539 "type": "string"
341539 },
351161 {
361161 "type": "null"
371161 }
381548 ],
391548 },
4013012 "labelId": {
4113012 "anyOf": [
4212319 {
431234 "format": "uuid4",
4412715 "type": "string"
4512319 },
467135 {
477135 "type": "null"
487135 }
4913012 ],
5013012 },
5116310 "name": {
5216310 "type": "string"
5316310 },
541288 "pluralName": {
551288 "anyOf": [
568128 {
578128 "type": "string"
588128 },
5912016 {
6012016 "type": "null"
6112016 }
621288 ],
631288 }
6459116 },
651733 "required": [
661733 "name"
671733 ],
68176217 "type": "object"
6957336}
CreateIngredientFoodAlias6 of 6 keywords
17122{
27110 "properties": {
37110 "name": {
47110 "type": "string"
57110 }
67110 },
7812 "required": [
8812 "name"
9812 ],
108310 "type": "object"
117122}
CreateIngredientUnit29 of 30 keywords
160321{
262121 "properties": {
314410 "abbreviation": {
414410 "type": "string"
514410 },
612732 "aliases": {
712722 "items": {
912722 },
1014910 "type": "array"
1112732 },
1214510 "description": {
1314510 "type": "string"
1414510 },
151438 "extras": {
161438 "anyOf": [
1713714 {
181n/a "additionalProperties": true,
1913714 "type": "object"
2013714 },
216145 {
226145 "type": "null"
236145 }
241438 ],
251438 },
2614010 "fraction": {
2714010 "type": "boolean"
2814010 },
291608 "id": {
301608 "anyOf": [
3115612 {
321560 "format": "uuid4",
3315612 "type": "string"
3415612 },
354164 {
364164 "type": "null"
374164 }
381608 ],
391608 },
4016813 "name": {
4116813 "type": "string"
4216813 },
431418 "pluralAbbreviation": {
441418 "anyOf": [
4513415 {
4613415 "type": "string"
4713415 },
487142 {
497142 "type": "null"
507142 }
511418 ],
521418 },
5313612 "pluralName": {
5413612 "anyOf": [
554144 {
564144 "type": "string"
574144 },
5813216 {
5913216 "type": "null"
6013216 }
6113612 ],
6213612 },
6313110 "useAbbreviation": {
6413110 "type": "boolean"
6513110 }
6662121 },
671813 "required": [
681813 "name"
691813 ],
70184197 "type": "object"
7160321}
CreateIngredientUnitAlias6 of 6 keywords
13722{
23710 "properties": {
33710 "name": {
43710 "type": "string"
53710 }
63710 },
7472 "required": [
8472 "name"
9472 ],
104910 "type": "object"
113722}
IngredientFood-Input35 of 41 keywords
141352{
256119 "properties": {
311638 "aliases": {
411622 "items": {
611622 },
713816 "type": "array"
811638 },
9786 "createdAt": {
10786 "anyOf": [
117311 {
12732 "format": "date-time",
13759 "type": "string"
147311 },
15579 {
16579 "type": "null"
17579 }
18786 ],
19786 },
2014010 "description": {
2114010 "type": "string"
2214010 },
231408 "extras": {
241408 "anyOf": [
2513216 {
261n/a "additionalProperties": true,
2713216 "type": "object"
2813216 },
298140 {
308140 "type": "null"
318140 }
321408 ],
331408 },
3412222 "householdsWithIngredientFood": {
3512212 "items": {
365717 "type": "string"
3712212 },
3813410 "type": "array"
3912222 },
401539 "id": {
411530 "format": "uuid4",
421539 "type": "string"
431539 },
44750 "label": {
45750 "anyOf": [
46570 {
48570 },
49705 {
50705 "type": "null"
51705 }
52750 ]
53750 },
5413012 "labelId": {
5513012 "anyOf": [
5612319 {
571234 "format": "uuid4",
5812715 "type": "string"
5912319 },
607135 {
617135 "type": "null"
627135 }
6313012 ],
6413012 },
6516310 "name": {
6616310 "type": "string"
6716310 },
681288 "pluralName": {
691288 "anyOf": [
708128 {
718128 "type": "string"
728128 },
7312016 {
7412016 "type": "null"
7512016 }
761288 ],
771288 },
78750 "update_at": {
79750 "anyOf": [
80705 {
81700 "format": "date-time",
82705 "type": "string"
83705 },
84570 {
85570 "type": "null"
86570 }
87750 ],
88750 }
8956119 },
9016016 "required": [
9116214 "id",
921733 "name"
9316016 ],
94176217 "type": "object"
9541352}
IngredientFoodAlias6 of 6 keywords
17122{
27110 "properties": {
37110 "name": {
47110 "type": "string"
57110 }
67110 },
7812 "required": [
8812 "name"
9812 ],
108310 "type": "object"
117122}
IngredientReferences8 of 8 keywords
110336{
24031 "properties": {
34031 "referenceId": {
44031 "anyOf": [
5863 {
6827 "format": "uuid4",
73536 "type": "string"
8863 },
93239 {
103239 "type": "null"
113239 }
124031 ],
134031 }
144031 },
151345 "type": "object"
1610336}
IngredientUnit-Input30 of 37 keywords
144337{
260123 "properties": {
314410 "abbreviation": {
414410 "type": "string"
514410 },
612732 "aliases": {
712722 "items": {
912722 },
1014910 "type": "array"
1112732 },
12820 "createdAt": {
13820 "anyOf": [
14784 {
15780 "format": "date-time",
16784 "type": "string"
17784 },
18478 {
19478 "type": "null"
20478 }
21820 ],
22820 },
2314510 "description": {
2414510 "type": "string"
2514510 },
261438 "extras": {
271438 "anyOf": [
2813714 {
291n/a "additionalProperties": true,
3013714 "type": "object"
3113714 },
326145 {
336145 "type": "null"
346145 }
351438 ],
361438 },
3714010 "fraction": {
3814010 "type": "boolean"
3914010 },
4015612 "id": {
411560 "format": "uuid4",
4215612 "type": "string"
4315612 },
4416813 "name": {
4516813 "type": "string"
4616813 },
471418 "pluralAbbreviation": {
481418 "anyOf": [
4913415 {
5013415 "type": "string"
5113415 },
527142 {
537142 "type": "null"
547142 }
551418 ],
561418 },
5713612 "pluralName": {
5813612 "anyOf": [
594144 {
604144 "type": "string"
614144 },
6213216 {
6313216 "type": "null"
6413216 }
6513612 ],
6613612 },
67740 "update_at": {
68740 "anyOf": [
69713 {
70710 "format": "date-time",
71713 "type": "string"
72713 },
73371 {
74371 "type": "null"
75371 }
76740 ],
77740 },
7813110 "useAbbreviation": {
7913110 "type": "boolean"
8013110 }
8160123 },
8216618 "required": [
8316816 "id",
841813 "name"
8516618 ],
86184197 "type": "object"
8744337}
IngredientUnitAlias6 of 6 keywords
13722{
23710 "properties": {
33710 "name": {
43710 "type": "string"
53710 }
63710 },
7472 "required": [
8472 "name"
9472 ],
104910 "type": "object"
113722}
MultiPurposeLabelSummary1 of 11 keywords
1570{
250 "properties": {
330 "color": {
430 "type": "string"
530 },
650 "groupId": {
750 "format": "uuid4",
850 "type": "string"
950 },
1050 "id": {
1150 "format": "uuid4",
1250 "type": "string"
1350 },
1450 "name": {
1550 "type": "string"
1650 }
1750 },
1850 "required": [
1950 "name",
2050 "groupId",
2150 "id"
2250 ],
23570 "type": "object"
24570}
Nutrition47 of 47 keywords
135965{
23449 "properties": {
3684 "calories": {
4684 "anyOf": [
5270 {
6270 "type": "string"
7270 },
8666 {
9666 "type": "null"
10666 }
11684 ],
12684 },
13645 "carbohydrateContent": {
14645 "anyOf": [
15366 {
16366 "type": "string"
17366 },
18618 {
19618 "type": "null"
20618 }
21645 ],
22645 },
23665 "cholesterolContent": {
24665 "anyOf": [
25368 {
26368 "type": "string"
27368 },
28638 {
29638 "type": "null"
30638 }
31665 ],
32665 },
33636 "fatContent": {
34636 "anyOf": [
35465 {
36465 "type": "string"
37465 },
385910 {
395910 "type": "null"
405910 }
41636 ],
42636 },
43644 "fiberContent": {
44644 "anyOf": [
45365 {
46365 "type": "string"
47365 },
48617 {
49617 "type": "null"
50617 }
51644 ],
52644 },
53624 "proteinContent": {
54624 "anyOf": [
55363 {
56363 "type": "string"
57363 },
58597 {
59597 "type": "null"
60597 }
61624 ],
62624 },
63604 "saturatedFatContent": {
64604 "anyOf": [
65262 {
66262 "type": "string"
67262 },
68586 {
69586 "type": "null"
70586 }
71604 ],
72604 },
73614 "sodiumContent": {
74614 "anyOf": [
75263 {
76263 "type": "string"
77263 },
78596 {
79596 "type": "null"
80596 }
81614 ],
82614 },
83574 "sugarContent": {
84574 "anyOf": [
85259 {
86259 "type": "string"
87259 },
88556 {
89556 "type": "null"
90556 }
91574 ],
92574 },
93595 "transFatContent": {
94595 "anyOf": [
95262 {
96262 "type": "string"
97262 },
98577 {
99577 "type": "null"
100577 }
101595 ],
102595 },
103554 "unsaturatedFatContent": {
104554 "anyOf": [
105257 {
106257 "type": "string"
107257 },
108536 {
109536 "type": "null"
110536 }
111554 ],
112554 }
1133449 },
11484916 "type": "object"
11535965}
RecipeAsset11 of 11 keywords
13423{
23614 "properties": {
3294 "fileName": {
4294 "anyOf": [
5924 {
6924 "type": "string"
7924 },
82013 {
92013 "type": "null"
102013 }
11294 ],
12294 },
13445 "icon": {
14445 "type": "string"
15445 },
16445 "name": {
17445 "type": "string"
18445 }
193614 },
20482 "required": [
21491 "name",
22491 "icon"
23482 ],
24507 "type": "object"
253423}
RecipeCategory15 of 17 keywords
14927{
25118 "properties": {
3414 "groupId": {
4414 "anyOf": [
5369 {
6360 "format": "uuid4",
7369 "type": "string"
8369 },
9540 {
10540 "type": "null"
11540 }
12414 ],
13414 },
14424 "id": {
15424 "anyOf": [
162521 {
17250 "format": "uuid4",
182521 "type": "string"
192521 },
201729 {
211729 "type": "null"
221729 }
23424 ],
24424 },
25635 "name": {
26635 "type": "string"
27635 },
28635 "slug": {
29635 "type": "string"
30635 }
315118 },
32672 "required": [
33681 "name",
34681 "slug"
35672 ],
36697 "type": "object"
374927}
RecipeCommentOut-Input14 of 17 keywords
14171{
24857 "properties": {
3986 "createdAt": {
4981 "format": "date-time",
5995 "type": "string"
6986 },
7995 "id": {
8990 "format": "uuid4",
9995 "type": "string"
10995 },
11995 "recipeId": {
12990 "format": "uuid4",
13995 "type": "string"
14995 },
15995 "text": {
16995 "type": "string"
17995 },
18986 "update_at": {
19981 "format": "date-time",
20995 "type": "string"
21986 },
227925 "user": {
247925 },
25995 "userId": {
26990 "format": "uuid4",
27995 "type": "string"
28995 }
294857 },
30987 "required": [
311041 "recipeId",
321041 "text",
331041 "id",
341041 "createdAt",
351041 "update_at",
361041 "userId",
371041 "user"
38987 ],
391057 "type": "object"
404171}
RecipeIngredient-Input32 of 32 keywords
1131285{
2129280 "properties": {
33805 "display": {
43805 "type": "string"
53805 },
6270123 "food": {
7270123 "anyOf": [
841352 {
1041352 },
1157336 {
1357336 },
14213180 {
15213180 "type": "null"
16213180 }
17270123 ],
18270123 },
193824 "note": {
203824 "anyOf": [
2137016 {
2237016 "type": "string"
2337016 },
2412374 {
2512374 "type": "null"
2612374 }
273824 ],
283824 },
293834 "originalText": {
303834 "anyOf": [
3110377 {
3210377 "type": "string"
3310377 },
3437314 {
3537314 "type": "null"
3637314 }
373834 ],
383834 },
393814 "quantity": {
403814 "anyOf": [
4137510 {
4237510 "type": "number"
4337510 },
446379 {
456379 "type": "null"
466379 }
473814 ],
483814 },
493756 "referenceId": {
503751 "format": "uuid",
513765 "type": "string"
523756 },
533746 "title": {
543746 "anyOf": [
554376 {
564376 "type": "string"
574376 },
5837010 {
5937010 "type": "null"
6037010 }
613746 ],
623746 },
63253128 "unit": {
64253128 "anyOf": [
6544337 {
6744337 },
6860321 {
7060321 },
71193188 {
72193188 "type": "null"
73193188 }
74253128 ],
75253128 }
76129280 },
774115 "type": "object"
78131285}
RecipeNote7 of 7 keywords
18419{
28610 "properties": {
3905 "text": {
4905 "type": "string"
5905 },
6905 "title": {
7905 "type": "string"
8905 }
98610 },
10942 "required": [
11951 "title",
12951 "text"
13942 ],
14967 "type": "object"
158419}
RecipeSettings9 of 9 keywords
122958{
22030 "properties": {
3385 "disableComments": {
4385 "type": "boolean"
5385 },
6385 "landscapeView": {
7385 "type": "boolean"
8385 },
9385 "locked": {
10385 "type": "boolean"
11385 },
12375 "public": {
13375 "type": "boolean"
14375 },
15355 "showAssets": {
16355 "type": "boolean"
17355 },
18355 "showNutrition": {
19355 "type": "boolean"
20355 }
212030 },
2252928 "type": "object"
2322958}
RecipeStep21 of 21 keywords
12985{
25740 "properties": {
3586 "id": {
4586 "anyOf": [
54816 {
6482 "format": "uuid",
75014 "type": "string"
84816 },
91054 {
101054 "type": "null"
111054 }
12586 ],
13586 },
145321 "ingredientReferences": {
155316 "items": {
175316 },
18695 "type": "array"
195321 },
20604 "summary": {
21604 "anyOf": [
224915 {
234915 "type": "string"
244915 },
251153 {
261153 "type": "null"
271153 }
28604 ],
29604 },
30645 "text": {
31645 "type": "string"
32645 },
33564 "title": {
34564 "anyOf": [
354911 {
364911 "type": "string"
374911 },
38753 {
39753 "type": "null"
40753 }
41564 ],
42564 }
435740 },
446938 "required": [
456938 "text"
466938 ],
471077 "type": "object"
482985}
RecipeTag15 of 17 keywords
11427{
21618 "properties": {
3244 "groupId": {
4244 "anyOf": [
5199 {
6190 "format": "uuid4",
7199 "type": "string"
8199 },
9523 {
10523 "type": "null"
11523 }
12244 ],
13244 },
14234 "id": {
15234 "anyOf": [
16216 {
17210 "format": "uuid4",
18216 "type": "string"
19216 },
20225 {
21225 "type": "null"
22225 }
23234 ],
24234 },
25285 "name": {
26285 "type": "string"
27285 },
28285 "slug": {
29285 "type": "string"
30285 }
311618 },
32322 "required": [
33331 "name",
34331 "slug"
35322 ],
36347 "type": "object"
371427}
RecipeTool14 of 16 keywords
110746{
211929 "properties": {
3874 "groupId": {
4874 "anyOf": [
54744 {
6470 "format": "uuid4",
74744 "type": "string"
84744 },
94051 {
104051 "type": "null"
114051 }
12874 ],
13874 },
148210 "householdsWithTool": {
15825 "items": {
165185 "type": "string"
17825 },
18875 "type": "array"
198210 },
201335 "id": {
211330 "format": "uuid4",
221335 "type": "string"
231335 },
241425 "name": {
251425 "type": "string"
261425 },
271425 "slug": {
281425 "type": "string"
291425 }
3011929 },
3113612 "required": [
3213810 "id",
331471 "name",
341471 "slug"
3513612 ],
361485 "type": "object"
3710746}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
17925{
28118 "properties": {
3935 "admin": {
4935 "type": "boolean"
5935 },
6704 "fullName": {
7704 "anyOf": [
81163 {
91163 "type": "string"
101163 },
115915 {
125915 "type": "null"
135915 }
14704 ],
15704 },
16935 "id": {
17930 "format": "uuid4",
18935 "type": "string"
19935 },
20724 "username": {
21724 "anyOf": [
221165 {
231165 "type": "string"
241165 },
256115 {
266115 "type": "null"
276115 }
28724 ],
29724 }
308118 },
31972 "required": [
32981 "id",
33981 "admin"
34972 ],
35995 "type": "object"
367925}
Responses
codedescriptionhitsavg
200Successful Response248130ms
422Validation Error7113ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4198ms
500Internal Server Error4444ms
400Bad Request2112ms
Examples
Body: application/json
[]Recipe-Input.assets
[]Recipe-Input.comments
""Recipe-Input.description
{}Recipe-Input.extras
[]Recipe-Input.notes
[]Recipe-Input.recipeCategory
[]Recipe-Input.recipeIngredient
""RecipeIngredient-Input.display
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""RecipeIngredient-Input.note
0RecipeIngredient-Input.quantity
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
[]RecipeStep.ingredientReferences
""RecipeStep.summary
""RecipeStep.title
[]Recipe-Input.recipeInstructions
0Recipe-Input.recipeServings
0Recipe-Input.recipeYieldQuantity
trueRecipeSettings.disableComments
falseRecipeSettings.landscapeView
falseRecipeSettings.locked
falseRecipeSettings.public
falseRecipeSettings.showAssets
falseRecipeSettings.showNutrition
""Recipe-Input.slug
[]Recipe-Input.tags
[]Recipe-Input.tools
[]RecipeTool.householdsWithTool
Path Parameters
slug1 / 1
#validinvalidschema
11446n/a{
21446n/a "type": "string"
31446n/a}
Headers
accept-language3 / 3
11147n/a{
21147n/a "anyOf": [
31112n/a {
41112n/a "type": "string"
51112n/a },
6351112 {
7351112 "type": "null"
8351112 }
91147n/a ],
101147n/a}
Body
application/json372 / 407
Recipe-Input
1471767{
2390758 "properties": {
399227 "assets": {
499227 "anyOf": [
598039 {
698023 "items": {
898023 },
9100316 "type": "array"
1098039 },
11121007 {
12121007 "type": "null"
13121007 }
1499227 ],
1599227 },
1695580 "comments": {
1795580 "anyOf": [
1894194 {
1994175 "items": {
2194175 },
22101619 "type": "array"
2394194 },
24141021 {
25141021 "type": "null"
26141021 }
2795580 ],
2895580 },
2910124 "cookTime": {
3010124 "anyOf": [
3119997 {
3219997 "type": "string"
3319997 },
3499323 {
3599323 "type": "null"
3699323 }
3710124 ],
3810124 },
3910086 "createdAt": {
4010086 "anyOf": [
41100113 {
4210012 "format": "date-time",
43100311 "type": "string"
44100113 },
4571007 {
4671007 "type": "null"
4771007 }
4810086 ],
4910086 },
5010107 "dateAdded": {
5110107 "anyOf": [
52100512 {
5310052 "format": "date",
54100710 "type": "string"
55100512 },
5651012 {
5751012 "type": "null"
5851012 }
5910107 ],
6010107 },
6110106 "dateUpdated": {
6210106 "anyOf": [
63100610 {
6410062 "format": "date-time",
6510088 "type": "string"
66100610 },
6741012 {
6841012 "type": "null"
6941012 }
7010106 ],
7110106 },
7210224 "description": {
7310224 "anyOf": [
74101214 {
75101214 "type": "string"
76101214 },
77101016 {
78101016 "type": "null"
79101016 }
8010224 ],
8110224 },
8210124 "extras": {
8310124 "anyOf": [
84100016 {
851n/a "additionalProperties": true,
86100016 "type": "object"
87100016 },
88121004 {
89121004 "type": "null"
90121004 }
9110124 ],
9210124 },
9310055 "groupId": {
9410050 "format": "uuid4",
9510055 "type": "string"
9610055 },
9710055 "householdId": {
9810050 "format": "uuid4",
9910055 "type": "string"
10010055 },
1019964 "id": {
1029964 "anyOf": [
1039937 {
1049930 "format": "uuid4",
1059937 "type": "string"
1069937 },
1073997 {
1083997 "type": "null"
1093997 }
1109964 ],
1119964 },
112987n/a "image": {
113987n/a "anyOf": [
114987n/a {},
1159816 {
1169816 "type": "null"
1179816 }
118987n/a ],
119987n/a },
12010106 "lastMade": {
12110106 "anyOf": [
12210079 {
12310072 "format": "date-time",
12410097 "type": "string"
12510079 },
12631013 {
12731013 "type": "null"
12831013 }
12910106 ],
13010106 },
1319914 "name": {
1329914 "anyOf": [
13311984 {
13411984 "type": "string"
13511984 },
13698015 {
13798015 "type": "null"
13898015 }
1399914 ],
1409914 },
14197523 "notes": {
14297523 "anyOf": [
14396929 {
14496919 "items": {
14696919 },
14798810 "type": "array"
14896929 },
1496992 {
1506992 "type": "null"
1516992 }
15297523 ],
15397523 },
15494857 "nutrition": {
15594857 "anyOf": [
15639966 {
15839966 },
15990996 {
16090996 "type": "null"
16190996 }
16294857 ]
16394857 },
16410055 "orgURL": {
16510055 "anyOf": [
16661004 {
16761004 "type": "string"
16861004 },
16999911 {
17099911 "type": "null"
17199911 }
17210055 ],
17310055 },
1749925 "performTime": {
1759925 "anyOf": [
1766991 {
1776991 "type": "string"
1786991 },
17998611 {
18098611 "type": "null"
18198611 }
1829925 ],
1839925 },
1849924 "prepTime": {
1859924 "anyOf": [
18612984 {
18712984 "type": "string"
18812984 },
18998016 {
19098016 "type": "null"
19198016 }
1929924 ],
1939924 },
19410014 "rating": {
19510014 "anyOf": [
19618987 {
19718987 "type": "number"
19818987 },
19998322 {
20098322 "type": "null"
20198322 }
20210014 ],
20310014 },
20497034 "recipeCategory": {
20597034 "anyOf": [
20696143 {
20796128 "items": {
20996128 },
21098915 "type": "array"
21196143 },
2129995 {
2139995 "type": "null"
2149995 }
21597034 ],
21697034 },
217727287 "recipeIngredient": {
218727281 "items": {
220727281 },
22110086 "type": "array"
222727287 },
22394645 "recipeInstructions": {
22494645 "anyOf": [
22593952 {
22693940 "items": {
22893940 },
22997912 "type": "array"
23093952 },
2317984 {
2327984 "type": "null"
2337984 }
23494645 ],
23594645 },
2369905 "recipeServings": {
2379905 "type": "number"
2389905 },
23910025 "recipeYield": {
24010025 "anyOf": [
24123984 {
24223984 "type": "string"
24323984 },
24497928 {
24597928 "type": "null"
24697928 }
24710025 ],
24810025 },
2499885 "recipeYieldQuantity": {
2509885 "type": "number"
2519885 },
25295234 "settings": {
25395234 "anyOf": [
25422964 {
25622964 },
25793056 {
25893056 "type": "null"
25993056 }
26095234 ]
26195234 },
2629985 "slug": {
2639985 "type": "string"
2649985 },
26595931 "tags": {
26695931 "anyOf": [
26795535 {
26895526 "items": {
27095526 },
2719819 "type": "array"
27295535 },
2734986 {
2744986 "type": "null"
2754986 }
27695931 ],
27795931 },
27894143 "tools": {
27994138 "items": {
28194138 },
2829795 "type": "array"
28394143 },
2849794 "totalTime": {
2859794 "anyOf": [
28610973 {
28710973 "type": "string"
28810973 },
28996914 {
29096914 "type": "null"
29196914 }
2929794 ],
2939794 },
2949746 "update_at": {
2959746 "anyOf": [
29696713 {
2979672 "format": "date-time",
29896911 "type": "string"
29996713 },
3007973 {
3017973 "type": "null"
3027973 }
3039746 ],
3049746 },
3059995 "userId": {
3069990 "format": "uuid4",
3079995 "type": "string"
3089995 }
309390758 },
31012299 "type": "object"
311471767}
Referenced Components (21)354 of 391 keywords
CreateIngredientFood28 of 30 keywords
175350{
277109 "properties": {
312034 "aliases": {
412022 "items": {
612022 },
714212 "type": "array"
812034 },
913610 "description": {
1013610 "type": "string"
1113610 },
121428 "extras": {
131428 "anyOf": [
1413218 {
151n/a "additionalProperties": true,
1613218 "type": "object"
1713218 },
1810140 {
1910140 "type": "null"
2010140 }
211428 ],
221428 },
2312420 "householdsWithIngredientFood": {
2412410 "items": {
257310 "type": "string"
2612410 },
2713410 "type": "array"
2812420 },
291568 "id": {
301568 "anyOf": [
3115410 {
321540 "format": "uuid4",
3315410 "type": "string"
3415410 },
352162 {
362162 "type": "null"
372162 }
381568 ],
391568 },
401388 "labelId": {
411388 "anyOf": [
4212422 {
431240 "format": "uuid4",
4412422 "type": "string"
4512422 },
4614132 {
4714132 "type": "null"
4814132 }
491388 ],
501388 },
5117113 "name": {
5217113 "type": "string"
5317113 },
541328 "pluralName": {
551328 "anyOf": [
567133 {
577133 "type": "string"
587133 },
5912515 {
6012515 "type": "null"
6112515 }
621328 ],
631328 }
6477109 },
651843 "required": [
661843 "name"
671843 ],
68187238 "type": "object"
6975350}
CreateIngredientFoodAlias6 of 6 keywords
17422{
27410 "properties": {
37410 "name": {
47410 "type": "string"
57410 }
67410 },
7842 "required": [
8842 "name"
9842 ],
108610 "type": "object"
117422}
CreateIngredientUnit29 of 30 keywords
189346{
291129 "properties": {
317210 "abbreviation": {
417210 "type": "string"
517210 },
615232 "aliases": {
715222 "items": {
915222 },
1017410 "type": "array"
1115232 },
1216818 "description": {
1316818 "type": "string"
1416818 },
151748 "extras": {
161748 "anyOf": [
1715131 {
181n/a "additionalProperties": true,
1915131 "type": "object"
2015131 },
2123159 {
2223159 "type": "null"
2323159 }
241748 ],
251748 },
2616810 "fraction": {
2716810 "type": "boolean"
2816810 },
291958 "id": {
301958 "anyOf": [
3119310 {
321930 "format": "uuid4",
3319310 "type": "string"
3419310 },
352201 {
362201 "type": "null"
372201 }
381958 ],
391958 },
4020117 "name": {
4120117 "type": "string"
4220117 },
431648 "pluralAbbreviation": {
441648 "anyOf": [
4514131 {
4614131 "type": "string"
4714131 },
4823149 {
4923149 "type": "null"
5023149 }
511648 ],
521648 },
531688 "pluralName": {
541688 "anyOf": [
5511165 {
5611165 "type": "string"
5711165 },
5815719 {
5915719 "type": "null"
6015719 }
611688 ],
621688 },
6315910 "useAbbreviation": {
6415910 "type": "boolean"
6515910 }
6691129 },
672183 "required": [
682183 "name"
692183 ],
70221214 "type": "object"
7189346}
CreateIngredientUnitAlias6 of 6 keywords
115022{
215010 "properties": {
315010 "name": {
415010 "type": "string"
515010 }
615010 },
71602 "required": [
81602 "name"
91602 ],
1016210 "type": "object"
1115022}
IngredientFood-Input31 of 41 keywords
153372{
275111 "properties": {
312034 "aliases": {
412022 "items": {
612022 },
714212 "type": "array"
812034 },
9840 "createdAt": {
10840 "anyOf": [
11777 {
12770 "format": "date-time",
13777 "type": "string"
14777 },
15777 {
16777 "type": "null"
17777 }
18840 ],
19840 },
2013610 "description": {
2113610 "type": "string"
2213610 },
231428 "extras": {
241428 "anyOf": [
2513218 {
261n/a "additionalProperties": true,
2713218 "type": "object"
2813218 },
2910140 {
3010140 "type": "null"
3110140 }
321428 ],
331428 },
3412420 "householdsWithIngredientFood": {
3512410 "items": {
367310 "type": "string"
3712410 },
3813410 "type": "array"
3912420 },
4015410 "id": {
411540 "format": "uuid4",
4215410 "type": "string"
4315410 },
44770 "label": {
45770 "anyOf": [
46869 {
48869 },
49698 {
50698 "type": "null"
51698 }
52770 ]
53770 },
541388 "labelId": {
551388 "anyOf": [
5612422 {
571240 "format": "uuid4",
5812422 "type": "string"
5912422 },
6014132 {
6114132 "type": "null"
6214132 }
631388 ],
641388 },
6517113 "name": {
6617113 "type": "string"
6717113 },
681328 "pluralName": {
691328 "anyOf": [
707133 {
717133 "type": "string"
727133 },
7312515 {
7412515 "type": "null"
7512515 }
761328 ],
771328 },
78770 "update_at": {
79770 "anyOf": [
80725 {
81720 "format": "date-time",
82725 "type": "string"
83725 },
84572 {
85572 "type": "null"
86572 }
87770 ],
88770 }
8975111 },
9016225 "required": [
9116423 "id",
921843 "name"
9316225 ],
94187238 "type": "object"
9553372}
IngredientFoodAlias6 of 6 keywords
17422{
27410 "properties": {
37410 "name": {
47410 "type": "string"
57410 }
67410 },
7842 "required": [
8842 "name"
9842 ],
108610 "type": "object"
117422}
IngredientReferences7 of 8 keywords
1399{
2194 "properties": {
3194 "referenceId": {
4194 "anyOf": [
51211 {
6120 "format": "uuid4",
71211 "type": "string"
81211 },
9716 {
10716 "type": "null"
11716 }
12194 ],
13194 }
14194 },
15435 "type": "object"
16399}
IngredientUnit-Input33 of 37 keywords
164371{
283137 "properties": {
317210 "abbreviation": {
417210 "type": "string"
517210 },
615232 "aliases": {
715222 "items": {
915222 },
1017410 "type": "array"
1115232 },
12996 "createdAt": {
13996 "anyOf": [
148718 {
15872 "format": "date-time",
168916 "type": "string"
178718 },
181293 {
191293 "type": "null"
201293 }
21996 ],
22996 },
2316818 "description": {
2416818 "type": "string"
2516818 },
261748 "extras": {
271748 "anyOf": [
2815131 {
291n/a "additionalProperties": true,
3015131 "type": "object"
3115131 },
3223159 {
3323159 "type": "null"
3423159 }
351748 ],
361748 },
3716810 "fraction": {
3816810 "type": "boolean"
3916810 },
4019310 "id": {
411930 "format": "uuid4",
4219310 "type": "string"
4319310 },
4420117 "name": {
4520117 "type": "string"
4620117 },
471648 "pluralAbbreviation": {
481648 "anyOf": [
4914131 {
5014131 "type": "string"
5114131 },
5223149 {
5323149 "type": "null"
5423149 }
551648 ],
561648 },
571688 "pluralName": {
581688 "anyOf": [
5911165 {
6011165 "type": "string"
6111165 },
6215719 {
6315719 "type": "null"
6415719 }
651688 ],
661688 },
67970 "update_at": {
68970 "anyOf": [
697819 {
70780 "format": "date-time",
717819 "type": "string"
727819 },
731978 {
741978 "type": "null"
751978 }
76970 ],
77970 },
7815910 "useAbbreviation": {
7915910 "type": "boolean"
8015910 }
8183137 },
8220120 "required": [
8320318 "id",
842183 "name"
8520120 ],
86221214 "type": "object"
8764371}
IngredientUnitAlias6 of 6 keywords
115022{
215010 "properties": {
315010 "name": {
415010 "type": "string"
515010 }
615010 },
71602 "required": [
81602 "name"
91602 ],
1016210 "type": "object"
1115022}
MultiPurposeLabelSummary1 of 11 keywords
1869{
280 "properties": {
360 "color": {
460 "type": "string"
560 },
680 "groupId": {
780 "format": "uuid4",
880 "type": "string"
980 },
1080 "id": {
1180 "format": "uuid4",
1280 "type": "string"
1380 },
1480 "name": {
1580 "type": "string"
1680 }
1780 },
1880 "required": [
1980 "name",
2080 "groupId",
2180 "id"
2280 ],
23869 "type": "object"
24869}
Nutrition47 of 47 keywords
139966{
23453 "properties": {
3654 "calories": {
4654 "anyOf": [
5168 {
6168 "type": "string"
7168 },
8645 {
9645 "type": "null"
10645 }
11654 ],
12654 },
13644 "carbohydrateContent": {
14644 "anyOf": [
15365 {
16365 "type": "string"
17365 },
18617 {
19617 "type": "null"
20617 }
21644 ],
22644 },
23634 "cholesterolContent": {
24634 "anyOf": [
25166 {
26166 "type": "string"
27166 },
28625 {
29625 "type": "null"
30625 }
31634 ],
32634 },
33619 "fatContent": {
34619 "anyOf": [
35268 {
36268 "type": "string"
37268 },
385911 {
395911 "type": "null"
405911 }
41619 ],
42619 },
43625 "fiberContent": {
44625 "anyOf": [
45166 {
46166 "type": "string"
47166 },
48616 {
49616 "type": "null"
50616 }
51625 ],
52625 },
53614 "proteinContent": {
54614 "anyOf": [
55263 {
56263 "type": "string"
57263 },
58596 {
59596 "type": "null"
60596 }
61614 ],
62614 },
635812 "saturatedFatContent": {
645812 "anyOf": [
65268 {
66268 "type": "string"
67268 },
685614 {
695614 "type": "null"
705614 }
715812 ],
725812 },
73584 "sodiumContent": {
74584 "anyOf": [
75260 {
76260 "type": "string"
77260 },
78566 {
79566 "type": "null"
80566 }
81584 ],
82584 },
83574 "sugarContent": {
84574 "anyOf": [
85259 {
86259 "type": "string"
87259 },
88556 {
89556 "type": "null"
90556 }
91574 ],
92574 },
93564 "transFatContent": {
94564 "anyOf": [
95357 {
96357 "type": "string"
97357 },
98537 {
99537 "type": "null"
100537 }
101564 ],
102564 },
103544 "unsaturatedFatContent": {
104544 "anyOf": [
105157 {
106157 "type": "string"
107157 },
108535 {
109535 "type": "null"
110535 }
111544 ],
112544 }
1133453 },
11492913 "type": "object"
11539966}
RecipeAsset11 of 11 keywords
12325{
22516 "properties": {
3184 "fileName": {
4184 "anyOf": [
5418 {
6418 "type": "string"
7418 },
8148 {
9148 "type": "null"
10148 }
11184 ],
12184 },
13355 "icon": {
14355 "type": "string"
15355 },
16337 "name": {
17337 "type": "string"
18337 }
192516 },
20392 "required": [
21401 "name",
22401 "icon"
23392 ],
24417 "type": "object"
252325}
RecipeCategory16 of 17 keywords
16750{
26941 "properties": {
36116 "groupId": {
46116 "anyOf": [
54037 {
64012 "format": "uuid4",
75225 "type": "string"
84037 },
92156 {
102156 "type": "null"
112156 }
126116 ],
136116 },
145415 "id": {
155415 "anyOf": [
163732 {
17370 "format": "uuid4",
183732 "type": "string"
193732 },
201752 {
211752 "type": "null"
221752 }
235415 ],
245415 },
251045 "name": {
261045 "type": "string"
271045 },
281045 "slug": {
291045 "type": "string"
301045 }
316941 },
321082 "required": [
331091 "name",
341091 "slug"
351082 ],
361107 "type": "object"
376750}
RecipeCommentOut-Input14 of 17 keywords
19585{
210271 "properties": {
31666 "createdAt": {
41661 "format": "date-time",
51675 "type": "string"
61666 },
71675 "id": {
81670 "format": "uuid4",
91675 "type": "string"
101675 },
111675 "recipeId": {
121670 "format": "uuid4",
131675 "type": "string"
141675 },
151675 "text": {
161675 "type": "string"
171675 },
181666 "update_at": {
191661 "format": "date-time",
201675 "type": "string"
211666 },
2213339 "user": {
2413339 },
251675 "userId": {
261670 "format": "uuid4",
271675 "type": "string"
281675 }
2910271 },
301667 "required": [
311721 "recipeId",
321721 "text",
331721 "id",
341721 "createdAt",
351721 "update_at",
361721 "userId",
371721 "user"
381667 ],
391737 "type": "object"
409585}
RecipeIngredient-Input32 of 32 keywords
1198295{
2184290 "properties": {
34235 "display": {
44235 "type": "string"
54235 },
6309116 "food": {
7309116 "anyOf": [
853372 {
1053372 },
1175350 {
1375350 },
14234191 {
15234191 "type": "null"
16234191 }
17309116 ],
18309116 },
1941213 "note": {
2041213 "anyOf": [
2138243 {
2238243 "type": "string"
2338243 },
2430395 {
2530395 "type": "null"
2630395 }
2741213 ],
2841213 },
294174 "originalText": {
304174 "anyOf": [
3124397 {
3224397 "type": "string"
3324397 },
3439328 {
3539328 "type": "null"
3639328 }
374174 ],
384174 },
394214 "quantity": {
404214 "anyOf": [
4139530 {
4239530 "type": "number"
4339530 },
4426399 {
4526399 "type": "null"
4626399 }
474214 ],
484214 },
494148 "referenceId": {
504143 "format": "uuid",
514175 "type": "string"
524148 },
534274 "title": {
544274 "anyOf": [
5541390 {
5641390 "type": "string"
5741390 },
5838645 {
5938645 "type": "null"
6038645 }
614274 ],
624274 },
63299136 "unit": {
64299136 "anyOf": [
6564371 {
6764371 },
6889346 {
7089346 },
71210225 {
72210225 "type": "null"
73210225 }
74299136 ],
75299136 }
76184290 },
774885 "type": "object"
78198295}
RecipeNote7 of 7 keywords
12325{
23110 "properties": {
3295 "text": {
4295 "type": "string"
5295 },
6355 "title": {
7355 "type": "string"
8355 }
93110 },
10338 "required": [
11401 "title",
12347 "text"
13338 ],
14417 "type": "object"
152325}
RecipeSettings9 of 9 keywords
122964{
22130 "properties": {
3415 "disableComments": {
4415 "type": "boolean"
5415 },
6415 "landscapeView": {
7415 "type": "boolean"
8415 },
9405 "locked": {
10405 "type": "boolean"
11405 },
12395 "public": {
13395 "type": "boolean"
14395 },
15375 "showAssets": {
16375 "type": "boolean"
17375 },
18355 "showNutrition": {
19355 "type": "boolean"
20355 }
212130 },
2252934 "type": "object"
2322964}
RecipeStep21 of 21 keywords
13541{
23633 "properties": {
3476 "id": {
4476 "anyOf": [
53914 {
6392 "format": "uuid",
74112 "type": "string"
83914 },
9845 {
10845 "type": "null"
11845 }
12476 ],
13476 },
144014 "ingredientReferences": {
15409 "items": {
17409 },
18495 "type": "array"
194014 },
20504 "summary": {
21504 "anyOf": [
224311 {
234311 "type": "string"
244311 },
25747 {
26747 "type": "null"
27747 }
28504 ],
29504 },
30635 "text": {
31635 "type": "string"
32635 },
33454 "title": {
34454 "anyOf": [
35418 {
36418 "type": "string"
37418 },
38445 {
39445 "type": "null"
40445 }
41454 ],
42454 }
433633 },
44681 "required": [
45681 "text"
46681 ],
47697 "type": "object"
483541}
RecipeTag15 of 17 keywords
16227{
26418 "properties": {
3444 "groupId": {
4444 "anyOf": [
53315 {
6330 "format": "uuid4",
73315 "type": "string"
83315 },
91137 {
101137 "type": "null"
111137 }
12444 ],
13444 },
14384 "id": {
15384 "anyOf": [
16339 {
17330 "format": "uuid4",
18339 "type": "string"
19339 },
20537 {
21537 "type": "null"
22537 }
23384 ],
24384 },
25765 "name": {
26765 "type": "string"
27765 },
28765 "slug": {
29765 "type": "string"
30765 }
316418 },
32802 "required": [
33811 "name",
34811 "slug"
35802 ],
36827 "type": "object"
376227}
RecipeTool14 of 16 keywords
19338{
29729 "properties": {
3694 "groupId": {
4694 "anyOf": [
55716 {
6570 "format": "uuid4",
75716 "type": "string"
85716 },
91261 {
101261 "type": "null"
111261 }
12694 ],
13694 },
145410 "householdsWithTool": {
15545 "items": {
162005 "type": "string"
17545 },
18595 "type": "array"
195410 },
201195 "id": {
211190 "format": "uuid4",
221195 "type": "string"
231195 },
241205 "name": {
251205 "type": "string"
261205 },
271205 "slug": {
281205 "type": "string"
291205 }
309729 },
311224 "required": [
321242 "id",
331251 "name",
341251 "slug"
351224 ],
361265 "type": "object"
379338}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
113339{
214918 "properties": {
31615 "admin": {
41615 "type": "boolean"
51615 },
6914 "fullName": {
7914 "anyOf": [
81481 {
91481 "type": "string"
101481 },
117718 {
127718 "type": "null"
137718 }
14914 ],
15914 },
161475 "id": {
171470 "format": "uuid4",
181475 "type": "string"
191475 },
20934 "username": {
21934 "anyOf": [
221483 {
231483 "type": "string"
241483 },
257918 {
267918 "type": "null"
277918 }
28934 ],
29934 }
3014918 },
3115116 "required": [
3215215 "id",
331661 "admin"
3415116 ],
351675 "type": "object"
3613339}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error7753ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4229ms
500Internal Server Error14461ms
400Bad Request1054ms
Examples
Body: application/json
[]Recipe-Input.assets
[]Recipe-Input.comments
""Recipe-Input.description
{}Recipe-Input.extras
[]Recipe-Input.notes
[]Recipe-Input.recipeCategory
[]Recipe-Input.recipeIngredient
""RecipeIngredient-Input.display
[]IngredientFood-Input.aliases
""IngredientFood-Input.description
{}IngredientFood-Input.extras
[]IngredientFood-Input.householdsWithIngredientFood
"#959595"MultiPurposeLabelSummary.color
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
""RecipeIngredient-Input.note
0RecipeIngredient-Input.quantity
""IngredientUnit-Input.abbreviation
[]IngredientUnit-Input.aliases
""IngredientUnit-Input.description
{}IngredientUnit-Input.extras
trueIngredientUnit-Input.fraction
""IngredientUnit-Input.pluralAbbreviation
falseIngredientUnit-Input.useAbbreviation
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
[]RecipeStep.ingredientReferences
""RecipeStep.summary
""RecipeStep.title
[]Recipe-Input.recipeInstructions
0Recipe-Input.recipeServings
0Recipe-Input.recipeYieldQuantity
trueRecipeSettings.disableComments
falseRecipeSettings.landscapeView
falseRecipeSettings.locked
falseRecipeSettings.public
falseRecipeSettings.showAssets
falseRecipeSettings.showNutrition
""Recipe-Input.slug
[]Recipe-Input.tags
[]Recipe-Input.tools
[]RecipeTool.householdsWithTool
Path Parameters
slug1 / 1
#validinvalidschema
1431n/a{
2431n/a "type": "string"
3431n/a}
Headers
accept-language3 / 3
1239n/a{
2239n/a "anyOf": [
3167n/a {
4167n/a "type": "string"
5167n/a },
672167 {
772167 "type": "null"
872167 }
9239n/a ],
10239n/a}
Body
multipart/form-data8 / 8
Body_upload_recipe_asset_api_recipes__slug__assets_post
130664{
2363n/a "properties": {
3360n/a "extension": {
4360n/a "type": "string"
5360n/a },
6362n/a "file": {
7362n/a "format": "binary",
8362n/a "type": "string"
9362n/a },
10360n/a "icon": {
11360n/a "type": "string"
12360n/a },
13311n/a "name": {
14311n/a "type": "string"
15311n/a }
16363n/a },
1730664 "required": [
1831159 "name",
1936010 "icon",
2036010 "extension",
213628 "file"
2230664 ],
23370n/a "type": "object"
2430664}
Responses
codedescriptionhitsavg
200Successful Response20090ms
422Validation Error7814ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request13614ms
500Internal Server Error1769ms
Path Parameters
slug1 / 1
#validinvalidschema
1654n/a{
2654n/a "type": "string"
3654n/a}
Headers
accept-language3 / 3
1265n/a{
2265n/a "anyOf": [
3178n/a {
4178n/a "type": "string"
5178n/a },
687178 {
787178 "type": "null"
887178 }
9265n/a ],
10265n/a}
Body
application/json5 / 5
RecipeDuplicate
145152{
211032 "properties": {
311032 "name": {
411032 "anyOf": [
59448 {
69448 "type": "string"
79448 },
816126 {
916126 "type": "null"
1016126 }
1111032 ],
1211032 }
1311032 },
1448320 "type": "object"
1545152}
Responses
codedescriptionhitsavg
201Successful Response31391ms
422Validation Error1914ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4737ms
400Bad Request10352ms
Path Parameters
slug1 / 1
#validinvalidschema
1375n/a{
2375n/a "type": "string"
3375n/a}
Headers
accept-language3 / 3
1110n/a{
2110n/a "anyOf": [
378n/a {
478n/a "type": "string"
578n/a },
63278 {
73278 "type": "null"
83278 }
9110n/a ],
10110n/a}
Body
application/json5 / 5
ScrapeRecipe
129234{
229413 "properties": {
31148 "includeTags": {
41148 "type": "boolean"
51148 },
62996 "url": {
72996 "type": "string"
82996 }
929413 },
1030516 "required": [
1130516 "url"
1230516 ],
133215 "type": "object"
1429234}
Responses
codedescriptionhitsavg
200Successful Response19990ms
422Validation Error774ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1813ms
500Internal Server Error6418ms
400Bad Request17303ms
Examples
Body: application/json
{ "includeTags": true, "url": "https://myfavoriterecipes.com/recipes" }ScrapeRecipe
falseScrapeRecipe.includeTags
Path Parameters
slug1 / 1
#validinvalidschema
1387n/a{
2387n/a "type": "string"
3387n/a}
Headers
accept-language3 / 3
1205n/a{
2205n/a "anyOf": [
3127n/a {
4127n/a "type": "string"
5127n/a },
678127 {
778127 "type": "null"
878127 }
9205n/a ],
10205n/a}
Body
multipart/form-data6 / 6
Body_update_recipe_image_api_recipes__slug__image_put
123979{
2311n/a "properties": {
3293n/a "extension": {
4293n/a "type": "string"
5293n/a },
6257n/a "image": {
7257n/a "format": "binary",
8257n/a "type": "string"
9257n/a }
10311n/a },
1123979 "required": [
1225761 "image",
1329325 "extension"
1423979 ],
15318n/a "type": "object"
1623979}
Responses
codedescriptionhitsavg
200Successful Response17691ms
422Validation Error9612ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3742ms
400Bad Request61ms
500Internal Server Error7258ms
Path Parameters
slug1 / 1
#validinvalidschema
1395n/a{
2395n/a "type": "string"
3395n/a}
Headers
accept-language3 / 3
188n/a{
288n/a "anyOf": [
369n/a {
469n/a "type": "string"
569n/a },
61969 {
71969 "type": "null"
81969 }
988n/a ],
1088n/a}
Body
application/json5 / 5
RecipeLastMade
131248{
231220 "properties": {
331220 "timestamp": {
431210 "format": "date-time",
532210 "type": "string"
631220 }
731220 },
833220 "required": [
933220 "timestamp"
1033220 ],
113528 "type": "object"
1231248}
Responses
codedescriptionhitsavg
200Successful Response250123ms
422Validation Error757ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6448ms
400Bad Request61ms
Recipe: Exports 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1475n/a{
2475n/a "anyOf": [
3311n/a {
4311n/a "type": "string"
5311n/a },
6164311 {
7164311 "type": "null"
8164311 }
9475n/a ],
10475n/a}
Responses
codedescriptionhitsavg
200Successful Response51712ms
422Validation Error0never seen
Path Parameters
slug1 / 1
#validinvalidschema
1429n/a{
2429n/a "type": "string"
3429n/a}
Query Parameters
template_name1 / 1
1428n/a{
2428n/a "type": "string"
3428n/a}
Headers
accept-language3 / 3
1191n/a{
2191n/a "anyOf": [
3121n/a {
4121n/a "type": "string"
5121n/a },
670121 {
770121 "type": "null"
870121 }
9191n/a ],
10191n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error13ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5720ms
500Internal Server Error37153ms
Path Parameters
slug1 / 1
#validinvalidschema
1512n/a{
2512n/a "type": "string"
3512n/a}
Headers
accept-language3 / 3
1277n/a{
2277n/a "anyOf": [
3184n/a {
4184n/a "type": "string"
5184n/a },
693184 {
793184 "type": "null"
893184 }
9277n/a ],
10277n/a}
Responses
codedescriptionhitsavg
200Successful Response51213ms
422Validation Error0never seen
Path Parameters
slug1 / 1
#validinvalidschema
1517n/a{
2517n/a "type": "string"
3517n/a}
Query Parameters
token1 / 1
1516n/a{
2516n/a "type": "string"
3516n/a}
Headers
accept-language3 / 3
1284n/a{
2284n/a "anyOf": [
3172n/a {
4172n/a "type": "string"
5172n/a },
6112172 {
7112172 "type": "null"
8112172 }
9284n/a ],
10284n/a}
Responses
codedescriptionhitsavg
200Successful Response230ms
422Validation Error13ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request26814ms
401Unauthorized24612ms
Recipe: Images and Assets 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found91ms
Path Parameters
recipe_id2 / 2
#validinvalidschema
161948{
261948 "format": "uuid4",
3667n/a "type": "string"
461948}
file_name1 / 1
1667n/a{
2667n/a "type": "string"
3667n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error481ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error6192ms
Path Parameters
recipe_id1 / 1
#validinvalidschema
1667n/a{
2667n/a "type": "string"
3667n/a}
timeline_event_id1 / 1
1667n/a{
2667n/a "type": "string"
3667n/a}
file_name2 / 2
ImageType
1384283{
2384283 "enum": [
3103n/a "original.webp",
452n/a "min-original.webp",
5229n/a "tiny-original.webp"
6384283 ],
7667n/a "type": "string"
8384283}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error2831ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3841ms
Path Parameters
recipe_id1 / 1
#validinvalidschema
1698n/a{
2698n/a "type": "string"
3698n/a}
file_name2 / 2
ImageType
1375323{
2375323 "enum": [
379n/a "original.webp",
436n/a "min-original.webp",
5260n/a "tiny-original.webp"
6375323 ],
7698n/a "type": "string"
8375323}
Responses
codedescriptionhitsavg
200Successful Response1901ms
422Validation Error3231ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1851ms
Path Parameters
user_id2 / 2
#validinvalidschema
16677{
26677 "format": "uuid4",
3674n/a "type": "string"
46677}
file_name1 / 1
1674n/a{
2674n/a "type": "string"
3674n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error71ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found6671ms
Recipe: Ingredient Parser 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1487n/a{
2487n/a "anyOf": [
3288n/a {
4288n/a "type": "string"
5288n/a },
6199288 {
7199288 "type": "null"
8199288 }
9487n/a ],
10487n/a}
Body
application/json7 / 7
IngredientRequest
1239211{
2259158 "properties": {
3263134 "ingredient": {
4263134 "type": "string"
5263134 },
6100111 "parser": {
8100111 }
9259158 },
1039743 "required": [
1139743 "ingredient"
1239743 ],
1344010 "type": "object"
14239211}
Referenced Components (1)3 of 3 keywords
RegisteredParser3 of 3 keywords
1100111{
2100111 "enum": [
357n/a "nlp",
422n/a "brute",
521n/a "openai"
6100111 ],
715853 "type": "string"
8100111}
Responses
codedescriptionhitsavg
200Successful Response21620ms
422Validation Error2618ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2311ms
400Bad Request191ms
Examples
Body: application/json
"nlp"IngredientRequest.parser
Headers
accept-language3 / 3
#validinvalidschema
1338n/a{
2338n/a "anyOf": [
3219n/a {
4219n/a "type": "string"
5219n/a },
6119219 {
7119219 "type": "null"
8119219 }
9338n/a ],
10338n/a}
Body
application/json8 / 8
IngredientsRequest
1255189{
2267137 "properties": {
3280112 "ingredients": {
428085 "items": {
51537259 "type": "string"
628085 },
736527 "type": "array"
8280112 },
991125 "parser": {
1191125 }
12267137 },
1339240 "required": [
1439240 "ingredients"
1539240 ],
1643212 "type": "object"
17255189}
Referenced Components (1)3 of 3 keywords
RegisteredParser3 of 3 keywords
191125{
291125 "enum": [
345n/a "nlp",
427n/a "brute",
519n/a "openai"
691125 ],
714274 "type": "string"
891125}
Responses
codedescriptionhitsavg
200Successful Response22721ms
422Validation Error2457ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2838ms
400Bad Request221ms
Examples
Body: application/json
"nlp"IngredientsRequest.parser
Recipe: Shared 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
token_id2 / 2
#validinvalidschema
1498153{
2498153 "format": "uuid4",
3651n/a "type": "string"
4498153}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1531ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4982ms
Recipe: Timeline 6 operations 4 covered 2 partial 0 uncovered 0 not measured 97% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1379n/a{
2379n/a "anyOf": [
3327n/a {
4327n/a "type": "string"
5327n/a },
652327 {
752327 "type": "null"
852327 }
9379n/a ],
10379n/a}
orderByNullPosition5 / 5
1133256{
2133256 "anyOf": [
3100289 {
5100289 },
633356 {
733356 "type": "null"
833356 }
9133256 ],
10133256}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1100289{
2100289 "enum": [
369n/a "first",
431n/a "last"
5100289 ],
6356n/a "type": "string"
7100289}
orderDirection2 / 2
OrderDirection
1223109{
2223109 "enum": [
3109n/a "asc",
4114n/a "desc"
5223109 ],
6332n/a "type": "string"
7223109}
queryFilter3 / 3
1230n/a{
2230n/a "anyOf": [
3177n/a {
4177n/a "type": "string"
5177n/a },
653177 {
753177 "type": "null"
853177 }
9230n/a ],
10230n/a}
paginationSeed3 / 3
1356n/a{
2356n/a "anyOf": [
3270n/a {
4270n/a "type": "string"
5270n/a },
686270 {
786270 "type": "null"
886270 }
9356n/a ],
10356n/a}
page1 / 1
121235{
221235 "type": "integer"
321235}
perPage1 / 1
120246{
220246 "type": "integer"
320246}
Headers
accept-language3 / 3
1546n/a{
2546n/a "anyOf": [
3362n/a {
4362n/a "type": "string"
5362n/a },
6184362 {
7184362 "type": "null"
8184362 }
9546n/a ],
10546n/a}
Responses
codedescriptionhitsavg
200Successful Response25317ms
422Validation Error35712ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1622ms
400Bad Request6015ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1382n/a{
2382n/a "anyOf": [
3272n/a {
4272n/a "type": "string"
5272n/a },
6110272 {
7110272 "type": "null"
8110272 }
9382n/a ],
10382n/a}
Body
application/json22 / 23
RecipeTimelineEventIn
1321113{
234485 "properties": {
318416 "eventMessage": {
418416 "anyOf": [
510595 {
610595 "type": "string"
710595 },
879121 {
979121 "type": "null"
1079121 }
1118416 ],
1218416 },
1340717 "eventType": {
1540717 },
1621817 "image": {
1721817 "anyOf": [
18117118 {
20117118 },
21101134 {
22101134 "type": "null"
23101134 }
2421817 ],
2521817 },
2639513 "recipeId": {
273950 "format": "uuid4",
2839513 "type": "string"
2939513 },
3041015 "subject": {
3141015 "type": "string"
3241015 },
3319913 "timestamp": {
341998 "format": "date-time",
352075 "type": "string"
3619913 },
3718621 "userId": {
3818621 "anyOf": [
3912978 {
401294 "format": "uuid4",
4113374 "type": "string"
4212978 },
4357150 {
4457150 "type": "null"
4557150 }
4618621 ],
4718621 }
4834485 },
4940623 "required": [
5040821 "recipeId",
514254 "subject",
524245 "eventType"
5340623 ],
544295 "type": "object"
55321113}
Referenced Components (2)6 of 6 keywords
TimelineEventImage3 of 3 keywords
1117118{
2117118 "enum": [
342n/a "has image",
475n/a "does not have image"
5117118 ],
6118117 "type": "string"
7117118}
TimelineEventType3 of 3 keywords
140717{
240717 "enum": [
3157n/a "system",
4173n/a "info",
577n/a "comment"
640717 ],
74195 "type": "string"
840717}
Responses
codedescriptionhitsavg
201Successful Response191ms
422Validation Error3714ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found32116ms
400Bad Request1681ms
Examples
Body: application/json
"does not have image"RecipeTimelineEventIn.image
"2026-10-19T14:56:25.566703Z"RecipeTimelineEventIn.timestamp
Path Parameters
item_id1 / 2
#validinvalidschema
1540{
2540 "format": "uuid4",
354n/a "type": "string"
4540}
Headers
accept-language3 / 3
137n/a{
237n/a "anyOf": [
325n/a {
425n/a "type": "string"
525n/a },
61225 {
71225 "type": "null"
81225 }
937n/a ],
1037n/a}
Responses
codedescriptionhitsavg
200Successful Response2470ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3014ms
Path Parameters
item_id2 / 2
#validinvalidschema
148819{
248819 "format": "uuid4",
3507n/a "type": "string"
448819}
Headers
accept-language3 / 3
1132n/a{
2132n/a "anyOf": [
382n/a {
482n/a "type": "string"
582n/a },
65082 {
75082 "type": "null"
85082 }
9132n/a ],
10132n/a}
Responses
codedescriptionhitsavg
200Successful Response43114ms
422Validation Error1916ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found5712ms
Path Parameters
item_id2 / 2
#validinvalidschema
141312{
241312 "format": "uuid4",
3425n/a "type": "string"
441312}
Headers
accept-language3 / 3
1138n/a{
2138n/a "anyOf": [
396n/a {
496n/a "type": "string"
596n/a },
64296 {
74296 "type": "null"
84296 }
9138n/a ],
10138n/a}
Body
application/json12 / 12
RecipeTimelineEventUpdate
130851{
231923 "properties": {
3588 "eventMessage": {
4588 "anyOf": [
53135 {
63135 "type": "string"
73135 },
82739 {
92739 "type": "null"
102739 }
11588 ],
12588 },
13596 "image": {
14596 "anyOf": [
152738 {
172738 },
183233 {
193233 "type": "null"
203233 }
21596 ]
22596 },
2332110 "subject": {
2432110 "type": "string"
2532110 }
2631923 },
2733123 "required": [
2833123 "subject"
2933123 ],
303545 "type": "object"
3130851}
Referenced Components (1)3 of 3 keywords
TimelineEventImage3 of 3 keywords
12738{
22738 "enum": [
313n/a "has image",
414n/a "does not have image"
52738 ],
62837 "type": "string"
72738}
Responses
codedescriptionhitsavg
200Successful Response27166ms
422Validation Error1066ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3112ms
400Bad Request171ms
Path Parameters
item_id2 / 2
#validinvalidschema
14633{
24633 "format": "uuid4",
3466n/a "type": "string"
44633}
Headers
accept-language3 / 3
1191n/a{
2191n/a "anyOf": [
3119n/a {
4119n/a "type": "string"
5119n/a },
672119 {
772119 "type": "null"
872119 }
9191n/a ],
10191n/a}
Body
multipart/form-data6 / 6
Body_update_event_image_api_recipes_timeline_events__item_id__image_put
126547{
2306n/a "properties": {
3303n/a "extension": {
4303n/a "type": "string"
5303n/a },
6268n/a "image": {
7268n/a "format": "binary",
8268n/a "type": "string"
9268n/a }
10306n/a },
1126547 "required": [
1226844 "image",
133039 "extension"
1426547 ],
15312n/a "type": "object"
1626547}
Responses
codedescriptionhitsavg
200Successful Response17828ms
422Validation Error5712ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2635ms
400Bad Request11ms
500Internal Server Error20418ms
Recipes: Foods 6 operations 5 covered 1 partial 0 uncovered 0 not measured 99% #
Query Parameters
search3 / 3
#validinvalidschema
1328n/a{
2328n/a "anyOf": [
3243n/a {
4243n/a "type": "string"
5243n/a },
685243 {
785243 "type": "null"
885243 }
9328n/a ],
10328n/a}
orderBy3 / 3
1358n/a{
2358n/a "anyOf": [
3252n/a {
4252n/a "type": "string"
5252n/a },
6106252 {
7106252 "type": "null"
8106252 }
9358n/a ],
10358n/a}
orderByNullPosition5 / 5
1119274{
2119274 "anyOf": [
3100293 {
5100293 },
619374 {
719374 "type": "null"
819374 }
9119274 ],
10119274}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1100293{
2100293 "enum": [
370n/a "first",
430n/a "last"
5100293 ],
6374n/a "type": "string"
7100293}
orderDirection2 / 2
OrderDirection
126831{
226831 "enum": [
3170n/a "asc",
498n/a "desc"
526831 ],
6299n/a "type": "string"
726831}
queryFilter3 / 3
1327n/a{
2327n/a "anyOf": [
3237n/a {
4237n/a "type": "string"
5237n/a },
690237 {
790237 "type": "null"
890237 }
9327n/a ],
10327n/a}
paginationSeed3 / 3
1388n/a{
2388n/a "anyOf": [
3290n/a {
4290n/a "type": "string"
5290n/a },
698290 {
798290 "type": "null"
898290 }
9388n/a ],
10388n/a}
page1 / 1
125930{
225930 "type": "integer"
325930}
perPage1 / 1
123274{
223274 "type": "integer"
323274}
Headers
accept-language3 / 3
1436n/a{
2436n/a "anyOf": [
3296n/a {
4296n/a "type": "string"
5296n/a },
6140296 {
7140296 "type": "null"
8140296 }
9436n/a ],
10436n/a}
Responses
codedescriptionhitsavg
200Successful Response28526ms
422Validation Error32514ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5313ms
500Internal Server Error1017ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1416n/a{
2416n/a "anyOf": [
3279n/a {
4279n/a "type": "string"
5279n/a },
6137279 {
7137279 "type": "null"
8137279 }
9416n/a ],
10416n/a}
Body
application/json27 / 28
CreateIngredientFood
1345169{
2366133 "properties": {
325076 "aliases": {
425071 "items": {
625071 },
73215 "type": "array"
825076 },
92318 "description": {
102318 "type": "string"
112318 },
1220412 "extras": {
1320412 "anyOf": [
1499117 {
151n/a "additionalProperties": true,
1699117 "type": "object"
1799117 },
18105111 {
19105111 "type": "null"
20105111 }
2120412 ],
2220412 },
2319411 "householdsWithIngredientFood": {
241945 "items": {
256095 "type": "string"
261945 },
271996 "type": "array"
2819411 },
2921427 "id": {
3021427 "anyOf": [
31140101 {
321403 "format": "uuid4",
3314398 "type": "string"
34140101 },
3574167 {
3674167 "type": "null"
3774167 }
3821427 ],
3921427 },
401558 "labelId": {
411558 "anyOf": [
4210657 {
431060 "format": "uuid4",
4410657 "type": "string"
4510657 },
4649114 {
4749114 "type": "null"
4849114 }
491558 ],
501558 },
5146711 "name": {
5246711 "type": "string"
5346711 },
5416413 "pluralName": {
5516413 "anyOf": [
568691 {
578691 "type": "string"
588691 },
597899 {
607899 "type": "null"
617899 }
6216413 ],
6316413 }
64366133 },
6547829 "required": [
6647829 "name"
6747829 ],
685077 "type": "object"
69345169}
Referenced Components (1)6 of 6 keywords
CreateIngredientFoodAlias6 of 6 keywords
1830201{
283027 "properties": {
383027 "name": {
483027 "type": "string"
583027 }
683027 },
7857162 "required": [
8857162 "name"
9857162 ],
10101912 "type": "object"
11830201}
Responses
codedescriptionhitsavg
201Successful Response11423ms
422Validation Error1946ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error412ms
400Bad Request24711ms
Examples
Body: application/json
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
Headers
accept-language3 / 3
#validinvalidschema
1209n/a{
2209n/a "anyOf": [
3150n/a {
4150n/a "type": "string"
5150n/a },
659150 {
759150 "type": "null"
859150 }
9209n/a ],
10209n/a}
Body
application/json7 / 7
MergeFood
115793{
219234 "properties": {
316728 "fromFood": {
416715 "format": "uuid4",
518213 "type": "string"
616728 },
719824 "toFood": {
819813 "format": "uuid4",
921111 "type": "string"
1019824 }
1119234 },
1219144 "required": [
1319540 "fromFood",
1422213 "toFood"
1519144 ],
1623515 "type": "object"
1715793}
Responses
codedescriptionhitsavg
200Successful Response131ms
422Validation Error2415ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error15617ms
400Bad Request1661ms
Path Parameters
item_id2 / 2
#validinvalidschema
1546{
2546 "format": "uuid4",
360n/a "type": "string"
4546}
Headers
accept-language3 / 3
127n/a{
227n/a "anyOf": [
316n/a {
416n/a "type": "string"
516n/a },
61116 {
71116 "type": "null"
81116 }
927n/a ],
1027n/a}
Responses
codedescriptionhitsavg
200Successful Response4239ms
422Validation Error611ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found128ms
Path Parameters
item_id2 / 2
#validinvalidschema
147733{
247733 "format": "uuid4",
3510n/a "type": "string"
447733}
Headers
accept-language3 / 3
1143n/a{
2143n/a "anyOf": [
392n/a {
492n/a "type": "string"
592n/a },
65192 {
75192 "type": "null"
85192 }
9143n/a ],
10143n/a}
Responses
codedescriptionhitsavg
200Successful Response38914ms
422Validation Error3313ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found8812ms
Path Parameters
item_id2 / 2
#validinvalidschema
153716{
253716 "format": "uuid4",
3553n/a "type": "string"
453716}
Headers
accept-language3 / 3
1370n/a{
2370n/a "anyOf": [
3247n/a {
4247n/a "type": "string"
5247n/a },
6123247 {
7123247 "type": "null"
8123247 }
9370n/a ],
10370n/a}
Body
application/json28 / 28
CreateIngredientFood
142093{
242476 "properties": {
320220 "aliases": {
420214 "items": {
620214 },
72166 "type": "array"
820220 },
91256 "description": {
101256 "type": "string"
111256 },
122557 "extras": {
132557 "anyOf": [
14145117 {
151n/a "additionalProperties": true,
16145117 "type": "object"
17145117 },
18110152 {
19110152 "type": "null"
20110152 }
212557 ],
222557 },
2324814 "householdsWithIngredientFood": {
242489 "items": {
2526331 "type": "string"
262489 },
272575 "type": "array"
2824814 },
2931218 "id": {
3031218 "anyOf": [
3126862 {
3226810 "format": "uuid4",
3327852 "type": "string"
3426862 },
3544286 {
3644286 "type": "null"
3744286 }
3831218 ],
3931218 },
402879 "labelId": {
412879 "anyOf": [
42135161 {
431351 "format": "uuid4",
44136160 "type": "string"
45135161 },
46152144 {
47152144 "type": "null"
48152144 }
492879 ],
502879 },
514915 "name": {
524915 "type": "string"
534915 },
5424710 "pluralName": {
5524710 "anyOf": [
5617879 {
5717879 "type": "string"
5817879 },
5969188 {
6069188 "type": "null"
6169188 }
6224710 ],
6324710 }
6442476 },
6549612 "required": [
6649612 "name"
6749612 ],
685085 "type": "object"
6942093}
Referenced Components (1)6 of 6 keywords
CreateIngredientFoodAlias6 of 6 keywords
173423{
27345 "properties": {
37345 "name": {
47345 "type": "string"
57345 }
67345 },
773913 "required": [
873913 "name"
973913 ],
107525 "type": "object"
1173423}
Responses
codedescriptionhitsavg
200Successful Response1458ms
422Validation Error1216ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found14711ms
500Internal Server Error411ms
400Bad Request26718ms
Examples
Body: application/json
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
Recipes: Units 6 operations 3 covered 3 partial 0 uncovered 0 not measured 97% #
Query Parameters
search3 / 3
#validinvalidschema
1306n/a{
2306n/a "anyOf": [
3225n/a {
4225n/a "type": "string"
5225n/a },
681225 {
781225 "type": "null"
881225 }
9306n/a ],
10306n/a}
orderBy3 / 3
1433n/a{
2433n/a "anyOf": [
3321n/a {
4321n/a "type": "string"
5321n/a },
6112321 {
7112321 "type": "null"
8112321 }
9433n/a ],
10433n/a}
orderByNullPosition5 / 5
1185241{
2185241 "anyOf": [
3122304 {
5122304 },
663363 {
763363 "type": "null"
863363 }
9185241 ],
10185241}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
1122304{
2122304 "enum": [
366n/a "first",
456n/a "last"
5122304 ],
6363n/a "type": "string"
7122304}
orderDirection2 / 2
OrderDirection
132559{
232559 "enum": [
3225n/a "asc",
4100n/a "desc"
532559 ],
6384n/a "type": "string"
732559}
queryFilter3 / 3
1374n/a{
2374n/a "anyOf": [
3270n/a {
4270n/a "type": "string"
5270n/a },
6104270 {
7104270 "type": "null"
8104270 }
9374n/a ],
10374n/a}
paginationSeed3 / 3
1341n/a{
2341n/a "anyOf": [
3299n/a {
4299n/a "type": "string"
5299n/a },
642299 {
742299 "type": "null"
842299 }
9341n/a ],
10341n/a}
page1 / 1
134432{
234432 "type": "integer"
334432}
perPage1 / 1
131339{
231339 "type": "integer"
331339}
Headers
accept-language3 / 3
1377n/a{
2377n/a "anyOf": [
3252n/a {
4252n/a "type": "string"
5252n/a },
6125252 {
7125252 "type": "null"
8125252 }
9377n/a ],
10377n/a}
Responses
codedescriptionhitsavg
200Successful Response26326ms
422Validation Error30813ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request6015ms
500Internal Server Error1115ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1457n/a{
2457n/a "anyOf": [
3329n/a {
4329n/a "type": "string"
5329n/a },
6128329 {
7128329 "type": "null"
8128329 }
9457n/a ],
10457n/a}
Body
application/json27 / 28
CreateIngredientUnit
1476146{
2488125 "properties": {
330213 "abbreviation": {
430213 "type": "string"
530213 },
627547 "aliases": {
727527 "items": {
927527 },
1030220 "type": "array"
1127547 },
122876 "description": {
132876 "type": "string"
142876 },
1533311 "extras": {
1633311 "anyOf": [
17158186 {
181n/a "additionalProperties": true,
19158186 "type": "object"
20158186 },
21175169 {
22175169 "type": "null"
23175169 }
2433311 ],
2533311 },
262848 "fraction": {
272848 "type": "boolean"
282848 },
2928812 "id": {
3028812 "anyOf": [
3121387 {
322130 "format": "uuid4",
3321387 "type": "string"
3421387 },
3575225 {
3675225 "type": "null"
3775225 }
3828812 ],
3928812 },
4058021 "name": {
4158021 "type": "string"
4258021 },
4323520 "pluralAbbreviation": {
4423520 "anyOf": [
4519956 {
4619956 "type": "string"
4719956 },
4836219 {
4936219 "type": "null"
5036219 }
5123520 ],
5223520 },
5328818 "pluralName": {
5428818 "anyOf": [
55176130 {
56176130 "type": "string"
57176130 },
58112194 {
59112194 "type": "null"
60112194 }
6128818 ],
6228818 },
632768 "useAbbreviation": {
642768 "type": "boolean"
652768 }
66488125 },
6760114 "required": [
6860114 "name"
6960114 ],
706157 "type": "object"
71476146}
Referenced Components (1)6 of 6 keywords
CreateIngredientUnitAlias6 of 6 keywords
1136552{
2136524 "properties": {
3136524 "name": {
4136524 "type": "string"
5136524 }
6136524 },
7138923 "required": [
8138923 "name"
9138923 ],
1014125 "type": "object"
11136552}
Responses
codedescriptionhitsavg
201Successful Response20538ms
422Validation Error2814ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request29511ms
500Internal Server Error24ms
Examples
Body: application/json
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Headers
accept-language3 / 3
#validinvalidschema
1238n/a{
2238n/a "anyOf": [
3175n/a {
4175n/a "type": "string"
5175n/a },
663175 {
763175 "type": "null"
863175 }
9238n/a ],
10238n/a}
Body
application/json7 / 7
MergeUnit
1154100{
219441 "properties": {
316831 "fromUnit": {
416814 "format": "uuid4",
518217 "type": "string"
616831 },
719833 "toUnit": {
819813 "format": "uuid4",
921120 "type": "string"
1019833 }
1119441 },
1219546 "required": [
1319942 "fromUnit",
1423110 "toUnit"
1519546 ],
1624113 "type": "object"
17154100}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error2478ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error15414ms
400Bad Request1601ms
Path Parameters
item_id1 / 2
#validinvalidschema
1510{
2510 "format": "uuid4",
351n/a "type": "string"
4510}
Headers
accept-language3 / 3
130n/a{
230n/a "anyOf": [
317n/a {
417n/a "type": "string"
517n/a },
61317 {
71317 "type": "null"
81317 }
930n/a ],
1030n/a}
Responses
codedescriptionhitsavg
200Successful Response3342ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1814ms
Path Parameters
item_id2 / 2
#validinvalidschema
150733{
250733 "format": "uuid4",
3540n/a "type": "string"
450733}
Headers
accept-language3 / 3
1145n/a{
2145n/a "anyOf": [
391n/a {
491n/a "type": "string"
591n/a },
65491 {
75491 "type": "null"
85491 }
9145n/a ],
10145n/a}
Responses
codedescriptionhitsavg
200Successful Response47313ms
422Validation Error3311ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3414ms
Path Parameters
item_id2 / 2
#validinvalidschema
15356{
25356 "format": "uuid4",
3541n/a "type": "string"
45356}
Headers
accept-language3 / 3
1290n/a{
2290n/a "anyOf": [
3207n/a {
4207n/a "type": "string"
5207n/a },
683207 {
783207 "type": "null"
883207 }
9290n/a ],
10290n/a}
Body
application/json27 / 28
CreateIngredientUnit
141494{
242181 "properties": {
31675 "abbreviation": {
41675 "type": "string"
51675 },
612922 "aliases": {
712917 "items": {
912917 },
101465 "type": "array"
1112922 },
121535 "description": {
131535 "type": "string"
141535 },
151489 "extras": {
161489 "anyOf": [
1711344 {
181n/a "additionalProperties": true,
1911344 "type": "object"
2011344 },
2135122 {
2235122 "type": "null"
2335122 }
241489 ],
251489 },
261455 "fraction": {
271455 "type": "boolean"
281455 },
291445 "id": {
301445 "anyOf": [
3111336 {
321130 "format": "uuid4",
3311336 "type": "string"
3411336 },
3531118 {
3631118 "type": "null"
3731118 }
381445 ],
391445 },
404887 "name": {
414887 "type": "string"
424887 },
431495 "pluralAbbreviation": {
441495 "anyOf": [
4513024 {
4613024 "type": "string"
4713024 },
4819135 {
4919135 "type": "null"
5019135 }
511495 ],
521495 },
531406 "pluralName": {
541406 "anyOf": [
556086 {
566086 "type": "string"
576086 },
588066 {
598066 "type": "null"
608066 }
611406 ],
621406 },
6313818 "useAbbreviation": {
6413818 "type": "boolean"
6513818 }
6642181 },
674958 "required": [
684958 "name"
694958 ],
705035 "type": "object"
7141494}
Referenced Components (1)6 of 6 keywords
CreateIngredientUnitAlias6 of 6 keywords
136327{
236312 "properties": {
336312 "name": {
436312 "type": "string"
536312 }
636312 },
737510 "required": [
837510 "name"
937510 ],
103855 "type": "object"
1136327}
Responses
codedescriptionhitsavg
200Successful Response19942ms
422Validation Error1035ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error713ms
404Not Found7414ms
400Bad Request15814ms
Examples
Body: application/json
""CreateIngredientUnit.abbreviation
[]CreateIngredientUnit.aliases
""CreateIngredientUnit.description
{}CreateIngredientUnit.extras
trueCreateIngredientUnit.fraction
""CreateIngredientUnit.pluralAbbreviation
falseCreateIngredientUnit.useAbbreviation
Shared: Recipes 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
recipe_id4 / 4
#validinvalidschema
1615218{
2615218 "anyOf": [
3472361 {
4472218 "format": "uuid4",
5690n/a "type": "string"
6472361 },
7143690 {
8143690 "type": "null"
9143690 }
10615218 ],
11615218}
Headers
accept-language3 / 3
1371n/a{
2371n/a "anyOf": [
3239n/a {
4239n/a "type": "string"
5239n/a },
6132239 {
7132239 "type": "null"
8132239 }
9371n/a ],
10371n/a}
Responses
codedescriptionhitsavg
200Successful Response52216ms
422Validation Error21812ms
Headers
accept-language3 / 3
#validinvalidschema
1359n/a{
2359n/a "anyOf": [
3227n/a {
4227n/a "type": "string"
5227n/a },
6132227 {
7132227 "type": "null"
8132227 }
9359n/a ],
10359n/a}
Body
application/json7 / 7
RecipeShareTokenCreate
130587{
232041 "properties": {
314131 "expiresAt": {
414117 "format": "date-time",
515814 "type": "string"
614131 },
731927 "recipeId": {
831916 "format": "uuid4",
933511 "type": "string"
1031927 }
1132041 },
1234640 "required": [
1334640 "recipeId"
1434640 ],
153866 "type": "object"
1630587}
Responses
codedescriptionhitsavg
201Successful Response13849ms
422Validation Error3174ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found16813ms
400Bad Request1311ms
Path Parameters
item_id2 / 2
#validinvalidschema
125014{
225014 "format": "uuid4",
3264n/a "type": "string"
425014}
Headers
accept-language3 / 3
1121n/a{
2121n/a "anyOf": [
373n/a {
473n/a "type": "string"
573n/a },
64873 {
74873 "type": "null"
84873 }
9121n/a ],
10121n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error1415ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found25021ms
Path Parameters
item_id2 / 2
#validinvalidschema
153635{
253635 "format": "uuid4",
3571n/a "type": "string"
453635}
Headers
accept-language3 / 3
1159n/a{
2159n/a "anyOf": [
3100n/a {
4100n/a "type": "string"
5100n/a },
659100 {
759100 "type": "null"
859100 }
9159n/a ],
10159n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error3513ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found53615ms
Users: Authentication 5 operations 3 covered 0 partial 2 uncovered 0 not measured 0% #
Headers
accept-languageno coverage data
#validinvalidschema
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error102ms
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error102ms
Responses
codedescriptionhitsavg
200Successful Response911ms
Body
application/x-www-form-urlencodedno coverage data
Body_get_token_api_auth_token_post
#validinvalidschema
100{
200 "properties": {
30n/a "password": {
40n/a "type": "string"
50n/a },
600 "remember_me": {
700 "type": "boolean"
800 },
90n/a "username": {
100n/a "type": "string"
110n/a }
1200 },
130n/a "type": "object"
1400}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Users: CRUD 6 operations 4 covered 0 partial 2 uncovered 0 not measured 24% #
Headers
accept-languageno coverage data
#validinvalidschema
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Body
application/jsonno coverage data
ChangePassword
100{
200 "properties": {
300 "currentPassword": {
400 "type": "string"
500 },
600 "newPassword": {
700 "minLength": 8,
800 "type": "string"
900 }
1000 },
1100 "required": [
1200 "newPassword"
1300 ],
1400 "type": "object"
1500}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1571n/a{
2571n/a "anyOf": [
3370n/a {
4370n/a "type": "string"
5370n/a },
6201370 {
7201370 "type": "null"
8201370 }
9571n/a ],
10571n/a}
Responses
codedescriptionhitsavg
200Successful Response77715ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1546n/a{
2546n/a "anyOf": [
3358n/a {
4358n/a "type": "string"
5358n/a },
6188358 {
7188358 "type": "null"
8188358 }
9546n/a ],
10546n/a}
Responses
codedescriptionhitsavg
200Successful Response67214ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1572n/a{
2572n/a "anyOf": [
3370n/a {
4370n/a "type": "string"
5370n/a },
6202370 {
7202370 "type": "null"
8202370 }
9572n/a ],
10572n/a}
Responses
codedescriptionhitsavg
200Successful Response73116ms
422Validation Error0never seen
Path Parameters
recipe_id2 / 2
#validinvalidschema
156533{
256533 "format": "uuid4",
3598n/a "type": "string"
456533}
Headers
accept-language3 / 3
1163n/a{
2163n/a "anyOf": [
3108n/a {
4108n/a "type": "string"
5108n/a },
655108 {
755108 "type": "null"
855108 }
9163n/a ],
10163n/a}
Responses
codedescriptionhitsavg
200Successful Response2113ms
422Validation Error3314ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found54413ms
Path Parameters
item_idno coverage data
#validinvalidschema
100{
200 "format": "uuid4",
30n/a "type": "string"
400}
Headers
accept-languageno coverage data
10n/a{
20n/a "anyOf": [
30n/a {
40n/a "type": "string"
50n/a },
600 {
700 "type": "null"
800 }
90n/a ],
100n/a}
Body
application/jsonno coverage data
mealie__schema__user__user__UserBase
100{
200 "properties": {
300 "admin": {
400 "type": "boolean"
500 },
600 "advanced": {
700 "type": "boolean"
800 },
900 "authMethod": {
1100 },
1200 "canInvite": {
1300 "type": "boolean"
1400 },
1500 "canManage": {
1600 "type": "boolean"
1700 },
1800 "canManageHousehold": {
1900 "type": "boolean"
2000 },
2100 "canOrganize": {
2200 "type": "boolean"
2300 },
2400 "email": {
2500 "type": "string"
2600 },
2700 "fullName": {
2800 "anyOf": [
2900 {
3000 "type": "string"
3100 },
3200 {
3300 "type": "null"
3400 }
3500 ],
3600 },
3700 "group": {
3800 "anyOf": [
3900 {
4000 "type": "string"
4100 },
4200 {
4300 "type": "null"
4400 }
4500 ],
4600 },
4700 "household": {
4800 "anyOf": [
4900 {
5000 "type": "string"
5100 },
5200 {
5300 "type": "null"
5400 }
5500 ],
5600 },
5700 "id": {
5800 "anyOf": [
5900 {
6000 "format": "uuid4",
6100 "type": "string"
6200 },
6300 {
6400 "type": "null"
6500 }
6600 ],
6700 },
6800 "username": {
6900 "anyOf": [
7000 {
7100 "type": "string"
7200 },
7300 {
7400 "type": "null"
7500 }
7600 ],
7700 }
7800 },
7900 "required": [
8000 "email"
8100 ],
8200 "type": "object"
8300}
Referenced Components (1)0 of 3 keywords
AuthMethod0 of 3 keywords
100{
200 "enum": [
30n/a "Mealie",
40n/a "LDAP",
50n/a "OIDC"
600 ],
700 "type": "string"
800}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Users: Images 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
id2 / 2
#validinvalidschema
151624{
251624 "format": "uuid4",
3540n/a "type": "string"
451624}
Headers
accept-language3 / 3
1157n/a{
2157n/a "anyOf": [
3101n/a {
4101n/a "type": "string"
5101n/a },
656101 {
756101 "type": "null"
856101 }
9157n/a ],
10157n/a}
Body
multipart/form-data5 / 5
Body_update_user_image_api_users__id__image_post
140155{
2401n/a "properties": {
3401n/a "profile": {
4401n/a "format": "binary",
5401n/a "type": "string"
6401n/a }
7401n/a },
840155 "required": [
940155 "profile"
1040155 ],
11456n/a "type": "object"
1240155}
Responses
codedescriptionhitsavg
200Successful Response13137ms
422Validation Error8412ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request51ms
403Forbidden42415ms
500Internal Server Error1416ms
Users: Passwords 2 operations 1 covered 0 partial 1 uncovered 0 not measured 50% #
Headers
accept-language3 / 3
#validinvalidschema
1584n/a{
2584n/a "anyOf": [
3338n/a {
4338n/a "type": "string"
5338n/a },
6246338 {
7246338 "type": "null"
8246338 }
9584n/a ],
10584n/a}
Body
application/json4 / 4
ForgotPassword
1241272{
2241146 "properties": {
3241146 "email": {
4241146 "type": "string"
5241146 }
6241146 },
7387102 "required": [
8387102 "email"
9387102 ],
1048924 "type": "object"
11241272}
Responses
codedescriptionhitsavg
200Successful Response24118ms
422Validation Error3122ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request151ms
Body
application/jsonno coverage data
ResetPassword
#validinvalidschema
100{
200 "properties": {
300 "email": {
400 "type": "string"
500 },
600 "password": {
700 "type": "string"
800 },
900 "passwordConfirm": {
1000 "type": "string"
1100 },
1200 "token": {
1300 "type": "string"
1400 }
1500 },
1600 "required": [
1700 "token",
1800 "email",
1900 "password",
2000 "passwordConfirm"
2100 ],
2200 "type": "object"
2300}
Expected Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Users: Ratings 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
id2 / 2
#validinvalidschema
152346{
252346 "format": "uuid4",
3569n/a "type": "string"
452346}
Headers
accept-language3 / 3
1137n/a{
2137n/a "anyOf": [
392n/a {
492n/a "type": "string"
592n/a },
64592 {
74592 "type": "null"
84592 }
9137n/a ],
10137n/a}
Responses
codedescriptionhitsavg
200Successful Response52314ms
422Validation Error4621ms
Path Parameters
id2 / 2
#validinvalidschema
161253{
261253 "format": "uuid4",
3665n/a "type": "string"
461253}
slug1 / 1
1665n/a{
2665n/a "type": "string"
3665n/a}
Headers
accept-language3 / 3
1223n/a{
2223n/a "anyOf": [
3135n/a {
4135n/a "type": "string"
5135n/a },
688135 {
788135 "type": "null"
888135 }
9223n/a ],
10223n/a}
Responses
codedescriptionhitsavg
200Successful Response1448ms
422Validation Error5321ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2613ms
403Forbidden57213ms
Path Parameters
id2 / 2
#validinvalidschema
160152{
260152 "format": "uuid4",
3653n/a "type": "string"
460152}
slug1 / 1
1653n/a{
2653n/a "type": "string"
3653n/a}
Headers
accept-language3 / 3
1253n/a{
2253n/a "anyOf": [
3161n/a {
4161n/a "type": "string"
5161n/a },
692161 {
792161 "type": "null"
892161 }
9253n/a ],
10253n/a}
Responses
codedescriptionhitsavg
200Successful Response835ms
422Validation Error5215ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1312ms
403Forbidden58013ms
Path Parameters
id2 / 2
#validinvalidschema
155237{
255237 "format": "uuid4",
3589n/a "type": "string"
455237}
Headers
accept-language3 / 3
1171n/a{
2171n/a "anyOf": [
3111n/a {
4111n/a "type": "string"
5111n/a },
660111 {
760111 "type": "null"
860111 }
9171n/a ],
10171n/a}
Responses
codedescriptionhitsavg
200Successful Response55213ms
422Validation Error3712ms
Path Parameters
id2 / 2
#validinvalidschema
155715{
255715 "format": "uuid4",
3572n/a "type": "string"
455715}
slug1 / 1
1572n/a{
2572n/a "type": "string"
3572n/a}
Headers
accept-language3 / 3
1176n/a{
2176n/a "anyOf": [
3134n/a {
4134n/a "type": "string"
5134n/a },
642134 {
742134 "type": "null"
842134 }
9176n/a ],
10176n/a}
Body
application/json8 / 8
UserRatingUpdate
146257{
29839 "properties": {
38118 "isFavorite": {
48118 "anyOf": [
53960 {
63960 "type": "boolean"
73960 },
84257 {
94257 "type": "null"
104257 }
118118 ],
128118 },
139129 "rating": {
149129 "anyOf": [
154674 {
164674 "type": "number"
174674 },
184575 {
194575 "type": "null"
204575 }
219129 ],
229129 }
239839 },
2450118 "type": "object"
2546257}
Responses
codedescriptionhitsavg
200Successful Response2431ms
422Validation Error887ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found114ms
403Forbidden43612ms
400Bad Request131ms
Users: Registration 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1444n/a{
2444n/a "anyOf": [
3310n/a {
4310n/a "type": "string"
5310n/a },
6134310 {
7134310 "type": "null"
8134310 }
9444n/a ],
10444n/a}
Body
application/json21 / 21
CreateUserRegistration
1335184{
2404107 "properties": {
32547 "advanced": {
42547 "type": "boolean"
52547 },
643611 "email": {
743611 "type": "string"
843611 },
948227 "fullName": {
1048227 "type": "string"
1148227 },
122659 "group": {
132659 "anyOf": [
14141133 {
15141133 "type": "string"
16141133 },
17124150 {
18124150 "type": "null"
19124150 }
202659 ],
212659 },
2226819 "groupToken": {
2326819 "anyOf": [
24100187 {
25100187 "type": "string"
26100187 },
27168119 {
28168119 "type": "null"
29168119 }
3026819 ],
3126819 },
322718 "household": {
332718 "anyOf": [
34144135 {
35144135 "type": "string"
36144135 },
37127152 {
38127152 "type": "null"
39127152 }
402718 ],
412718 },
4224018 "locale": {
4324018 "type": "string"
4424018 },
4548028 "password": {
4648028 "type": "string"
4748028 },
485036 "passwordConfirm": {
495036 "type": "string"
505036 },
512449 "private": {
522449 "type": "boolean"
532449 },
5425518 "seedData": {
5525518 "type": "boolean"
5625518 },
575036 "username": {
585036 "type": "string"
595036 }
60404107 },
6144271 "required": [
6244766 "email",
635094 "username",
645094 "fullName",
655085 "password",
665094 "passwordConfirm"
6744271 ],
685136 "type": "object"
69335184}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error7572ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error62ms
400Bad Request2051ms
409Conflict45ms
Examples
Body: application/json
falseCreateUserRegistration.advanced
"en-US"CreateUserRegistration.locale
falseCreateUserRegistration.private
falseCreateUserRegistration.seedData
Users: Tokens 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1443n/a{
2443n/a "anyOf": [
3257n/a {
4257n/a "type": "string"
5257n/a },
6186257 {
7186257 "type": "null"
8186257 }
9443n/a ],
10443n/a}
Body
application/json5 / 5
LongLiveTokenIn
1327124{
236956 "properties": {
335151 "integrationId": {
435151 "type": "string"
535151 },
633251 "name": {
733251 "type": "string"
833251 }
936956 },
1038358 "required": [
1138358 "name"
1238358 ],
1344110 "type": "object"
14327124}
Responses
codedescriptionhitsavg
201Successful Response32735ms
422Validation Error1609ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request21ms
Examples
Body: application/json
"generic"LongLiveTokenIn.integrationId
Path Parameters
token_id1 / 1
#validinvalidschema
14912{
24912 "type": "integer"
34912}
Headers
accept-language3 / 3
135n/a{
235n/a "anyOf": [
328n/a {
428n/a "type": "string"
528n/a },
6728 {
7728 "type": "null"
8728 }
935n/a ],
1035n/a}
Responses
codedescriptionhitsavg
200Successful Response3835ms
422Validation Error53ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1110ms
500Internal Server Error716ms
Utils 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
token3 / 3
#validinvalidschema
1905n/a{
2905n/a "anyOf": [
3879n/a {
4879n/a "type": "string"
5879n/a },
626879 {
726879 "type": "null"
826879 }
9905n/a ],
10905n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1541ms
401Unauthorized8041ms
500Internal Server Error502ms
691 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:39385/api/admin/aboutmethod not documented1
DELETE0.0.0.0:39385/api/admin/about/checkmethod not documented1
DELETE0.0.0.0:39385/api/admin/about/statisticsmethod not documented1
DELETE0.0.0.0:39385/api/admin/backupsmethod not documented1
DELETE0.0.0.0:39385/api/admin/debug/openaimethod not documented1
DELETE0.0.0.0:39385/api/admin/emailmethod not documented1
DELETE0.0.0.0:39385/api/admin/groupsmethod not documented1
DELETE0.0.0.0:39385/api/admin/householdsmethod not documented1
DELETE0.0.0.0:39385/api/admin/maintenancemethod not documented1
DELETE0.0.0.0:39385/api/admin/maintenance/clean/imagesmethod not documented1

... and 681 more groups