Schemathesis 4.29.4
API Coverage Report
2026-10-07 03:04:21
Operations
Operations called at least once
96.3% 238 of 247 called
Parameters
Tested with valid and invalid values
84.1% 626 of 744 covered
Keywords
Constraints tested both ways
89.8% 4987 of 5553 covered
Examples
Schema examples sent in tests
96.9% 658 of 679 used
Responses
Documented response codes hit
69.1% 337 of 487 received
Show
Admin: About 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
189n/a{
289n/a "anyOf": [
365n/a {
465n/a "type": "string"
565n/a },
62465 {
72465 "type": "null"
82465 }
989n/a ],
1089n/a}
Responses
codedescriptionhitsavg
200Successful Response1089ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
190n/a{
290n/a "anyOf": [
366n/a {
466n/a "type": "string"
566n/a },
62466 {
72466 "type": "null"
82466 }
990n/a ],
1090n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
194n/a{
294n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
63064 {
73064 "type": "null"
83064 }
994n/a ],
1094n/a}
Responses
codedescriptionhitsavg
200Successful Response1088ms
422Validation Error0never seen
Admin: Backups 6 operations 5 covered 0 partial 1 uncovered 0 not measured 84% #
Headers
accept-language3 / 3
#validinvalidschema
1413n/a{
2413n/a "anyOf": [
3279n/a {
4279n/a "type": "string"
5279n/a },
6134279 {
7134279 "type": "null"
8134279 }
9413n/a ],
10413n/a}
Responses
codedescriptionhitsavg
200Successful Response24658ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
135n/a{
235n/a "anyOf": [
324n/a {
424n/a "type": "string"
524n/a },
61124 {
71124 "type": "null"
81124 }
935n/a ],
1035n/a}
Responses
codedescriptionhitsavg
201Successful Response40429ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1119n/a{
2119n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
63980 {
73980 "type": "null"
83980 }
9119n/a ],
10119n/a}
Body
multipart/form-data5 / 5
Body_upload_one_api_admin_backups_upload_post
16651{
266n/a "properties": {
366n/a "archive": {
466n/a "format": "binary",
566n/a "type": "string"
666n/a }
766n/a },
86651 "required": [
96651 "archive"
106651 ],
11117n/a "type": "object"
126651}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error787ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1337ms
Path Parameters
file_name1 / 1
#validinvalidschema
165n/a{
265n/a "type": "string"
365n/a}
Headers
accept-language3 / 3
135n/a{
235n/a "anyOf": [
322n/a {
422n/a "type": "string"
522n/a },
61322 {
71322 "type": "null"
81322 }
935n/a ],
1035n/a}
Responses
codedescriptionhitsavg
200Successful Response137ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request527ms
Path Parameters
file_name1 / 1
#validinvalidschema
1129n/a{
2129n/a "type": "string"
3129n/a}
Headers
accept-language3 / 3
146n/a{
246n/a "anyOf": [
332n/a {
432n/a "type": "string"
532n/a },
61432 {
71432 "type": "null"
81432 }
946n/a ],
1046n/a}
Responses
codedescriptionhitsavg
200Successful Response917ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found388ms
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
1140n/a{
2140n/a "anyOf": [
384n/a {
484n/a "type": "string"
584n/a },
65684 {
75684 "type": "null"
85684 }
9140n/a ],
10140n/a}
Body
multipart/form-data4 / 6
Body_debug_openai_api_admin_debug_openai_post
11020{
2410 "properties": {
3410 "image": {
4410 "anyOf": [
534n/a {
634n/a "format": "binary",
734n/a "type": "string"
834n/a },
9734 {
10734 "type": "null"
11734 }
12410 ],
13410 }
14410 },
15102n/a "type": "object"
161020}
Responses
codedescriptionhitsavg
200Successful Response1005ms
422Validation Error576ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request541ms
Admin: Email 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
189n/a{
289n/a "anyOf": [
363n/a {
463n/a "type": "string"
563n/a },
62663 {
72663 "type": "null"
82663 }
989n/a ],
1089n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1198n/a{
2198n/a "anyOf": [
3120n/a {
4120n/a "type": "string"
5120n/a },
678120 {
778120 "type": "null"
878120 }
9198n/a ],
10198n/a}
Body
application/json4 / 4
EmailTest
117219{
21725 "properties": {
31725 "email": {
41725 "type": "string"
51725 }
61725 },
71776 "required": [
81776 "email"
91776 ],
101838 "type": "object"
1117219}
Responses
codedescriptionhitsavg
200Successful Response1725ms
422Validation Error423ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request71ms
Admin: Maintenance 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1124n/a{
2124n/a "anyOf": [
385n/a {
485n/a "type": "string"
585n/a },
63985 {
73985 "type": "null"
83985 }
9124n/a ],
10124n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1211n/a{
2211n/a "anyOf": [
3142n/a {
4142n/a "type": "string"
5142n/a },
669142 {
769142 "type": "null"
869142 }
9211n/a ],
10211n/a}
Responses
codedescriptionhitsavg
200Successful Response2088ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1223n/a{
2223n/a "anyOf": [
3150n/a {
4150n/a "type": "string"
5150n/a },
673150 {
773150 "type": "null"
873150 }
9223n/a ],
10223n/a}
Responses
codedescriptionhitsavg
200Successful Response2086ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1177n/a{
2177n/a "anyOf": [
3122n/a {
4122n/a "type": "string"
5122n/a },
655122 {
755122 "type": "null"
855122 }
9177n/a ],
10177n/a}
Responses
codedescriptionhitsavg
200Successful Response2085ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
194n/a{
294n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
62668 {
72668 "type": "null"
82668 }
994n/a ],
1094n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Admin: Manage Groups 5 operations 2 covered 3 partial 0 uncovered 0 not measured 94% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1142n/a{
2142n/a "anyOf": [
3126n/a {
4126n/a "type": "string"
5126n/a },
616126 {
716126 "type": "null"
816126 }
9142n/a ],
10142n/a}
orderByNullPosition5 / 5
112031{
212031 "anyOf": [
311536 {
511536 },
65146 {
75146 "type": "null"
85146 }
912031 ],
1012031}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
111536{
211536 "enum": [
374n/a "first",
441n/a "last"
511536 ],
6146n/a "type": "string"
711536}
orderDirection2 / 2
OrderDirection
120916{
220916 "enum": [
3142n/a "asc",
467n/a "desc"
520916 ],
6225n/a "type": "string"
720916}
queryFilter3 / 3
1150n/a{
2150n/a "anyOf": [
3142n/a {
4142n/a "type": "string"
5142n/a },
68142 {
78142 "type": "null"
88142 }
9150n/a ],
10150n/a}
paginationSeed3 / 3
1150n/a{
2150n/a "anyOf": [
3138n/a {
4138n/a "type": "string"
5138n/a },
612138 {
712138 "type": "null"
812138 }
9150n/a ],
10150n/a}
page1 / 1
117620{
217620 "type": "integer"
317620}
perPage1 / 1
118217{
218217 "type": "integer"
318217}
Headers
accept-language3 / 3
1328n/a{
2328n/a "anyOf": [
3248n/a {
4248n/a "type": "string"
5248n/a },
680248 {
780248 "type": "null"
880248 }
9328n/a ],
10328n/a}
Responses
codedescriptionhitsavg
200Successful Response34125ms
422Validation Error675ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request598ms
500Internal Server Error1013ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1402n/a{
2402n/a "anyOf": [
3272n/a {
4272n/a "type": "string"
5272n/a },
6130272 {
7130272 "type": "null"
8130272 }
9402n/a ],
10402n/a}
Body
application/json5 / 5
GroupBase
142149{
242119 "properties": {
342119 "name": {
44219 "minLength": 1,
543010 "type": "string"
642119 }
742119 },
844021 "required": [
944021 "name"
1044021 ],
114619 "type": "object"
1242149}
Responses
codedescriptionhitsavg
201Successful Response34847ms
422Validation Error685ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error7313ms
400Bad Request131ms
Path Parameters
item_id1 / 2
#validinvalidschema
1850{
2850 "format": "uuid4",
385n/a "type": "string"
4850}
Headers
accept-language3 / 3
130n/a{
230n/a "anyOf": [
323n/a {
423n/a "type": "string"
523n/a },
6723 {
7723 "type": "null"
8723 }
930n/a ],
1030n/a}
Responses
codedescriptionhitsavg
200Successful Response124ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request7118ms
404Not Found1311ms
Path Parameters
item_id1 / 2
#validinvalidschema
11300{
21300 "format": "uuid4",
3130n/a "type": "string"
41300}
Headers
accept-language3 / 3
137n/a{
237n/a "anyOf": [
328n/a {
428n/a "type": "string"
528n/a },
6928 {
7928 "type": "null"
8928 }
937n/a ],
1037n/a}
Responses
codedescriptionhitsavg
200Successful Response1129ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found188ms
Path Parameters
item_id2 / 2
#validinvalidschema
11566{
21566 "format": "uuid4",
3162n/a "type": "string"
41566}
Headers
accept-language3 / 3
187n/a{
287n/a "anyOf": [
366n/a {
466n/a "type": "string"
566n/a },
62166 {
72166 "type": "null"
82166 }
987n/a ],
1087n/a}
Body
application/json11 / 12
GroupAdminUpdate
111143{
211831 "properties": {
313211 "id": {
41320 "format": "uuid4",
513211 "type": "string"
613211 },
713711 "name": {
813711 "type": "string"
913711 },
106613 "preferences": {
116613 "anyOf": [
121663 {
141663 },
155029 {
165029 "type": "null"
175029 }
186613 ]
196613 }
2011831 },
211427 "required": [
221436 "id",
231481 "name"
241427 ],
251495 "type": "object"
2611143}
Referenced Components (1)4 of 4 keywords
UpdateGroupPreferences4 of 4 keywords
11663{
295 "properties": {
395 "privateGroup": {
495 "type": "boolean"
595 }
695 },
72158 "type": "object"
81663}
Responses
codedescriptionhitsavg
200Successful Response6814ms
422Validation Error504ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error4412ms
Examples
Body: application/json
trueUpdateGroupPreferences.privateGroup
Admin: Manage Households 5 operations 2 covered 3 partial 0 uncovered 0 not measured 92% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1160n/a{
2160n/a "anyOf": [
3149n/a {
4149n/a "type": "string"
5149n/a },
611149 {
711149 "type": "null"
811149 }
9160n/a ],
10160n/a}
orderByNullPosition5 / 5
113145{
213145 "anyOf": [
312155 {
512155 },
610166 {
710166 "type": "null"
810166 }
913145 ],
1013145}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112155{
212155 "enum": [
374n/a "first",
447n/a "last"
512155 ],
6166n/a "type": "string"
712155}
orderDirection2 / 2
OrderDirection
120226{
220226 "enum": [
3138n/a "asc",
464n/a "desc"
520226 ],
6228n/a "type": "string"
720226}
queryFilter3 / 3
1144n/a{
2144n/a "anyOf": [
3138n/a {
4138n/a "type": "string"
5138n/a },
66138 {
76138 "type": "null"
86138 }
9144n/a ],
10144n/a}
paginationSeed3 / 3
1157n/a{
2157n/a "anyOf": [
3139n/a {
4139n/a "type": "string"
5139n/a },
618139 {
718139 "type": "null"
818139 }
9157n/a ],
10157n/a}
page1 / 1
118227{
218227 "type": "integer"
318227}
perPage1 / 1
117724{
217724 "type": "integer"
317724}
Headers
accept-language3 / 3
1396n/a{
2396n/a "anyOf": [
3279n/a {
4279n/a "type": "string"
5279n/a },
6117279 {
7117279 "type": "null"
8117279 }
9396n/a ],
10396n/a}
Responses
codedescriptionhitsavg
200Successful Response23216ms
422Validation Error876ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error10524ms
400Bad Request598ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1126n/a{
2126n/a "anyOf": [
390n/a {
490n/a "type": "string"
590n/a },
63690 {
73690 "type": "null"
83690 }
9126n/a ],
10126n/a}
Body
application/json9 / 9
HouseholdCreate
12796{
23583 "properties": {
33765 "groupId": {
43765 "anyOf": [
52676 {
62661 "format": "uuid4",
78715 "type": "string"
82676 },
91191 {
101191 "type": "null"
111191 }
123765 ],
133765 },
149218 "name": {
159213 "minLength": 1,
161055 "type": "string"
179218 }
183583 },
191108 "required": [
201108 "name"
211108 ],
221185 "type": "object"
232796}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error1484ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2712ms
400Bad Request541ms
Path Parameters
item_id1 / 2
#validinvalidschema
1580{
2580 "format": "uuid4",
358n/a "type": "string"
4580}
Headers
accept-language3 / 3
131n/a{
231n/a "anyOf": [
321n/a {
421n/a "type": "string"
521n/a },
61021 {
71021 "type": "null"
81021 }
931n/a ],
1031n/a}
Responses
codedescriptionhitsavg
200Successful Response3124ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1616ms
404Not Found1110ms
Path Parameters
item_id1 / 2
#validinvalidschema
11280{
21280 "format": "uuid4",
3128n/a "type": "string"
41280}
Headers
accept-language3 / 3
131n/a{
231n/a "anyOf": [
325n/a {
425n/a "type": "string"
525n/a },
6625 {
7625 "type": "null"
8625 }
931n/a ],
1031n/a}
Responses
codedescriptionhitsavg
200Successful Response12011ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found88ms
Path Parameters
item_id1 / 2
#validinvalidschema
12220{
22220 "format": "uuid4",
3222n/a "type": "string"
42220}
Headers
accept-language3 / 3
1137n/a{
2137n/a "anyOf": [
3123n/a {
4123n/a "type": "string"
5123n/a },
614123 {
714123 "type": "null"
814123 }
9137n/a ],
10137n/a}
Body
application/json20 / 22
UpdateHouseholdAdmin
113777{
214069 "properties": {
32035 "groupId": {
42030 "format": "uuid4",
52035 "type": "string"
62035 },
719711 "id": {
81970 "format": "uuid4",
919711 "type": "string"
1019711 },
112026 "name": {
122021 "minLength": 1,
132035 "type": "string"
142026 },
159047 "preferences": {
169047 "anyOf": [
175483 {
195483 },
2036101 {
2136101 "type": "null"
2236101 }
239047 ]
249047 }
2514069 },
262063 "required": [
272081 "groupId",
282081 "name",
292081 "id"
302063 ],
312095 "type": "object"
3213777}
Referenced Components (1)11 of 11 keywords
UpdateHouseholdPreferences11 of 11 keywords
15483{
24343 "properties": {
3656 "firstDayOfWeek": {
4656 "type": "integer"
5656 },
6667 "lockRecipeEditsFromOtherHouseholds": {
7667 "type": "boolean"
8667 },
9615 "privateHousehold": {
10615 "type": "boolean"
11615 },
12605 "recipeDisableComments": {
13605 "type": "boolean"
14605 },
15525 "recipeLandscapeView": {
16525 "type": "boolean"
17525 },
18535 "recipePublic": {
19535 "type": "boolean"
20535 },
21555 "recipeShowAssets": {
22555 "type": "boolean"
23555 },
24515 "recipeShowNutrition": {
25515 "type": "boolean"
26515 }
274343 },
289740 "type": "object"
295483}
Responses
codedescriptionhitsavg
200Successful Response13616ms
422Validation Error753ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error99ms
400Bad Request21ms
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
1177n/a{
2177n/a "anyOf": [
3164n/a {
4164n/a "type": "string"
5164n/a },
613164 {
713164 "type": "null"
813164 }
9177n/a ],
10177n/a}
orderByNullPosition5 / 5
114030{
214030 "anyOf": [
313238 {
513238 },
68162 {
78162 "type": "null"
88162 }
914030 ],
1014030}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
113238{
213238 "enum": [
388n/a "first",
444n/a "last"
513238 ],
6162n/a "type": "string"
713238}
orderDirection2 / 2
OrderDirection
125423{
225423 "enum": [
3146n/a "asc",
4108n/a "desc"
525423 ],
6277n/a "type": "string"
725423}
queryFilter3 / 3
1157n/a{
2157n/a "anyOf": [
3148n/a {
4148n/a "type": "string"
5148n/a },
69148 {
79148 "type": "null"
89148 }
9157n/a ],
10157n/a}
paginationSeed3 / 3
1154n/a{
2154n/a "anyOf": [
3139n/a {
4139n/a "type": "string"
5139n/a },
615139 {
715139 "type": "null"
815139 }
9154n/a ],
10154n/a}
page1 / 1
121424{
221424 "type": "integer"
321424}
perPage1 / 1
120020{
220020 "type": "integer"
320020}
Headers
accept-language3 / 3
1391n/a{
2391n/a "anyOf": [
3275n/a {
4275n/a "type": "string"
5275n/a },
6116275 {
7116275 "type": "null"
8116275 }
9391n/a ],
10391n/a}
Responses
codedescriptionhitsavg
200Successful Response30512ms
422Validation Error705ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1008ms
500Internal Server Error1412ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1453n/a{
2453n/a "anyOf": [
3327n/a {
4327n/a "type": "string"
5327n/a },
6126327 {
7126327 "type": "null"
8126327 }
9453n/a ],
10453n/a}
Body
application/json26 / 26
UserIn
1391113{
240495 "properties": {
32798 "admin": {
42798 "type": "boolean"
52798 },
62826 "advanced": {
72826 "type": "boolean"
82826 },
927716 "authMethod": {
1127716 },
122795 "canInvite": {
132795 "type": "boolean"
142795 },
152848 "canManage": {
162848 "type": "boolean"
172848 },
182885 "canManageHousehold": {
192885 "type": "boolean"
202885 },
212985 "canOrganize": {
222985 "type": "boolean"
232985 },
2448116 "email": {
2548116 "type": "string"
2648116 },
274925 "fullName": {
284925 "type": "string"
294925 },
302824 "group": {
312824 "anyOf": [
32149137 {
33149137 "type": "string"
34149137 },
35133153 {
36133153 "type": "null"
37133153 }
382824 ],
392824 },
4027911 "household": {
4127911 "anyOf": [
42136154 {
43136154 "type": "string"
44136154 },
45143147 {
46143147 "type": "null"
47143147 }
4827911 ],
4927911 },
5029319 "id": {
5129319 "anyOf": [
5221993 {
532193 "format": "uuid4",
5422290 "type": "string"
5521993 },
5674238 {
5774238 "type": "null"
5874238 }
5929319 ],
6029319 },
6148710 "password": {
6248710 "type": "string"
6348710 },
644845 "username": {
654845 "type": "string"
664845 }
6740495 },
6848613 "required": [
6948910 "username",
704972 "fullName",
714972 "email",
724972 "password"
7348613 ],
744995 "type": "object"
75391113}
Referenced Components (1)3 of 3 keywords
AuthMethod3 of 3 keywords
127716{
227716 "enum": [
3171n/a "Mealie",
452n/a "LDAP",
554n/a "OIDC"
627716 ],
72885 "type": "string"
827716}
Responses
codedescriptionhitsavg
201Successful Response3175ms
422Validation Error1397ms
Undocumented - not in spec
codedescriptionhitsavg
409Conflict35612ms
400Bad Request7187ms
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
17768{
27768 "type": "boolean"
37768}
Headers
accept-language3 / 3
1195n/a{
2195n/a "anyOf": [
3119n/a {
4119n/a "type": "string"
5119n/a },
676119 {
776119 "type": "null"
876119 }
9195n/a ],
10195n/a}
Responses
codedescriptionhitsavg
200Successful Response1465ms
422Validation Error686ms
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_id1 / 2
#validinvalidschema
12230{
22230 "format": "uuid4",
3223n/a "type": "string"
42230}
Headers
accept-language3 / 3
190n/a{
290n/a "anyOf": [
363n/a {
463n/a "type": "string"
563n/a },
62763 {
72763 "type": "null"
82763 }
990n/a ],
1090n/a}
Responses
codedescriptionhitsavg
200Successful Response20110ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found228ms
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 Response33ms
Responses
codedescriptionhitsavg
200Successful Response32ms
Responses
codedescriptionhitsavg
200Successful Response31ms
Explore: Categories 2 operations 1 covered 1 partial 0 uncovered 0 not measured 96% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1235n/a{
2235n/a "type": "string"
3235n/a}
Query Parameters
search3 / 3
164n/a{
264n/a "anyOf": [
360n/a {
460n/a "type": "string"
560n/a },
6460 {
7460 "type": "null"
8460 }
964n/a ],
1064n/a}
orderBy3 / 3
169n/a{
269n/a "anyOf": [
367n/a {
467n/a "type": "string"
567n/a },
6267 {
7267 "type": "null"
8267 }
969n/a ],
1069n/a}
orderByNullPosition5 / 5
15417{
25417 "anyOf": [
35021 {
55021 },
6467 {
7467 "type": "null"
8467 }
95417 ],
105417}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15021{
25021 "enum": [
348n/a "first",
42n/a "last"
55021 ],
667n/a "type": "string"
75021}
orderDirection2 / 2
OrderDirection
15812{
25812 "enum": [
351n/a "asc",
47n/a "desc"
55812 ],
670n/a "type": "string"
75812}
queryFilter3 / 3
160n/a{
260n/a "anyOf": [
358n/a {
458n/a "type": "string"
558n/a },
6258 {
7258 "type": "null"
8258 }
960n/a ],
1060n/a}
paginationSeed3 / 3
162n/a{
262n/a "anyOf": [
360n/a {
460n/a "type": "string"
560n/a },
6260 {
7260 "type": "null"
8260 }
962n/a ],
1062n/a}
page1 / 1
16610{
26610 "type": "integer"
36610}
perPage1 / 1
15314{
25314 "type": "integer"
35314}
Headers
accept-language3 / 3
1179n/a{
2179n/a "anyOf": [
3139n/a {
4139n/a "type": "string"
5139n/a },
640139 {
740139 "type": "null"
840139 }
9179n/a ],
10179n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found20111ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id1 / 2
#validinvalidschema
11560{
21560 "format": "uuid4",
3156n/a "type": "string"
41560}
group_slug1 / 1
1156n/a{
2156n/a "type": "string"
3156n/a}
Headers
accept-language3 / 3
138n/a{
238n/a "anyOf": [
328n/a {
428n/a "type": "string"
528n/a },
61028 {
71028 "type": "null"
81028 }
938n/a ],
1038n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found12016ms
Explore: Cookbooks 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1241n/a{
2241n/a "type": "string"
3241n/a}
Query Parameters
search3 / 3
161n/a{
261n/a "anyOf": [
357n/a {
457n/a "type": "string"
557n/a },
6457 {
7457 "type": "null"
8457 }
961n/a ],
1061n/a}
orderBy3 / 3
164n/a{
264n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
6262 {
7262 "type": "null"
8262 }
964n/a ],
1064n/a}
orderByNullPosition5 / 5
15412{
25412 "anyOf": [
35016 {
55016 },
6462 {
7462 "type": "null"
8462 }
95412 ],
105412}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15016{
25016 "enum": [
347n/a "first",
43n/a "last"
55016 ],
662n/a "type": "string"
75016}
orderDirection2 / 2
OrderDirection
16112{
26112 "enum": [
358n/a "asc",
43n/a "desc"
56112 ],
673n/a "type": "string"
76112}
queryFilter3 / 3
159n/a{
259n/a "anyOf": [
357n/a {
457n/a "type": "string"
557n/a },
6257 {
7257 "type": "null"
8257 }
959n/a ],
1059n/a}
paginationSeed3 / 3
163n/a{
263n/a "anyOf": [
361n/a {
461n/a "type": "string"
561n/a },
6261 {
7261 "type": "null"
8261 }
963n/a ],
1063n/a}
page1 / 1
15414{
25414 "type": "integer"
35414}
perPage1 / 1
15813{
25813 "type": "integer"
35813}
Headers
accept-language3 / 3
1167n/a{
2167n/a "anyOf": [
3138n/a {
4138n/a "type": "string"
5138n/a },
629138 {
729138 "type": "null"
829138 }
9167n/a ],
10167n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found20711ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id4 / 4
#validinvalidschema
1172n/a{
2172n/a "anyOf": [
316210 {
416210 "format": "uuid4",
5172n/a "type": "string"
616210 },
7172n/a {
8172n/a "type": "string"
9172n/a }
10172n/a ],
11172n/a}
group_slug1 / 1
1172n/a{
2172n/a "type": "string"
3172n/a}
Headers
accept-language3 / 3
1115n/a{
2115n/a "anyOf": [
382n/a {
482n/a "type": "string"
582n/a },
63382 {
73382 "type": "null"
83382 }
9115n/a ],
10115n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found13617ms
Explore: Foods 2 operations 1 covered 1 partial 0 uncovered 0 not measured 96% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1237n/a{
2237n/a "type": "string"
3237n/a}
Query Parameters
search3 / 3
163n/a{
263n/a "anyOf": [
360n/a {
460n/a "type": "string"
560n/a },
6360 {
7360 "type": "null"
8360 }
963n/a ],
1063n/a}
orderBy3 / 3
170n/a{
270n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
6268 {
7268 "type": "null"
8268 }
970n/a ],
1070n/a}
orderByNullPosition5 / 5
16412{
26412 "anyOf": [
36016 {
56016 },
6472 {
7472 "type": "null"
8472 }
96412 ],
106412}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
16016{
26016 "enum": [
352n/a "first",
48n/a "last"
56016 ],
672n/a "type": "string"
76016}
orderDirection2 / 2
OrderDirection
16217{
26217 "enum": [
352n/a "asc",
410n/a "desc"
56217 ],
679n/a "type": "string"
76217}
queryFilter3 / 3
162n/a{
262n/a "anyOf": [
360n/a {
460n/a "type": "string"
560n/a },
6260 {
7260 "type": "null"
8260 }
962n/a ],
1062n/a}
paginationSeed3 / 3
161n/a{
261n/a "anyOf": [
359n/a {
459n/a "type": "string"
559n/a },
6259 {
7259 "type": "null"
8259 }
961n/a ],
1061n/a}
page1 / 1
16410{
26410 "type": "integer"
36410}
perPage1 / 1
16011{
26011 "type": "integer"
36011}
Headers
accept-language3 / 3
1169n/a{
2169n/a "anyOf": [
3134n/a {
4134n/a "type": "string"
5134n/a },
635134 {
735134 "type": "null"
835134 }
9169n/a ],
10169n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2039ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id1 / 2
#validinvalidschema
11690{
21690 "format": "uuid4",
3169n/a "type": "string"
41690}
group_slug1 / 1
1169n/a{
2169n/a "type": "string"
3169n/a}
Headers
accept-language3 / 3
141n/a{
241n/a "anyOf": [
333n/a {
433n/a "type": "string"
533n/a },
6833 {
7833 "type": "null"
8833 }
941n/a ],
1041n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found13318ms
Explore: Households 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1225n/a{
2225n/a "type": "string"
3225n/a}
Query Parameters
orderBy3 / 3
164n/a{
264n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
6262 {
7262 "type": "null"
8262 }
964n/a ],
1064n/a}
orderByNullPosition5 / 5
15616{
25616 "anyOf": [
35220 {
55220 },
6468 {
7468 "type": "null"
8468 }
95616 ],
105616}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15220{
25220 "enum": [
345n/a "first",
47n/a "last"
55220 ],
668n/a "type": "string"
75220}
orderDirection2 / 2
OrderDirection
15516{
25516 "enum": [
348n/a "asc",
47n/a "desc"
55516 ],
671n/a "type": "string"
75516}
queryFilter3 / 3
160n/a{
260n/a "anyOf": [
358n/a {
458n/a "type": "string"
558n/a },
6258 {
7258 "type": "null"
8258 }
960n/a ],
1060n/a}
paginationSeed3 / 3
157n/a{
257n/a "anyOf": [
355n/a {
455n/a "type": "string"
555n/a },
6255 {
7255 "type": "null"
8255 }
957n/a ],
1057n/a}
page1 / 1
15211{
25211 "type": "integer"
35211}
perPage1 / 1
15111{
25111 "type": "integer"
35111}
Headers
accept-language3 / 3
1172n/a{
2172n/a "anyOf": [
3136n/a {
4136n/a "type": "string"
5136n/a },
636136 {
736136 "type": "null"
836136 }
9172n/a ],
10172n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1919ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
household_slug1 / 1
#validinvalidschema
1175n/a{
2175n/a "type": "string"
3175n/a}
group_slug1 / 1
1175n/a{
2175n/a "type": "string"
3175n/a}
Headers
accept-language3 / 3
1110n/a{
2110n/a "anyOf": [
384n/a {
484n/a "type": "string"
584n/a },
62684 {
72684 "type": "null"
82684 }
9110n/a ],
10110n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found13914ms
Explore: Recipes 3 operations 1 covered 2 partial 0 uncovered 0 not measured 87% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1369n/a{
2369n/a "type": "string"
3369n/a}
Query Parameters
categories5 / 7
113413{
213413 "anyOf": [
313413 {
4134n/a "items": {
5156n/a "anyOf": [
612247 {
712234 "format": "uuid4",
8156n/a "type": "string"
912247 },
10156n/a {
11156n/a "type": "string"
12156n/a }
13156n/a ]
14134n/a },
151470 "type": "array"
1613413 },
170147 {
180147 "type": "null"
190147 }
2013413 ],
2113413}
tags5 / 7
111110{
211110 "anyOf": [
311110 {
4111n/a "items": {
5127n/a "anyOf": [
610730 {
710720 "format": "uuid4",
8127n/a "type": "string"
910730 },
10127n/a {
11127n/a "type": "string"
12127n/a }
13127n/a ]
14111n/a },
151210 "type": "array"
1611110 },
170121 {
180121 "type": "null"
190121 }
2011110 ],
2111110}
tools5 / 7
11139{
21139 "anyOf": [
31139 {
4113n/a "items": {
5138n/a "anyOf": [
610742 {
710731 "format": "uuid4",
8138n/a "type": "string"
910742 },
10138n/a {
11138n/a "type": "string"
12138n/a }
13138n/a ]
14113n/a },
151220 "type": "array"
161139 },
170122 {
180122 "type": "null"
190122 }
201139 ],
211139}
foods5 / 7
112714{
212714 "anyOf": [
312714 {
4127n/a "items": {
5176n/a "anyOf": [
612169 {
712155 "format": "uuid4",
8176n/a "type": "string"
912169 },
10176n/a {
11176n/a "type": "string"
12176n/a }
13176n/a ]
14127n/a },
151410 "type": "array"
1612714 },
170141 {
180141 "type": "null"
190141 }
2012714 ],
2112714}
households5 / 7
112911{
212911 "anyOf": [
312911 {
4129n/a "items": {
5185n/a "anyOf": [
612076 {
712065 "format": "uuid4",
8185n/a "type": "string"
912076 },
10185n/a {
11185n/a "type": "string"
12185n/a }
13185n/a ]
14129n/a },
151400 "type": "array"
1612911 },
170140 {
180140 "type": "null"
190140 }
2012911 ],
2112911}
orderBy3 / 3
1134n/a{
2134n/a "anyOf": [
3131n/a {
4131n/a "type": "string"
5131n/a },
63131 {
73131 "type": "null"
83131 }
9134n/a ],
10134n/a}
orderByNullPosition5 / 5
113514{
213514 "anyOf": [
312920 {
512920 },
66143 {
76143 "type": "null"
86143 }
913514 ],
1013514}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112920{
212920 "enum": [
3117n/a "first",
412n/a "last"
512920 ],
6143n/a "type": "string"
712920}
orderDirection2 / 2
OrderDirection
112213{
212213 "enum": [
3119n/a "asc",
43n/a "desc"
512213 ],
6135n/a "type": "string"
712213}
queryFilter3 / 3
1132n/a{
2132n/a "anyOf": [
3128n/a {
4128n/a "type": "string"
5128n/a },
64128 {
74128 "type": "null"
84128 }
9132n/a ],
10132n/a}
paginationSeed3 / 3
1138n/a{
2138n/a "anyOf": [
3134n/a {
4134n/a "type": "string"
5134n/a },
64134 {
74134 "type": "null"
84134 }
9138n/a ],
10138n/a}
page1 / 1
112611{
212611 "type": "integer"
312611}
perPage1 / 1
112312{
212312 "type": "integer"
312312}
cookbook5 / 5
1139n/a{
2139n/a "anyOf": [
312415 {
412413 "format": "uuid4",
5137n/a "type": "string"
612415 },
7137n/a {
8137n/a "type": "string"
9137n/a },
102137 {
112137 "type": "null"
122137 }
13139n/a ],
14139n/a}
requireAllCategories1 / 1
112210{
212210 "type": "boolean"
312210}
requireAllTags1 / 1
112310{
212310 "type": "boolean"
312310}
requireAllTools1 / 1
111910{
211910 "type": "boolean"
311910}
requireAllFoods1 / 1
112810{
212810 "type": "boolean"
312810}
search3 / 3
1131n/a{
2131n/a "anyOf": [
3126n/a {
4126n/a "type": "string"
5126n/a },
65126 {
75126 "type": "null"
85126 }
9131n/a ],
10131n/a}
Headers
accept-language3 / 3
1309n/a{
2309n/a "anyOf": [
3274n/a {
4274n/a "type": "string"
5274n/a },
635274 {
735274 "type": "null"
835274 }
9309n/a ],
10309n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3357ms
Examples
Query
"desc"orderDirection
1page
50perPage
falserequireAllCategories
falserequireAllTags
falserequireAllTools
falserequireAllFoods
Path Parameters
group_slug1 / 1
#validinvalidschema
1303n/a{
2303n/a "type": "string"
3303n/a}
Query Parameters
foods3 / 5
110512{
210512 "anyOf": [
310512 {
410512 "items": {
52503 "format": "uuid4",
6253n/a "type": "string"
710512 },
81170 "type": "array"
910512 },
100117 {
110117 "type": "null"
120117 }
1310512 ],
1410512}
tools3 / 5
17015{
27015 "anyOf": [
37015 {
47015 "items": {
5732 "format": "uuid4",
675n/a "type": "string"
77015 },
8850 "type": "array"
97015 },
10085 {
11085 "type": "null"
12085 }
137015 ],
147015}
orderBy3 / 3
193n/a{
293n/a "anyOf": [
390n/a {
490n/a "type": "string"
590n/a },
6390 {
7390 "type": "null"
8390 }
993n/a ],
1093n/a}
orderByNullPosition5 / 5
18318{
28318 "anyOf": [
37427 {
57427 },
6992 {
7992 "type": "null"
8992 }
98318 ],
108318}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
17427{
27427 "enum": [
372n/a "first",
42n/a "last"
57427 ],
692n/a "type": "string"
77427}
orderDirection2 / 2
OrderDirection
18013{
28013 "enum": [
374n/a "asc",
46n/a "desc"
58013 ],
693n/a "type": "string"
78013}
queryFilter3 / 3
183n/a{
283n/a "anyOf": [
381n/a {
481n/a "type": "string"
581n/a },
6281 {
7281 "type": "null"
8281 }
983n/a ],
1083n/a}
paginationSeed3 / 3
184n/a{
284n/a "anyOf": [
382n/a {
482n/a "type": "string"
582n/a },
6282 {
7282 "type": "null"
8282 }
984n/a ],
1084n/a}
limit1 / 1
18415{
28415 "type": "integer"
38415}
maxMissingFoods1 / 1
18610{
28610 "type": "integer"
38610}
maxMissingTools1 / 1
18014{
28014 "type": "integer"
38014}
includeFoodsOnHand1 / 1
18910{
28910 "type": "boolean"
38910}
includeToolsOnHand1 / 1
18710{
28710 "type": "boolean"
38710}
Headers
accept-language3 / 3
1238n/a{
2238n/a "anyOf": [
3199n/a {
4199n/a "type": "string"
5199n/a },
639199 {
739199 "type": "null"
839199 }
9238n/a ],
10238n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2698ms
Examples
Query
"desc"orderDirection
10limit
5maxMissingFoods
5maxMissingTools
trueincludeFoodsOnHand
trueincludeToolsOnHand
Path Parameters
recipe_slug1 / 1
#validinvalidschema
1179n/a{
2179n/a "type": "string"
3179n/a}
group_slug1 / 1
1179n/a{
2179n/a "type": "string"
3179n/a}
Headers
accept-language3 / 3
1115n/a{
2115n/a "anyOf": [
375n/a {
475n/a "type": "string"
575n/a },
64075 {
74075 "type": "null"
84075 }
9115n/a ],
10115n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found14317ms
Explore: Tags 2 operations 1 covered 1 partial 0 uncovered 0 not measured 96% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1232n/a{
2232n/a "type": "string"
3232n/a}
Query Parameters
search3 / 3
164n/a{
264n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
6262 {
7262 "type": "null"
8262 }
964n/a ],
1064n/a}
orderBy3 / 3
164n/a{
264n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
6262 {
7262 "type": "null"
8262 }
964n/a ],
1064n/a}
orderByNullPosition5 / 5
16113{
26113 "anyOf": [
35717 {
55717 },
6470 {
7470 "type": "null"
8470 }
96113 ],
106113}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15717{
25717 "enum": [
348n/a "first",
49n/a "last"
55717 ],
670n/a "type": "string"
75717}
orderDirection2 / 2
OrderDirection
17012{
27012 "enum": [
360n/a "asc",
410n/a "desc"
57012 ],
682n/a "type": "string"
77012}
queryFilter3 / 3
158n/a{
258n/a "anyOf": [
356n/a {
456n/a "type": "string"
556n/a },
6256 {
7256 "type": "null"
8256 }
958n/a ],
1058n/a}
paginationSeed3 / 3
163n/a{
263n/a "anyOf": [
361n/a {
461n/a "type": "string"
561n/a },
6261 {
7261 "type": "null"
8261 }
963n/a ],
1063n/a}
page1 / 1
16710{
26710 "type": "integer"
36710}
perPage1 / 1
16010{
26010 "type": "integer"
36010}
Headers
accept-language3 / 3
1187n/a{
2187n/a "anyOf": [
3144n/a {
4144n/a "type": "string"
5144n/a },
643144 {
743144 "type": "null"
843144 }
9187n/a ],
10187n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found19810ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id1 / 2
#validinvalidschema
11710{
21710 "format": "uuid4",
3171n/a "type": "string"
41710}
group_slug1 / 1
1171n/a{
2171n/a "type": "string"
3171n/a}
Headers
accept-language3 / 3
140n/a{
240n/a "anyOf": [
329n/a {
429n/a "type": "string"
529n/a },
61129 {
71129 "type": "null"
81129 }
940n/a ],
1040n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found13514ms
Explore: Tools 2 operations 1 covered 1 partial 0 uncovered 0 not measured 96% #
Path Parameters
group_slug1 / 1
#validinvalidschema
1241n/a{
2241n/a "type": "string"
3241n/a}
Query Parameters
search3 / 3
160n/a{
260n/a "anyOf": [
358n/a {
458n/a "type": "string"
558n/a },
6258 {
7258 "type": "null"
8258 }
960n/a ],
1060n/a}
orderBy3 / 3
172n/a{
272n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
6468 {
7468 "type": "null"
8468 }
972n/a ],
1072n/a}
orderByNullPosition5 / 5
15512{
25512 "anyOf": [
35116 {
55116 },
6463 {
7463 "type": "null"
8463 }
95512 ],
105512}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15116{
25116 "enum": [
348n/a "first",
43n/a "last"
55116 ],
663n/a "type": "string"
75116}
orderDirection2 / 2
OrderDirection
16812{
26812 "enum": [
360n/a "asc",
48n/a "desc"
56812 ],
680n/a "type": "string"
76812}
queryFilter3 / 3
165n/a{
265n/a "anyOf": [
363n/a {
463n/a "type": "string"
563n/a },
6263 {
7263 "type": "null"
8263 }
965n/a ],
1065n/a}
paginationSeed3 / 3
162n/a{
262n/a "anyOf": [
360n/a {
460n/a "type": "string"
560n/a },
6260 {
7260 "type": "null"
8260 }
962n/a ],
1062n/a}
page1 / 1
16714{
26714 "type": "integer"
36714}
perPage1 / 1
16910{
26910 "type": "integer"
36910}
Headers
accept-language3 / 3
1176n/a{
2176n/a "anyOf": [
3140n/a {
4140n/a "type": "string"
5140n/a },
636140 {
736140 "type": "null"
836140 }
9176n/a ],
10176n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found20714ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
item_id1 / 2
#validinvalidschema
11880{
21880 "format": "uuid4",
3188n/a "type": "string"
41880}
group_slug1 / 1
1188n/a{
2188n/a "type": "string"
3188n/a}
Headers
accept-language3 / 3
144n/a{
244n/a "anyOf": [
332n/a {
432n/a "type": "string"
532n/a },
61232 {
71232 "type": "null"
81232 }
944n/a ],
1044n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found15218ms
Groups: Households 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
167n/a{
267n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
6364 {
7364 "type": "null"
8364 }
967n/a ],
1067n/a}
orderByNullPosition5 / 5
16219{
26219 "anyOf": [
35625 {
55625 },
6675 {
7675 "type": "null"
8675 }
96219 ],
106219}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15625{
25625 "enum": [
343n/a "first",
413n/a "last"
55625 ],
675n/a "type": "string"
75625}
orderDirection2 / 2
OrderDirection
16012{
26012 "enum": [
349n/a "asc",
411n/a "desc"
56012 ],
672n/a "type": "string"
76012}
queryFilter3 / 3
166n/a{
266n/a "anyOf": [
363n/a {
463n/a "type": "string"
563n/a },
6363 {
7363 "type": "null"
8363 }
966n/a ],
1066n/a}
paginationSeed3 / 3
172n/a{
272n/a "anyOf": [
367n/a {
467n/a "type": "string"
567n/a },
6567 {
7567 "type": "null"
8567 }
972n/a ],
1072n/a}
page1 / 1
15818{
25818 "type": "integer"
35818}
perPage1 / 1
15511{
25511 "type": "integer"
35511}
Headers
accept-language3 / 3
1176n/a{
2176n/a "anyOf": [
3137n/a {
4137n/a "type": "string"
5137n/a },
639137 {
739137 "type": "null"
839137 }
9176n/a ],
10176n/a}
Responses
codedescriptionhitsavg
200Successful Response1187ms
422Validation Error564ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request136ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
household_slug1 / 1
#validinvalidschema
1118n/a{
2118n/a "type": "string"
3118n/a}
Headers
accept-language3 / 3
1109n/a{
2109n/a "anyOf": [
369n/a {
469n/a "type": "string"
569n/a },
64069 {
74069 "type": "null"
84069 }
9109n/a ],
10109n/a}
Responses
codedescriptionhitsavg
200Successful Response1617ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1028ms
Groups: Migrations 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1372n/a{
2372n/a "anyOf": [
3251n/a {
4251n/a "type": "string"
5251n/a },
6121251 {
7121251 "type": "null"
8121251 }
9372n/a ],
10372n/a}
Body
multipart/form-data9 / 9
Body_start_data_migration_api_groups_migrations_post
1250108{
228170 "properties": {
316114 "add_migration_tag": {
416114 "type": "boolean"
516114 },
6345n/a "archive": {
7345n/a "format": "binary",
8345n/a "type": "string"
9345n/a },
1026263 "migration_type": {
1226263 }
1328170 },
1432038 "required": [
1532533 "migration_type",
1634513 "archive"
1732038 ],
18358n/a "type": "object"
19250108}
Referenced Components (1)3 of 3 keywords
SupportedMigrations3 of 3 keywords
126263{
226263 "enum": [
335n/a "nextcloud",
421n/a "chowdown",
514n/a "copymethat",
623n/a "paprika",
734n/a "mealie_alpha",
823n/a "tandoor",
924n/a "plantoeat",
109n/a "myrecipebox",
1111n/a "recipekeeper",
1268n/a "cookn"
1326263 ],
14325n/a "type": "string"
1526263}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error5269ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request41ms
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 94% #
Query Parameters
search3 / 3
#validinvalidschema
178n/a{
278n/a "anyOf": [
370n/a {
470n/a "type": "string"
570n/a },
6870 {
7870 "type": "null"
8870 }
978n/a ],
1078n/a}
orderBy3 / 3
189n/a{
289n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
6980 {
7980 "type": "null"
8980 }
989n/a ],
1089n/a}
orderByNullPosition5 / 5
16420{
26420 "anyOf": [
35727 {
55727 },
6777 {
7777 "type": "null"
8777 }
96420 ],
106420}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15727{
25727 "enum": [
351n/a "first",
46n/a "last"
55727 ],
677n/a "type": "string"
75727}
orderDirection2 / 2
OrderDirection
17513{
27513 "enum": [
359n/a "asc",
416n/a "desc"
57513 ],
688n/a "type": "string"
77513}
queryFilter3 / 3
173n/a{
273n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
6964 {
7964 "type": "null"
8964 }
973n/a ],
1073n/a}
paginationSeed3 / 3
186n/a{
286n/a "anyOf": [
377n/a {
477n/a "type": "string"
577n/a },
6977 {
7977 "type": "null"
8977 }
986n/a ],
1086n/a}
page1 / 1
16124{
26124 "type": "integer"
36124}
perPage1 / 1
17014{
27014 "type": "integer"
37014}
Headers
accept-language3 / 3
1170n/a{
2170n/a "anyOf": [
3139n/a {
4139n/a "type": "string"
5139n/a },
631139 {
731139 "type": "null"
831139 }
9170n/a ],
10170n/a}
Responses
codedescriptionhitsavg
200Successful Response1197ms
422Validation Error584ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request187ms
500Internal Server Error111ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1332n/a{
2332n/a "anyOf": [
3232n/a {
4232n/a "type": "string"
5232n/a },
6100232 {
7100232 "type": "null"
8100232 }
9332n/a ],
10332n/a}
Body
application/json5 / 5
MultiPurposeLabelCreate
132047{
233316 "properties": {
316311 "color": {
416311 "type": "string"
516311 },
632511 "name": {
732511 "type": "string"
832511 }
933316 },
1033624 "required": [
1133624 "name"
1233624 ],
133607 "type": "object"
1432047}
Responses
codedescriptionhitsavg
200Successful Response135ms
422Validation Error1183ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error319245ms
400Bad Request691ms
Examples
Body: application/json
"#959595"MultiPurposeLabelCreate.color
Path Parameters
item_id2 / 2
#validinvalidschema
119414{
219414 "format": "uuid4",
3208n/a "type": "string"
419414}
Headers
accept-language3 / 3
150n/a{
250n/a "anyOf": [
335n/a {
435n/a "type": "string"
535n/a },
61535 {
71535 "type": "null"
81535 }
950n/a ],
1050n/a}
Responses
codedescriptionhitsavg
200Successful Response128ms
422Validation Error148ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1938ms
Path Parameters
item_id2 / 2
#validinvalidschema
11017{
21017 "format": "uuid4",
3108n/a "type": "string"
41017}
Headers
accept-language3 / 3
118n/a{
218n/a "anyOf": [
315n/a {
415n/a "type": "string"
515n/a },
6315 {
7315 "type": "null"
8315 }
918n/a ],
1018n/a}
Responses
codedescriptionhitsavg
200Successful Response83ms
422Validation Error77ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error938ms
Path Parameters
item_id1 / 2
#validinvalidschema
11390{
21390 "format": "uuid4",
3139n/a "type": "string"
41390}
Headers
accept-language3 / 3
160n/a{
260n/a "anyOf": [
351n/a {
451n/a "type": "string"
551n/a },
6951 {
7951 "type": "null"
8951 }
960n/a ],
1060n/a}
Body
application/json7 / 9
MultiPurposeLabelUpdate
15329{
25720 "properties": {
3375 "color": {
4375 "type": "string"
5375 },
6705 "groupId": {
7700 "format": "uuid4",
8705 "type": "string"
9705 },
10715 "id": {
11710 "format": "uuid4",
12715 "type": "string"
13715 },
14715 "name": {
15715 "type": "string"
16715 }
175720 },
18734 "required": [
19761 "name",
20752 "groupId",
21761 "id"
22734 ],
23775 "type": "object"
245329}
Responses
codedescriptionhitsavg
200Successful Response89ms
422Validation Error572ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found458ms
400Bad Request291ms
Examples
Body: application/json
"#959595"MultiPurposeLabelUpdate.color
Groups: Reports 3 operations 2 covered 1 partial 0 uncovered 0 not measured 94% #
Query Parameters
report_type5 / 5
#validinvalidschema
15680{
25680 "anyOf": [
35383 {
55383 },
63133 {
73133 "type": "null"
83133 }
95680 ],
105680}
Referenced Components (1)3 of 3 keywords
ReportCategory3 of 3 keywords
15383{
25383 "enum": [
319n/a "backup",
417n/a "restore",
57n/a "migration",
610n/a "bulk_import"
75383 ],
8133n/a "type": "string"
95383}
Headers
accept-language3 / 3
1263n/a{
2263n/a "anyOf": [
3178n/a {
4178n/a "type": "string"
5178n/a },
685178 {
785178 "type": "null"
885178 }
9263n/a ],
10263n/a}
Responses
codedescriptionhitsavg
200Successful Response2548ms
422Validation Error8011ms
Path Parameters
item_id2 / 2
#validinvalidschema
19217{
29217 "format": "uuid4",
3109n/a "type": "string"
49217}
Headers
accept-language3 / 3
129n/a{
229n/a "anyOf": [
323n/a {
423n/a "type": "string"
523n/a },
6623 {
7623 "type": "null"
8623 }
929n/a ],
1029n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error178ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error9212ms
Path Parameters
item_id1 / 2
#validinvalidschema
11310{
21310 "format": "uuid4",
3131n/a "type": "string"
41310}
Headers
accept-language3 / 3
136n/a{
236n/a "anyOf": [
327n/a {
427n/a "type": "string"
527n/a },
6927 {
7927 "type": "null"
8927 }
936n/a ],
1036n/a}
Responses
codedescriptionhitsavg
200Successful Response1258ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found68ms
Groups: Seeders 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1195n/a{
2195n/a "anyOf": [
3126n/a {
4126n/a "type": "string"
5126n/a },
669126 {
769126 "type": "null"
869126 }
9195n/a ],
10195n/a}
Body
application/json4 / 4
SeederConfig
115933{
21595 "properties": {
31595 "locale": {
41595 "type": "string"
51595 }
61595 },
716423 "required": [
816423 "locale"
916423 ],
101875 "type": "object"
1115933}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error2134ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request81ms
Headers
accept-language3 / 3
#validinvalidschema
1195n/a{
2195n/a "anyOf": [
3122n/a {
4122n/a "type": "string"
5122n/a },
673122 {
773122 "type": "null"
873122 }
9195n/a ],
10195n/a}
Body
application/json4 / 4
SeederConfig
115140{
21516 "properties": {
31516 "locale": {
41516 "type": "string"
51516 }
61516 },
715724 "required": [
815724 "locale"
915724 ],
1018110 "type": "object"
1115140}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error2196ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request21ms
Headers
accept-language3 / 3
#validinvalidschema
1218n/a{
2218n/a "anyOf": [
3127n/a {
4127n/a "type": "string"
5127n/a },
691127 {
791127 "type": "null"
891127 }
9218n/a ],
10218n/a}
Body
application/json4 / 4
SeederConfig
117326{
217310 "properties": {
317310 "locale": {
417310 "type": "string"
517310 }
617310 },
71837 "required": [
81837 "locale"
91837 ],
101909 "type": "object"
1117326}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error2154ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request61ms
Groups: Self Service 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
orderBy3 / 3
#validinvalidschema
184n/a{
284n/a "anyOf": [
373n/a {
473n/a "type": "string"
573n/a },
61173 {
71173 "type": "null"
81173 }
984n/a ],
1084n/a}
orderByNullPosition5 / 5
15633{
25633 "anyOf": [
35039 {
55039 },
6683 {
7683 "type": "null"
8683 }
95633 ],
105633}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
15039{
25039 "enum": [
347n/a "first",
43n/a "last"
55039 ],
683n/a "type": "string"
75039}
orderDirection2 / 2
OrderDirection
16714{
26714 "enum": [
354n/a "asc",
413n/a "desc"
56714 ],
681n/a "type": "string"
76714}
queryFilter3 / 3
172n/a{
272n/a "anyOf": [
363n/a {
463n/a "type": "string"
563n/a },
6963 {
7963 "type": "null"
8963 }
972n/a ],
1072n/a}
paginationSeed3 / 3
170n/a{
270n/a "anyOf": [
364n/a {
464n/a "type": "string"
564n/a },
6664 {
7664 "type": "null"
8664 }
970n/a ],
1070n/a}
page1 / 1
16715{
26715 "type": "integer"
36715}
perPage1 / 1
15615{
25615 "type": "integer"
35615}
Headers
accept-language3 / 3
1172n/a{
2172n/a "anyOf": [
3135n/a {
4135n/a "type": "string"
5135n/a },
637135 {
737135 "type": "null"
837135 }
9172n/a ],
10172n/a}
Responses
codedescriptionhitsavg
200Successful Response1067ms
422Validation Error705ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request107ms
500Internal Server Error111ms
Examples
Query
"desc"orderDirection
1page
50perPage
Path Parameters
username_or_id4 / 4
#validinvalidschema
1109n/a{
2109n/a "anyOf": [
3109n/a {
4109n/a "type": "string"
5109n/a },
61108 {
71108 "format": "uuid4",
8109n/a "type": "string"
91108 }
10109n/a ],
11109n/a}
Headers
accept-language3 / 3
1103n/a{
2103n/a "anyOf": [
374n/a {
474n/a "type": "string"
574n/a },
62974 {
72974 "type": "null"
82974 }
9103n/a ],
10103n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1098ms
Headers
accept-language3 / 3
#validinvalidschema
193n/a{
293n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
63162 {
73162 "type": "null"
83162 }
993n/a ],
1093n/a}
Responses
codedescriptionhitsavg
200Successful Response10813ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
178n/a{
278n/a "anyOf": [
351n/a {
451n/a "type": "string"
551n/a },
62751 {
72751 "type": "null"
82751 }
978n/a ],
1078n/a}
Body
application/json3 / 3
UpdateGroupPreferences
16723{
24010 "properties": {
34010 "privateGroup": {
44010 "type": "boolean"
54010 }
64010 },
77713 "type": "object"
86723}
Responses
codedescriptionhitsavg
200Successful Response6815ms
422Validation Error324ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request221ms
Examples
Body: application/json
trueUpdateGroupPreferences.privateGroup
Headers
accept-language3 / 3
#validinvalidschema
1356n/a{
2356n/a "anyOf": [
3226n/a {
4226n/a "type": "string"
5226n/a },
6130226 {
7130226 "type": "null"
8130226 }
9356n/a ],
10356n/a}
Responses
codedescriptionhitsavg
200Successful Response38126ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1102n/a{
2102n/a "anyOf": [
371n/a {
471n/a "type": "string"
571n/a },
63171 {
73171 "type": "null"
83171 }
9102n/a ],
10102n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Households: Cookbooks 6 operations 5 covered 1 partial 0 uncovered 0 not measured 96% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1197n/a{
2197n/a "anyOf": [
3188n/a {
4188n/a "type": "string"
5188n/a },
69188 {
79188 "type": "null"
89188 }
9197n/a ],
10197n/a}
orderByNullPosition5 / 5
115541{
215541 "anyOf": [
313957 {
513957 },
616180 {
716180 "type": "null"
816180 }
915541 ],
1015541}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
113957{
213957 "enum": [
392n/a "first",
447n/a "last"
513957 ],
6180n/a "type": "string"
713957}
orderDirection2 / 2
OrderDirection
122414{
222414 "enum": [
3134n/a "asc",
490n/a "desc"
522414 ],
6238n/a "type": "string"
722414}
queryFilter3 / 3
1159n/a{
2159n/a "anyOf": [
3144n/a {
4144n/a "type": "string"
5144n/a },
615144 {
715144 "type": "null"
815144 }
9159n/a ],
10159n/a}
paginationSeed3 / 3
1184n/a{
2184n/a "anyOf": [
3171n/a {
4171n/a "type": "string"
5171n/a },
613171 {
713171 "type": "null"
813171 }
9184n/a ],
10184n/a}
page1 / 1
120832{
220832 "type": "integer"
320832}
perPage1 / 1
122127{
222127 "type": "integer"
322127}
Headers
accept-language3 / 3
1374n/a{
2374n/a "anyOf": [
3277n/a {
4277n/a "type": "string"
5277n/a },
697277 {
797277 "type": "null"
897277 }
9374n/a ],
10374n/a}
Responses
codedescriptionhitsavg
200Successful Response27312ms
422Validation Error905ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request988ms
500Internal Server Error1011ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1380n/a{
2380n/a "anyOf": [
3268n/a {
4268n/a "type": "string"
5268n/a },
6112268 {
7112268 "type": "null"
8112268 }
9380n/a ],
10380n/a}
Body
application/json11 / 11
CreateCookBook
140273{
242538 "properties": {
32357 "description": {
42357 "type": "string"
52357 },
64337 "name": {
74337 "type": "string"
84337 },
918911 "position": {
1018911 "type": "integer"
1118911 },
121898 "public": {
131898 "type": "boolean"
141898 },
152047 "queryFilterString": {
162047 "type": "string"
172047 },
182029 "slug": {
192029 "anyOf": [
2013477 {
2113477 "type": "string"
2213477 },
2368143 {
2468143 "type": "null"
2568143 }
262029 ],
272029 }
2842538 },
2944030 "required": [
3044030 "name"
3144030 ],
324705 "type": "object"
3340273}
Responses
codedescriptionhitsavg
201Successful Response25319ms
422Validation Error1715ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request919ms
500Internal Server Error29ms
Examples
Body: application/json
""CreateCookBook.description
1CreateCookBook.position
falseCreateCookBook.public
""CreateCookBook.queryFilterString
Headers
accept-language3 / 3
#validinvalidschema
1153n/a{
2153n/a "anyOf": [
3121n/a {
4121n/a "type": "string"
5121n/a },
632121 {
732121 "type": "null"
832121 }
9153n/a ],
10153n/a}
Body
application/json16 / 19
17880{
27873 "items": {
47873 },
51517 "type": "array"
67880}
Referenced Components (1)17 of 20 keywords
UpdateCookBook17 of 20 keywords
1377109{
240672 "properties": {
32845 "description": {
42845 "type": "string"
52845 },
64698 "groupId": {
74690 "format": "uuid4",
84698 "type": "string"
94698 },
104725 "householdId": {
114720 "format": "uuid4",
124725 "type": "string"
134725 },
144575 "id": {
154570 "format": "uuid4",
164575 "type": "string"
174575 },
184625 "name": {
194625 "type": "string"
204625 },
212916 "position": {
222916 "type": "integer"
232916 },
2425013 "public": {
2525013 "type": "boolean"
2625013 },
272835 "queryFilterString": {
282835 "type": "string"
292835 },
3023923 "slug": {
3123923 "anyOf": [
3287175 {
3387175 "type": "string"
3487175 },
35152110 {
36152110 "type": "null"
37152110 }
3823923 ],
3923923 }
4040672 },
4144929 "required": [
4246711 "name",
434771 "groupId",
444771 "householdId",
4546216 "id"
4644929 ],
474788 "type": "object"
48377109}
Responses
codedescriptionhitsavg
200Successful Response87ms
422Validation Error1525ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error39ms
404Not Found98ms
400Bad Request91ms
Examples
Body: application/json
""UpdateCookBook.description
1UpdateCookBook.position
falseUpdateCookBook.public
""UpdateCookBook.queryFilterString
Path Parameters
item_id1 / 1
#validinvalidschema
166n/a{
266n/a "type": "string"
366n/a}
Headers
accept-language3 / 3
144n/a{
244n/a "anyOf": [
329n/a {
429n/a "type": "string"
529n/a },
61529 {
71529 "type": "null"
81529 }
944n/a ],
1044n/a}
Responses
codedescriptionhitsavg
200Successful Response4419ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request207ms
404Not Found28ms
Path Parameters
item_id4 / 4
#validinvalidschema
1124n/a{
2124n/a "anyOf": [
31168 {
41168 "format": "uuid4",
5124n/a "type": "string"
61168 },
7124n/a {
8124n/a "type": "string"
9124n/a }
10124n/a ],
11124n/a}
Headers
accept-language3 / 3
131n/a{
231n/a "anyOf": [
324n/a {
424n/a "type": "string"
524n/a },
6724 {
7724 "type": "null"
8724 }
931n/a ],
1031n/a}
Responses
codedescriptionhitsavg
200Successful Response1028ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found227ms
Path Parameters
item_id1 / 1
#validinvalidschema
1187n/a{
2187n/a "type": "string"
3187n/a}
Headers
accept-language3 / 3
1101n/a{
2101n/a "anyOf": [
389n/a {
489n/a "type": "string"
589n/a },
61289 {
71289 "type": "null"
81289 }
9101n/a ],
10101n/a}
Body
application/json11 / 11
CreateCookBook
113543{
213637 "properties": {
3557 "description": {
4557 "type": "string"
5557 },
61657 "name": {
71657 "type": "string"
81657 },
9556 "position": {
10556 "type": "integer"
11556 },
12575 "public": {
13575 "type": "boolean"
14575 },
15575 "queryFilterString": {
16575 "type": "string"
17575 },
18489 "slug": {
19489 "anyOf": [
20849 {
21849 "type": "string"
22849 },
234017 {
244017 "type": "null"
254017 }
26489 ],
27489 }
2813637 },
291721 "required": [
301721 "name"
311721 ],
321735 "type": "object"
3313543}
Responses
codedescriptionhitsavg
200Successful Response11420ms
422Validation Error703ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request318ms
Examples
Body: application/json
""CreateCookBook.description
1CreateCookBook.position
falseCreateCookBook.public
""CreateCookBook.queryFilterString
Households: Event Notifications 6 operations 4 covered 2 partial 0 uncovered 0 not measured 94% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1151n/a{
2151n/a "anyOf": [
3147n/a {
4147n/a "type": "string"
5147n/a },
64147 {
74147 "type": "null"
84147 }
9151n/a ],
10151n/a}
orderByNullPosition5 / 5
113828{
213828 "anyOf": [
313036 {
513036 },
68158 {
78158 "type": "null"
88158 }
913828 ],
1013828}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
113036{
213036 "enum": [
375n/a "first",
455n/a "last"
513036 ],
6158n/a "type": "string"
713036}
orderDirection2 / 2
OrderDirection
122314{
222314 "enum": [
3133n/a "asc",
490n/a "desc"
522314 ],
6237n/a "type": "string"
722314}
queryFilter3 / 3
1143n/a{
2143n/a "anyOf": [
3128n/a {
4128n/a "type": "string"
5128n/a },
615128 {
715128 "type": "null"
815128 }
9143n/a ],
10143n/a}
paginationSeed3 / 3
1125n/a{
2125n/a "anyOf": [
3118n/a {
4118n/a "type": "string"
5118n/a },
67118 {
77118 "type": "null"
87118 }
9125n/a ],
10125n/a}
page1 / 1
120121{
220121 "type": "integer"
320121}
perPage1 / 1
118640{
218640 "type": "integer"
318640}
Headers
accept-language3 / 3
1382n/a{
2382n/a "anyOf": [
3276n/a {
4276n/a "type": "string"
5276n/a },
6106276 {
7106276 "type": "null"
8106276 }
9382n/a ],
10382n/a}
Responses
codedescriptionhitsavg
200Successful Response27012ms
422Validation Error745ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request778ms
500Internal Server Error912ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1436n/a{
2436n/a "anyOf": [
3293n/a {
4293n/a "type": "string"
5293n/a },
6143293 {
7143293 "type": "null"
8143293 }
9436n/a ],
10436n/a}
Body
application/json7 / 7
GroupEventNotifierCreate
144568{
246625 "properties": {
331319 "appriseUrl": {
431319 "anyOf": [
5177155 {
6177155 "type": "string"
7177155 },
8136196 {
9136196 "type": "null"
10136196 }
1131319 ],
1231319 },
1345317 "name": {
1445317 "type": "string"
1545317 }
1646625 },
1747038 "required": [
1847038 "name"
1947038 ],
205085 "type": "object"
2144568}
Responses
codedescriptionhitsavg
201Successful Response16816ms
422Validation Error1004ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2879ms
Path Parameters
item_id1 / 2
#validinvalidschema
1600{
2600 "format": "uuid4",
360n/a "type": "string"
4600}
Headers
accept-language3 / 3
119n/a{
219n/a "anyOf": [
316n/a {
416n/a "type": "string"
516n/a },
6316 {
7316 "type": "null"
8316 }
919n/a ],
1019n/a}
Responses
codedescriptionhitsavg
204Successful Response2819ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3218ms
Path Parameters
item_id2 / 2
#validinvalidschema
11096{
21096 "format": "uuid4",
3115n/a "type": "string"
41096}
Headers
accept-language3 / 3
122n/a{
222n/a "anyOf": [
318n/a {
418n/a "type": "string"
518n/a },
6418 {
7418 "type": "null"
8418 }
922n/a ],
1022n/a}
Responses
codedescriptionhitsavg
200Successful Response78ms
422Validation Error67ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1027ms
Path Parameters
item_id1 / 2
#validinvalidschema
13680{
23680 "format": "uuid4",
3368n/a "type": "string"
43680}
Headers
accept-language3 / 3
1286n/a{
2286n/a "anyOf": [
3277n/a {
4277n/a "type": "string"
5277n/a },
69277 {
79277 "type": "null"
89277 }
9286n/a ],
10286n/a}
Body
application/json39 / 42
GroupEventNotifierUpdate
1177175{
2183164 "properties": {
32637 "appriseUrl": {
42637 "anyOf": [
510260 {
610260 "type": "string"
710260 },
825317 {
925317 "type": "null"
1025317 }
112637 ],
122637 },
132585 "enabled": {
142585 "type": "boolean"
152585 },
163415 "groupId": {
173410 "format": "uuid4",
183415 "type": "string"
193415 },
203415 "householdId": {
213410 "format": "uuid4",
223415 "type": "string"
233415 },
243415 "id": {
253410 "format": "uuid4",
263415 "type": "string"
273415 },
283395 "name": {
293395 "type": "string"
303395 },
31133132 "options": {
33133132 }
34183164 },
353416 "required": [
363443 "name",
373461 "groupId",
383461 "householdId",
393461 "id"
403416 ],
413475 "type": "object"
42177175}
Referenced Components (1)28 of 28 keywords
GroupEventNotifierOptions28 of 28 keywords
1133132{
2132127 "properties": {
32175 "categoryCreated": {
42175 "type": "boolean"
52175 },
62175 "categoryDeleted": {
72175 "type": "boolean"
82175 },
92135 "categoryUpdated": {
102135 "type": "boolean"
112135 },
122107 "cookbookCreated": {
132107 "type": "boolean"
142107 },
152095 "cookbookDeleted": {
162095 "type": "boolean"
172095 },
182095 "cookbookUpdated": {
192095 "type": "boolean"
202095 },
212075 "dataExport": {
222075 "type": "boolean"
232075 },
242095 "dataImport": {
252095 "type": "boolean"
262095 },
272065 "dataMigrations": {
282065 "type": "boolean"
292065 },
302105 "labelCreated": {
312105 "type": "boolean"
322105 },
332035 "labelDeleted": {
342035 "type": "boolean"
352035 },
362045 "labelUpdated": {
372045 "type": "boolean"
382045 },
392035 "mealplanEntryCreated": {
402035 "type": "boolean"
412035 },
422015 "recipeCreated": {
432015 "type": "boolean"
442015 },
452025 "recipeDeleted": {
462025 "type": "boolean"
472025 },
482035 "recipeUpdated": {
492035 "type": "boolean"
502035 },
511995 "shoppingListCreated": {
521995 "type": "boolean"
531995 },
542025 "shoppingListDeleted": {
552025 "type": "boolean"
562025 },
571977 "shoppingListUpdated": {
581977 "type": "boolean"
591977 },
601945 "tagCreated": {
611945 "type": "boolean"
621945 },
631965 "tagDeleted": {
641965 "type": "boolean"
651965 },
661925 "tagUpdated": {
671925 "type": "boolean"
681925 },
691925 "testMessage": {
701925 "type": "boolean"
711925 },
722015 "userSignup": {
732015 "type": "boolean"
742015 },
751925 "webhookTask": {
761925 "type": "boolean"
771925 }
78132127 },
792605 "type": "object"
80133132}
Responses
codedescriptionhitsavg
200Successful Response2120ms
422Validation Error1625ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1776ms
404Not Found57ms
400Bad Request31ms
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
119316{
219316 "format": "uuid4",
3209n/a "type": "string"
419316}
Headers
accept-language3 / 3
145n/a{
245n/a "anyOf": [
333n/a {
433n/a "type": "string"
533n/a },
61233 {
71233 "type": "null"
81233 }
945n/a ],
1045n/a}
Responses
codedescriptionhitsavg
204Successful Response0never seen
422Validation Error166ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1936ms
Households: Invitations 3 operations 3 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1129n/a{
2129n/a "anyOf": [
387n/a {
487n/a "type": "string"
587n/a },
64287 {
74287 "type": "null"
84287 }
9129n/a ],
10129n/a}
Responses
codedescriptionhitsavg
200Successful Response10811ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1122n/a{
2122n/a "anyOf": [
395n/a {
495n/a "type": "string"
595n/a },
62795 {
72795 "type": "null"
82795 }
9122n/a ],
10122n/a}
Body
application/json12 / 12
CreateInviteToken
119329{
219421 "properties": {
31989 "groupId": {
41989 "anyOf": [
519710 {
61972 "format": "uuid",
71998 "type": "string"
819710 },
91206 {
101206 "type": "null"
111206 }
121989 ],
131989 },
141989 "householdId": {
151989 "anyOf": [
1619710 {
171972 "format": "uuid",
181998 "type": "string"
1919710 },
201206 {
211206 "type": "null"
221206 }
231989 ],
241989 },
252086 "uses": {
262086 "type": "integer"
272086 }
2819421 },
292143 "required": [
302143 "uses"
312143 ],
322175 "type": "object"
3319329}
Responses
codedescriptionhitsavg
201Successful Response19414ms
422Validation Error442ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request11ms
Headers
accept-language3 / 3
#validinvalidschema
1186n/a{
2186n/a "anyOf": [
3119n/a {
4119n/a "type": "string"
5119n/a },
667119 {
767119 "type": "null"
867119 }
9186n/a ],
10186n/a}
Body
application/json5 / 5
EmailInvitation
116738{
218510 "properties": {
31735 "email": {
41735 "type": "string"
51735 },
61895 "token": {
71895 "type": "string"
81895 }
918510 },
1017718 "required": [
1117817 "email",
121941 "token"
1317718 ],
1419510 "type": "object"
1516738}
Responses
codedescriptionhitsavg
200Successful Response1675ms
422Validation Error553ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request51ms
Households: Mealplan Rules 5 operations 2 covered 3 partial 0 uncovered 0 not measured 94% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1153n/a{
2153n/a "anyOf": [
3145n/a {
4145n/a "type": "string"
5145n/a },
68145 {
78145 "type": "null"
88145 }
9153n/a ],
10153n/a}
orderByNullPosition5 / 5
113740{
213740 "anyOf": [
312750 {
512750 },
610167 {
710167 "type": "null"
810167 }
913740 ],
1013740}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112750{
212750 "enum": [
389n/a "first",
438n/a "last"
512750 ],
6167n/a "type": "string"
712750}
orderDirection2 / 2
OrderDirection
124015{
224015 "enum": [
3147n/a "asc",
493n/a "desc"
524015 ],
6255n/a "type": "string"
724015}
queryFilter3 / 3
1188n/a{
2188n/a "anyOf": [
3179n/a {
4179n/a "type": "string"
5179n/a },
69179 {
79179 "type": "null"
89179 }
9188n/a ],
10188n/a}
paginationSeed3 / 3
1169n/a{
2169n/a "anyOf": [
3163n/a {
4163n/a "type": "string"
5163n/a },
66163 {
76163 "type": "null"
86163 }
9169n/a ],
10169n/a}
page1 / 1
122518{
222518 "type": "integer"
322518}
perPage1 / 1
122429{
222429 "type": "integer"
322429}
Headers
accept-language3 / 3
1391n/a{
2391n/a "anyOf": [
3294n/a {
4294n/a "type": "string"
5294n/a },
697294 {
797294 "type": "null"
897294 }
9391n/a ],
10391n/a}
Responses
codedescriptionhitsavg
200Successful Response32012ms
422Validation Error795ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request798ms
500Internal Server Error3210ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1328n/a{
2328n/a "anyOf": [
3232n/a {
4232n/a "type": "string"
5232n/a },
696232 {
796232 "type": "null"
896232 }
9328n/a ],
10328n/a}
Body
application/json9 / 9
PlanRulesCreate
143653{
224940 "properties": {
319216 "day": {
519216 },
619612 "entryType": {
819612 },
917812 "queryFilterString": {
1017812 "type": "string"
1117812 }
1224940 },
1347613 "type": "object"
1443653}
Referenced Components (2)6 of 6 keywords
PlanRulesDay3 of 3 keywords
119216{
219216 "enum": [
314n/a "monday",
425n/a "tuesday",
514n/a "wednesday",
623n/a "thursday",
713n/a "friday",
86n/a "saturday",
922n/a "sunday",
1075n/a "unset"
1119216 ],
122026 "type": "string"
1319216}
PlanRulesType3 of 3 keywords
119612{
219612 "enum": [
335n/a "breakfast",
434n/a "lunch",
544n/a "dinner",
631n/a "side",
752n/a "unset"
819612 ],
92035 "type": "string"
1019612}
Responses
codedescriptionhitsavg
201Successful Response43152ms
422Validation Error824ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request81ms
Examples
Body: application/json
"unset"PlanRulesCreate.day
"unset"PlanRulesCreate.entryType
""PlanRulesCreate.queryFilterString
Path Parameters
item_id1 / 2
#validinvalidschema
1750{
2750 "format": "uuid4",
375n/a "type": "string"
4750}
Headers
accept-language3 / 3
141n/a{
241n/a "anyOf": [
327n/a {
427n/a "type": "string"
527n/a },
61427 {
71427 "type": "null"
81427 }
941n/a ],
1041n/a}
Responses
codedescriptionhitsavg
200Successful Response6017ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found156ms
Path Parameters
item_id1 / 2
#validinvalidschema
11630{
21630 "format": "uuid4",
3163n/a "type": "string"
41630}
Headers
accept-language3 / 3
171n/a{
271n/a "anyOf": [
345n/a {
445n/a "type": "string"
545n/a },
62645 {
72645 "type": "null"
82645 }
971n/a ],
1071n/a}
Responses
codedescriptionhitsavg
200Successful Response1217ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found428ms
Path Parameters
item_id1 / 2
#validinvalidschema
11790{
21790 "format": "uuid4",
3179n/a "type": "string"
41790}
Headers
accept-language3 / 3
186n/a{
286n/a "anyOf": [
370n/a {
470n/a "type": "string"
570n/a },
61670 {
71670 "type": "null"
81670 }
986n/a ],
1086n/a}
Body
application/json9 / 9
PlanRulesCreate
112328{
25123 "properties": {
3496 "day": {
5496 },
6606 "entryType": {
8606 },
95611 "queryFilterString": {
105611 "type": "string"
115611 }
125123 },
131465 "type": "object"
1412328}
Referenced Components (2)6 of 6 keywords
PlanRulesDay3 of 3 keywords
1496{
2496 "enum": [
31n/a "monday",
41n/a "tuesday",
53n/a "wednesday",
61n/a "thursday",
74n/a "friday",
81n/a "saturday",
99n/a "sunday",
1029n/a "unset"
11496 ],
12505 "type": "string"
13496}
PlanRulesType3 of 3 keywords
1606{
2606 "enum": [
34n/a "breakfast",
412n/a "lunch",
53n/a "dinner",
66n/a "side",
735n/a "unset"
8606 ],
9615 "type": "string"
10606}
Responses
codedescriptionhitsavg
200Successful Response11211ms
422Validation Error523ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found118ms
400Bad Request41ms
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
120038{
220038 "anyOf": [
319345 {
419338 "format": "date",
5231n/a "type": "string"
619345 },
77231 {
87231 "type": "null"
97231 }
1020038 ],
1120038}
end_date4 / 4
119936{
219936 "anyOf": [
319045 {
419036 "format": "date",
5226n/a "type": "string"
619045 },
79226 {
89226 "type": "null"
99226 }
1019936 ],
1119936}
orderBy3 / 3
1176n/a{
2176n/a "anyOf": [
3163n/a {
4163n/a "type": "string"
5163n/a },
613163 {
713163 "type": "null"
813163 }
9176n/a ],
10176n/a}
orderByNullPosition5 / 5
114031{
214031 "anyOf": [
313536 {
513536 },
65166 {
75166 "type": "null"
85166 }
914031 ],
1014031}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
113536{
213536 "enum": [
397n/a "first",
438n/a "last"
513536 ],
6166n/a "type": "string"
713536}
orderDirection2 / 2
OrderDirection
119915{
219915 "enum": [
3135n/a "asc",
464n/a "desc"
519915 ],
6214n/a "type": "string"
719915}
queryFilter3 / 3
1160n/a{
2160n/a "anyOf": [
3150n/a {
4150n/a "type": "string"
5150n/a },
610150 {
710150 "type": "null"
810150 }
9160n/a ],
10160n/a}
paginationSeed3 / 3
1184n/a{
2184n/a "anyOf": [
3172n/a {
4172n/a "type": "string"
5172n/a },
612172 {
712172 "type": "null"
812172 }
9184n/a ],
10184n/a}
page1 / 1
122314{
222314 "type": "integer"
322314}
perPage1 / 1
121322{
221322 "type": "integer"
321322}
Headers
accept-language3 / 3
1438n/a{
2438n/a "anyOf": [
3321n/a {
4321n/a "type": "string"
5321n/a },
6117321 {
7117321 "type": "null"
8117321 }
9438n/a ],
10438n/a}
Responses
codedescriptionhitsavg
200Successful Response33012ms
422Validation Error1085ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request749ms
500Internal Server Error911ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1409n/a{
2409n/a "anyOf": [
3277n/a {
4277n/a "type": "string"
5277n/a },
6132277 {
7132277 "type": "null"
8132277 }
9409n/a ],
10409n/a}
Body
application/json14 / 14
CreatePlanEntry
136047{
236437 "properties": {
338710 "date": {
43875 "format": "date",
53925 "type": "string"
638710 },
72396 "entryType": {
92396 },
102518 "recipeId": {
112518 "anyOf": [
12147112 {
131474 "format": "uuid",
14151108 "type": "string"
15147112 },
16104155 {
17104155 "type": "null"
18104155 }
192518 ],
202518 },
211908 "text": {
221908 "type": "string"
231908 },
242385 "title": {
252385 "type": "string"
262385 }
2736437 },
283975 "required": [
293975 "date"
303975 ],
314025 "type": "object"
3236047}
Referenced Components (1)3 of 3 keywords
PlanEntryType3 of 3 keywords
12396{
22396 "enum": [
379n/a "breakfast",
472n/a "lunch",
537n/a "dinner",
651n/a "side"
72396 ],
82405 "type": "string"
92396}
Responses
codedescriptionhitsavg
201Successful Response13724ms
422Validation Error1987ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error8320ms
400Bad Request131ms
Examples
Body: application/json
"breakfast"CreatePlanEntry.entryType
""CreatePlanEntry.text
""CreatePlanEntry.title
Headers
accept-language3 / 3
#validinvalidschema
1342n/a{
2342n/a "anyOf": [
3236n/a {
4236n/a "type": "string"
5236n/a },
6106236 {
7106236 "type": "null"
8106236 }
9342n/a ],
10342n/a}
Body
application/json8 / 8
CreateRandomEntry
135060{
235938 "properties": {
336325 "date": {
436320 "format": "date",
53835 "type": "string"
636325 },
716413 "entryType": {
916413 }
1035938 },
1138811 "required": [
1238811 "date"
1338811 ],
1439911 "type": "object"
1535060}
Referenced Components (1)3 of 3 keywords
PlanEntryType3 of 3 keywords
116413{
216413 "enum": [
347n/a "breakfast",
432n/a "lunch",
554n/a "dinner",
631n/a "side"
716413 ],
81716 "type": "string"
916413}
Responses
codedescriptionhitsavg
200Successful Response1337ms
422Validation Error1253ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found33820ms
400Bad Request681ms
Examples
Body: application/json
"dinner"CreateRandomEntry.entryType
Headers
accept-language3 / 3
#validinvalidschema
1133n/a{
2133n/a "anyOf": [
391n/a {
491n/a "type": "string"
591n/a },
64291 {
74291 "type": "null"
84291 }
9133n/a ],
10133n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Path Parameters
item_id1 / 1
#validinvalidschema
1507{
2507 "type": "integer"
3507}
Headers
accept-language3 / 3
142n/a{
242n/a "anyOf": [
330n/a {
430n/a "type": "string"
530n/a },
61230 {
71230 "type": "null"
81230 }
942n/a ],
1042n/a}
Responses
codedescriptionhitsavg
200Successful Response3918ms
422Validation Error53ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found115ms
400Bad Request29ms
Path Parameters
item_id1 / 1
#validinvalidschema
11175{
21175 "type": "integer"
31175}
Headers
accept-language3 / 3
132n/a{
232n/a "anyOf": [
323n/a {
423n/a "type": "string"
523n/a },
6923 {
7923 "type": "null"
8923 }
932n/a ],
1032n/a}
Responses
codedescriptionhitsavg
200Successful Response999ms
422Validation Error53ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found186ms
Path Parameters
item_id1 / 1
#validinvalidschema
12407{
22407 "type": "integer"
32407}
Headers
accept-language3 / 3
1159n/a{
2159n/a "anyOf": [
3141n/a {
4141n/a "type": "string"
5141n/a },
618141 {
718141 "type": "null"
818141 }
9159n/a ],
10159n/a}
Body
application/json19 / 19
UpdatePlanEntry
117564{
218054 "properties": {
32266 "date": {
42261 "format": "date",
52275 "type": "string"
62266 },
71097 "entryType": {
91097 },
102266 "groupId": {
112261 "format": "uuid",
122275 "type": "string"
132266 },
1422012 "id": {
1522012 "type": "integer"
1622012 },
1711713 "recipeId": {
1811713 "anyOf": [
199832 {
20982 "format": "uuid",
2110030 "type": "string"
229832 },
2319111 {
2419111 "type": "null"
2519111 }
2611713 ],
2711713 },
289311 "text": {
299311 "type": "string"
309311 },
31985 "title": {
32985 "type": "string"
33985 },
342276 "userId": {
352271 "format": "uuid",
362285 "type": "string"
372276 }
3818054 },
392295 "required": [
402322 "date",
412322 "id",
422322 "groupId",
432331 "userId"
442295 ],
452345 "type": "object"
4617564}
Referenced Components (1)3 of 3 keywords
PlanEntryType3 of 3 keywords
11097{
21097 "enum": [
373n/a "breakfast",
410n/a "lunch",
59n/a "dinner",
617n/a "side"
71097 ],
81115 "type": "string"
91097}
Responses
codedescriptionhitsavg
200Successful Response625ms
422Validation Error1906ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found286ms
400Bad Request2327ms
Examples
Body: application/json
"breakfast"UpdatePlanEntry.entryType
""UpdatePlanEntry.text
""UpdatePlanEntry.title
Households: Recipe Actions 6 operations 2 covered 4 partial 0 uncovered 0 not measured 91% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1116n/a{
2116n/a "anyOf": [
3110n/a {
4110n/a "type": "string"
5110n/a },
66110 {
76110 "type": "null"
86110 }
9116n/a ],
10116n/a}
orderByNullPosition5 / 5
111526{
211526 "anyOf": [
311130 {
511130 },
64137 {
74137 "type": "null"
84137 }
911526 ],
1011526}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
111130{
211130 "enum": [
383n/a "first",
428n/a "last"
511130 ],
6137n/a "type": "string"
711130}
orderDirection2 / 2
OrderDirection
116315{
216315 "enum": [
392n/a "asc",
471n/a "desc"
516315 ],
6178n/a "type": "string"
716315}
queryFilter3 / 3
1124n/a{
2124n/a "anyOf": [
3116n/a {
4116n/a "type": "string"
5116n/a },
68116 {
78116 "type": "null"
88116 }
9124n/a ],
10124n/a}
paginationSeed3 / 3
1126n/a{
2126n/a "anyOf": [
3118n/a {
4118n/a "type": "string"
5118n/a },
68118 {
78118 "type": "null"
88118 }
9126n/a ],
10126n/a}
page1 / 1
115920{
215920 "type": "integer"
315920}
perPage1 / 1
114821{
214821 "type": "integer"
314821}
Headers
accept-language3 / 3
1322n/a{
2322n/a "anyOf": [
3229n/a {
4229n/a "type": "string"
5229n/a },
693229 {
793229 "type": "null"
893229 }
9322n/a ],
10322n/a}
Responses
codedescriptionhitsavg
200Successful Response2869ms
422Validation Error695ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request508ms
500Internal Server Error910ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1283n/a{
2283n/a "anyOf": [
3197n/a {
4197n/a "type": "string"
5197n/a },
686197 {
786197 "type": "null"
886197 }
9283n/a ],
10283n/a}
Body
application/json8 / 8
CreateGroupRecipeAction
133640{
234028 "properties": {
335314 "actionType": {
535314 },
63589 "title": {
73589 "type": "string"
83589 },
935610 "url": {
1035610 "type": "string"
1135610 }
1234028 },
133644 "required": [
143671 "actionType",
153671 "title",
163662 "url"
173644 ],
183688 "type": "object"
1933640}
Referenced Components (1)3 of 3 keywords
GroupRecipeActionType3 of 3 keywords
135314{
235314 "enum": [
3215n/a "link",
4138n/a "post"
535314 ],
63625 "type": "string"
735314}
Responses
codedescriptionhitsavg
201Successful Response33618ms
422Validation Error554ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request161ms
Path Parameters
item_id1 / 2
#validinvalidschema
1890{
2890 "format": "uuid4",
389n/a "type": "string"
4890}
Headers
accept-language3 / 3
168n/a{
268n/a "anyOf": [
340n/a {
440n/a "type": "string"
540n/a },
62840 {
72840 "type": "null"
82840 }
968n/a ],
1068n/a}
Responses
codedescriptionhitsavg
200Successful Response7316ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found166ms
Path Parameters
item_id1 / 2
#validinvalidschema
11690{
21690 "format": "uuid4",
3169n/a "type": "string"
41690}
Headers
accept-language3 / 3
166n/a{
266n/a "anyOf": [
342n/a {
442n/a "type": "string"
542n/a },
62442 {
72442 "type": "null"
82442 }
966n/a ],
1066n/a}
Responses
codedescriptionhitsavg
200Successful Response847ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found858ms
Path Parameters
item_id1 / 2
#validinvalidschema
11670{
21670 "format": "uuid4",
3167n/a "type": "string"
41670}
Headers
accept-language3 / 3
195n/a{
295n/a "anyOf": [
376n/a {
476n/a "type": "string"
576n/a },
61976 {
71976 "type": "null"
81976 }
995n/a ],
1095n/a}
Body
application/json10 / 12
SaveGroupRecipeAction
110940{
211727 "properties": {
31346 "actionType": {
51346 },
61366 "groupId": {
71360 "format": "uuid4",
81366 "type": "string"
91366 },
101385 "householdId": {
111380 "format": "uuid4",
121385 "type": "string"
131385 },
141385 "title": {
151385 "type": "string"
161385 },
171366 "url": {
181366 "type": "string"
191366 }
2011727 },
211368 "required": [
221404 "actionType",
231431 "title",
241422 "url",
251422 "groupId",
261431 "householdId"
271368 ],
281445 "type": "object"
2910940}
Referenced Components (1)3 of 3 keywords
GroupRecipeActionType3 of 3 keywords
11346{
21346 "enum": [
372n/a "link",
462n/a "post"
51346 ],
61355 "type": "string"
71346}
Responses
codedescriptionhitsavg
200Successful Response3216ms
422Validation Error573ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found777ms
400Bad Request11ms
Path Parameters
item_id1 / 2
#validinvalidschema
14530{
24530 "format": "uuid4",
3453n/a "type": "string"
44530}
recipe_slug1 / 1
1453n/a{
2453n/a "type": "string"
3453n/a}
Headers
accept-language3 / 3
1253n/a{
2253n/a "anyOf": [
3179n/a {
4179n/a "type": "string"
5179n/a },
674179 {
774179 "type": "null"
874179 }
9253n/a ],
10253n/a}
Body
application/json3 / 3
Body_trigger_action_api_households_recipe_actions__item_id__trigger__recipe_slug__post
133324{
216911 "properties": {
316911 "recipe_scale": {
416911 "type": "number"
516911 }
616911 },
734413 "type": "object"
833324}
Responses
codedescriptionhitsavg
202Successful Response11751ms
422Validation Error304ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2257ms
404Not Found8110ms
Examples
Body: application/json
1Body_trigger_action_api_households_recipe_actions__item_id__trigger__recipe_slug__post.recipe_scale
Households: Self Service 7 operations 6 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1148n/a{
2148n/a "anyOf": [
3132n/a {
4132n/a "type": "string"
5132n/a },
616132 {
716132 "type": "null"
816132 }
9148n/a ],
10148n/a}
orderByNullPosition5 / 5
111731{
211731 "anyOf": [
311038 {
511038 },
67141 {
77141 "type": "null"
87141 }
911731 ],
1011731}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
111038{
211038 "enum": [
375n/a "first",
435n/a "last"
511038 ],
6141n/a "type": "string"
711038}
orderDirection2 / 2
OrderDirection
121218{
221218 "enum": [
3126n/a "asc",
486n/a "desc"
521218 ],
6230n/a "type": "string"
721218}
queryFilter3 / 3
1162n/a{
2162n/a "anyOf": [
3152n/a {
4152n/a "type": "string"
5152n/a },
610152 {
710152 "type": "null"
810152 }
9162n/a ],
10162n/a}
paginationSeed3 / 3
1160n/a{
2160n/a "anyOf": [
3151n/a {
4151n/a "type": "string"
5151n/a },
69151 {
79151 "type": "null"
89151 }
9160n/a ],
10160n/a}
page1 / 1
118022{
218022 "type": "integer"
318022}
perPage1 / 1
120220{
220220 "type": "integer"
320220}
Headers
accept-language3 / 3
1375n/a{
2375n/a "anyOf": [
3268n/a {
4268n/a "type": "string"
5268n/a },
6107268 {
7107268 "type": "null"
8107268 }
9375n/a ],
10375n/a}
Responses
codedescriptionhitsavg
200Successful Response30214ms
422Validation Error745ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request818ms
500Internal Server Error412ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1101n/a{
2101n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
62180 {
72180 "type": "null"
82180 }
9101n/a ],
10101n/a}
Body
application/json8 / 9
SetPermissions
113431{
213525 "properties": {
3535 "canInvite": {
4535 "type": "boolean"
5535 },
6575 "canManage": {
7575 "type": "boolean"
8575 },
9615 "canManageHousehold": {
10615 "type": "boolean"
11615 },
12475 "canOrganize": {
13475 "type": "boolean"
14475 },
151545 "userId": {
161540 "format": "uuid4",
171545 "type": "string"
181545 }
1913525 },
201591 "required": [
211591 "userId"
221591 ],
231605 "type": "object"
2413431}
Responses
codedescriptionhitsavg
200Successful Response11711ms
422Validation Error372ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found148ms
403Forbidden713ms
Examples
Body: application/json
falseSetPermissions.canInvite
falseSetPermissions.canManage
falseSetPermissions.canManageHousehold
falseSetPermissions.canOrganize
Headers
accept-language3 / 3
#validinvalidschema
198n/a{
298n/a "anyOf": [
365n/a {
465n/a "type": "string"
565n/a },
63365 {
73365 "type": "null"
83365 }
998n/a ],
1098n/a}
Responses
codedescriptionhitsavg
200Successful Response10816ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1128n/a{
2128n/a "anyOf": [
3108n/a {
4108n/a "type": "string"
5108n/a },
620108 {
720108 "type": "null"
820108 }
9128n/a ],
10128n/a}
Body
application/json10 / 10
UpdateHouseholdPreferences
17363{
25552 "properties": {
3816 "firstDayOfWeek": {
4816 "type": "integer"
5816 },
6745 "lockRecipeEditsFromOtherHouseholds": {
7745 "type": "boolean"
8745 },
97310 "privateHousehold": {
107310 "type": "boolean"
117310 },
127211 "recipeDisableComments": {
137211 "type": "boolean"
147211 },
15748 "recipeLandscapeView": {
16748 "type": "boolean"
17748 },
18756 "recipePublic": {
19756 "type": "boolean"
20756 },
21766 "recipeShowAssets": {
22766 "type": "boolean"
23766 },
24676 "recipeShowNutrition": {
25676 "type": "boolean"
26676 }
275552 },
2812511 "type": "object"
297363}
Responses
codedescriptionhitsavg
200Successful Response8013ms
422Validation Error734ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request241ms
500Internal Server Error110ms
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
1269n/a{
2269n/a "anyOf": [
3185n/a {
4185n/a "type": "string"
5185n/a },
684185 {
784185 "type": "null"
884185 }
9269n/a ],
10269n/a}
Responses
codedescriptionhitsavg
200Successful Response34323ms
422Validation Error0never seen
Path Parameters
recipe_slug1 / 1
#validinvalidschema
1135n/a{
2135n/a "type": "string"
3135n/a}
Headers
accept-language3 / 3
148n/a{
248n/a "anyOf": [
331n/a {
431n/a "type": "string"
531n/a },
61731 {
71731 "type": "null"
81731 }
948n/a ],
1048n/a}
Responses
codedescriptionhitsavg
200Successful Response9715ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found388ms
Headers
accept-language3 / 3
#validinvalidschema
1102n/a{
2102n/a "anyOf": [
365n/a {
465n/a "type": "string"
565n/a },
63765 {
73765 "type": "null"
83765 }
9102n/a ],
10102n/a}
Responses
codedescriptionhitsavg
200Successful Response1089ms
422Validation Error0never seen
Households: Shopping List Items 8 operations 3 covered 5 partial 0 uncovered 0 not measured 86% #
Query Parameters
ids3 / 3
#validinvalidschema
15893{
25893 "items": {
3249403 "format": "uuid4",
4652n/a "type": "string"
55893 },
6151n/a "type": "array"
75893}
Headers
accept-language3 / 3
1177n/a{
2177n/a "anyOf": [
3110n/a {
4110n/a "type": "string"
5110n/a },
667110 {
767110 "type": "null"
867110 }
9177n/a ],
10177n/a}
Responses
codedescriptionhitsavg
200Successful Response1108ms
422Validation Error938ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error128ms
Query Parameters
orderBy3 / 3
#validinvalidschema
1154n/a{
2154n/a "anyOf": [
3145n/a {
4145n/a "type": "string"
5145n/a },
69145 {
79145 "type": "null"
89145 }
9154n/a ],
10154n/a}
orderByNullPosition5 / 5
115127{
215127 "anyOf": [
314335 {
514335 },
68170 {
78170 "type": "null"
88170 }
915127 ],
1015127}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
114335{
214335 "enum": [
383n/a "first",
460n/a "last"
514335 ],
6170n/a "type": "string"
714335}
orderDirection2 / 2
OrderDirection
121024{
221024 "enum": [
3131n/a "asc",
479n/a "desc"
521024 ],
6234n/a "type": "string"
721024}
queryFilter3 / 3
1122n/a{
2122n/a "anyOf": [
3116n/a {
4116n/a "type": "string"
5116n/a },
66116 {
76116 "type": "null"
86116 }
9122n/a ],
10122n/a}
paginationSeed3 / 3
1146n/a{
2146n/a "anyOf": [
3138n/a {
4138n/a "type": "string"
5138n/a },
68138 {
78138 "type": "null"
88138 }
9146n/a ],
10146n/a}
page1 / 1
117721{
217721 "type": "integer"
317721}
perPage1 / 1
116920{
216920 "type": "integer"
316920}
Headers
accept-language3 / 3
1412n/a{
2412n/a "anyOf": [
3279n/a {
4279n/a "type": "string"
5279n/a },
6133279 {
7133279 "type": "null"
8133279 }
9412n/a ],
10412n/a}
Responses
codedescriptionhitsavg
200Successful Response32518ms
422Validation Error755ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request749ms
500Internal Server Error915ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1513n/a{
2513n/a "anyOf": [
3495n/a {
4495n/a "type": "string"
5495n/a },
618495 {
718495 "type": "null"
818495 }
9513n/a ],
10513n/a}
Body
application/json161 / 190
ShoppingListItemCreate
1234326{
2235319 "properties": {
35075 "checked": {
45075 "type": "boolean"
55075 },
65055 "display": {
75055 "type": "string"
85055 },
95094 "extras": {
105094 "anyOf": [
1145162 {
121n/a "additionalProperties": true,
1345162 "type": "object"
1445162 },
1558455 {
1658455 "type": "null"
1758455 }
185094 ],
195094 },
20397117 "food": {
21397117 "anyOf": [
2238476 {
2438476 },
2552462 {
2752462 },
28345169 {
29345169 "type": "null"
30345169 }
31397117 ],
32397117 },
335054 "foodId": {
345054 "anyOf": [
3544465 {
364440 "format": "uuid4",
3744465 "type": "string"
3844465 },
3961448 {
4061448 "type": "null"
4161448 }
425054 ],
435054 },
445074 "id": {
455074 "anyOf": [
4649714 {
474970 "format": "uuid4",
4849714 "type": "string"
4949714 },
5010501 {
5110501 "type": "null"
5210501 }
535074 ],
545074 },
555054 "labelId": {
565054 "anyOf": [
5744465 {
584440 "format": "uuid4",
5944465 "type": "string"
6044465 },
6161448 {
6261448 "type": "null"
6361448 }
645054 ],
655054 },
665054 "note": {
675054 "anyOf": [
685009 {
695009 "type": "string"
705009 },
715504 {
725504 "type": "null"
735504 }
745054 ],
755054 },
764996 "position": {
774996 "type": "integer"
784996 },
795015 "quantity": {
805015 "type": "number"
815015 },
8247237 "recipeReferences": {
8347232 "items": {
8547232 },
865045 "type": "array"
8747237 },
885485 "shoppingListId": {
895480 "format": "uuid4",
905485 "type": "string"
915485 },
92383121 "unit": {
93383121 "anyOf": [
9443461 {
9643461 },
97120384 {
99120384 },
100263241 {
101263241 "type": "null"
102263241 }
103383121 ],
104383121 },
1054484 "unitId": {
1064484 "anyOf": [
10743319 {
1084330 "format": "uuid4",
10943319 "type": "string"
11043319 },
11115437 {
11215437 "type": "null"
11315437 }
1144484 ],
1154484 }
116235319 },
1175532 "required": [
1185532 "shoppingListId"
1195532 ],
1205555 "type": "object"
121234326}
Referenced Components (10)158 of 189 keywords
CreateIngredientFood28 of 30 keywords
152462{
254110 "properties": {
311232 "aliases": {
411222 "items": {
611222 },
713410 "type": "array"
811232 },
913310 "description": {
1013310 "type": "string"
1113310 },
121348 "extras": {
131348 "anyOf": [
1412616 {
151n/a "additionalProperties": true,
1612616 "type": "object"
1712616 },
188134 {
198134 "type": "null"
208134 }
211348 ],
221348 },
2311526 "householdsWithIngredientFood": {
2411516 "items": {
25838 "type": "string"
2611516 },
2713110 "type": "array"
2811526 },
291428 "id": {
301428 "anyOf": [
3114010 {
321400 "format": "uuid4",
3314010 "type": "string"
3414010 },
352148 {
362148 "type": "null"
372148 }
381428 ],
391428 },
401278 "labelId": {
411278 "anyOf": [
4212411 {
431240 "format": "uuid4",
4412411 "type": "string"
4512411 },
463132 {
473132 "type": "null"
483132 }
491278 ],
501278 },
5115210 "name": {
5215210 "type": "string"
5315210 },
541258 "pluralName": {
551258 "anyOf": [
565128 {
575128 "type": "string"
585128 },
5912013 {
6012013 "type": "null"
6112013 }
621258 ],
631258 }
6454110 },
651623 "required": [
661623 "name"
671623 ],
68165349 "type": "object"
6952462}
CreateIngredientFoodAlias6 of 6 keywords
11022{
21010 "properties": {
31010 "name": {
41010 "type": "string"
51010 }
61010 },
7202 "required": [
8202 "name"
9202 ],
102210 "type": "object"
111022}
CreateIngredientUnit29 of 30 keywords
1120384{
2122114 "properties": {
320010 "abbreviation": {
420010 "type": "string"
520010 },
612132 "aliases": {
712122 "items": {
912122 },
1014310 "type": "array"
1112132 },
1219510 "description": {
1319510 "type": "string"
1419510 },
151978 "extras": {
161978 "anyOf": [
1714065 {
181n/a "additionalProperties": true,
1914065 "type": "object"
2014065 },
2157148 {
2257148 "type": "null"
2357148 }
241978 ],
251978 },
2619710 "fraction": {
2719710 "type": "boolean"
2819710 },
291538 "id": {
301538 "anyOf": [
3115110 {
321510 "format": "uuid4",
3315110 "type": "string"
3415110 },
352159 {
362159 "type": "null"
372159 }
381538 ],
391538 },
4022410 "name": {
4122410 "type": "string"
4222410 },
431358 "pluralAbbreviation": {
441358 "anyOf": [
4513211 {
4613211 "type": "string"
4713211 },
483140 {
493140 "type": "null"
503140 }
511358 ],
521358 },
531328 "pluralName": {
541328 "anyOf": [
554136 {
564136 "type": "string"
574136 },
5812812 {
5912812 "type": "null"
6012812 }
611328 ],
621328 },
6312610 "useAbbreviation": {
6412610 "type": "boolean"
6512610 }
66122114 },
672343 "required": [
682343 "name"
692343 ],
70237267 "type": "object"
71120384}
CreateIngredientUnitAlias6 of 6 keywords
12222{
22210 "properties": {
32210 "name": {
42210 "type": "string"
52210 }
62210 },
7322 "required": [
8322 "name"
9322 ],
103410 "type": "object"
112222}
IngredientFood-Input31 of 41 keywords
138476{
252112 "properties": {
311232 "aliases": {
411222 "items": {
611222 },
713410 "type": "array"
811232 },
9710 "createdAt": {
10710 "anyOf": [
11701 {
12700 "format": "date-time",
13701 "type": "string"
14701 },
15170 {
16170 "type": "null"
17170 }
18710 ],
19710 },
2013310 "description": {
2113310 "type": "string"
2213310 },
231348 "extras": {
241348 "anyOf": [
2512616 {
261n/a "additionalProperties": true,
2712616 "type": "object"
2812616 },
298134 {
308134 "type": "null"
318134 }
321348 ],
331348 },
3411526 "householdsWithIngredientFood": {
3511516 "items": {
36838 "type": "string"
3711516 },
3813110 "type": "array"
3911526 },
4014010 "id": {
411400 "format": "uuid4",
4214010 "type": "string"
4314010 },
44670 "label": {
45670 "anyOf": [
46265 {
48265 },
49652 {
50652 "type": "null"
51652 }
52670 ]
53670 },
541278 "labelId": {
551278 "anyOf": [
5612411 {
571240 "format": "uuid4",
5812411 "type": "string"
5912411 },
603132 {
613132 "type": "null"
623132 }
631278 ],
641278 },
6515210 "name": {
6615210 "type": "string"
6715210 },
681258 "pluralName": {
691258 "anyOf": [
705128 {
715128 "type": "string"
725128 },
7312013 {
7412013 "type": "null"
7512013 }
761258 ],
771258 },
78650 "update_at": {
79650 "anyOf": [
80641 {
81640 "format": "date-time",
82641 "type": "string"
83641 },
84164 {
85164 "type": "null"
86164 }
87650 ],
88650 }
8952112 },
9014817 "required": [
9115015 "id",
921623 "name"
9314817 ],
94165349 "type": "object"
9538476}
IngredientFoodAlias6 of 6 keywords
11022{
21010 "properties": {
31010 "name": {
41010 "type": "string"
51010 }
61010 },
7202 "required": [
8202 "name"
9202 ],
102210 "type": "object"
111022}
IngredientUnit-Input30 of 37 keywords
143461{
2120116 "properties": {
320010 "abbreviation": {
420010 "type": "string"
520010 },
612132 "aliases": {
712122 "items": {
912122 },
1014310 "type": "array"
1112132 },
12770 "createdAt": {
13770 "anyOf": [
14743 {
15740 "format": "date-time",
16743 "type": "string"
17743 },
18374 {
19374 "type": "null"
20374 }
21770 ],
22770 },
2319510 "description": {
2419510 "type": "string"
2519510 },
261978 "extras": {
271978 "anyOf": [
2814065 {
291n/a "additionalProperties": true,
3014065 "type": "object"
3114065 },
3257148 {
3357148 "type": "null"
3457148 }
351978 ],
361978 },
3719710 "fraction": {
3819710 "type": "boolean"
3919710 },
4015110 "id": {
411510 "format": "uuid4",
4215110 "type": "string"
4315110 },
4422410 "name": {
4522410 "type": "string"
4622410 },
471358 "pluralAbbreviation": {
481358 "anyOf": [
4913211 {
5013211 "type": "string"
5113211 },
523140 {
533140 "type": "null"
543140 }
551358 ],
561358 },
571328 "pluralName": {
581328 "anyOf": [
594136 {
604136 "type": "string"
614136 },
6212812 {
6312812 "type": "null"
6412812 }
651328 ],
661328 },
67710 "update_at": {
68710 "anyOf": [
69701 {
70700 "format": "date-time",
71701 "type": "string"
72701 },
73170 {
74170 "type": "null"
75170 }
76710 ],
77710 },
7812610 "useAbbreviation": {
7912610 "type": "boolean"
8012610 }
81120116 },
8215978 "required": [
8316176 "id",
842343 "name"
8515978 ],
86237267 "type": "object"
8743461}
IngredientUnitAlias6 of 6 keywords
12222{
22210 "properties": {
32210 "name": {
42210 "type": "string"
52210 }
62210 },
7322 "required": [
8322 "name"
9322 ],
103410 "type": "object"
112222}
MultiPurposeLabelSummary1 of 11 keywords
1265{
220 "properties": {
310 "color": {
410 "type": "string"
510 },
620 "groupId": {
720 "format": "uuid4",
820 "type": "string"
920 },
1020 "id": {
1120 "format": "uuid4",
1220 "type": "string"
1320 },
1420 "name": {
1520 "type": "string"
1620 }
1720 },
1820 "required": [
1920 "name",
2020 "groupId",
2120 "id"
2220 ],
23265 "type": "object"
24265}
ShoppingListItemRecipeRefCreate15 of 16 keywords
17240{
27332 "properties": {
3995 "recipeId": {
4990 "format": "uuid4",
5995 "type": "string"
6995 },
75618 "recipeNote": {
85618 "anyOf": [
91856 {
101856 "type": "string"
111856 },
123836 {
133836 "type": "null"
143836 }
155618 ],
165618 },
17605 "recipeQuantity": {
18605 "type": "number"
19605 },
20614 "recipeScale": {
21614 "anyOf": [
224223 {
234223 "type": "number"
244223 },
251946 {
261946 "type": "null"
271946 }
28614 ],
29614 }
307332 },
311043 "required": [
321043 "recipeId"
331043 ],
341075 "type": "object"
357240}
Responses
codedescriptionhitsavg
201Successful Response6210ms
422Validation Error2853ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error22810ms
400Bad Request41ms
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
11076n/a{
21076n/a "anyOf": [
31040n/a {
41040n/a "type": "string"
51040n/a },
6361040 {
7361040 "type": "null"
8361040 }
91076n/a ],
101076n/a}
Body
application/json177 / 208
1351719{
2351708 "items": {
4351708 },
5105911 "type": "array"
6351719}
Referenced Components (12)225 of 261 keywords
CreateIngredientFood28 of 30 keywords
1181884{
2185209 "properties": {
324764 "aliases": {
424744 "items": {
624744 },
729120 "type": "array"
824764 },
929120 "description": {
1029120 "type": "string"
1129120 },
1228716 "extras": {
1328716 "anyOf": [
1426142 {
151n/a "additionalProperties": true,
1626142 "type": "object"
1726142 },
1826277 {
1926277 "type": "null"
2026277 }
2128716 ],
2228716 },
2326240 "householdsWithIngredientFood": {
2426220 "items": {
257020 "type": "string"
2626220 },
2728220 "type": "array"
2826240 },
2933217 "id": {
3033217 "anyOf": [
3131633 {
323160 "format": "uuid4",
3331633 "type": "string"
3431633 },
3516333 {
3616333 "type": "null"
3716333 }
3833217 ],
3933217 },
4027216 "labelId": {
4127216 "anyOf": [
4225236 {
432520 "format": "uuid4",
4425236 "type": "string"
4525236 },
4620268 {
4720268 "type": "null"
4820268 }
4927216 ],
5027216 },
5137020 "name": {
5237020 "type": "string"
5337020 },
5426916 "pluralName": {
5526916 "anyOf": [
5618267 {
5718267 "type": "string"
5818267 },
5925134 {
6025134 "type": "null"
6125134 }
6226916 ],
6326916 }
64185209 },
653906 "required": [
663906 "name"
673906 ],
68396669 "type": "object"
69181884}
CreateIngredientFoodAlias6 of 6 keywords
113144{
213120 "properties": {
313120 "name": {
413120 "type": "string"
513120 }
613120 },
71514 "required": [
81514 "name"
91514 ],
1015520 "type": "object"
1113144}
CreateIngredientUnit29 of 30 keywords
1154897{
2159277 "properties": {
331920 "abbreviation": {
431920 "type": "string"
531920 },
627366 "aliases": {
727346 "items": {
927346 },
1031920 "type": "array"
1127366 },
1231320 "description": {
1331320 "type": "string"
1431320 },
1532247 "extras": {
1632247 "anyOf": [
1728584 {
181n/a "additionalProperties": true,
1928584 "type": "object"
2028584 },
2137332 {
2237332 "type": "null"
2337332 }
2432247 ],
2532247 },
2629820 "fraction": {
2729820 "type": "boolean"
2829820 },
2934816 "id": {
3034816 "anyOf": [
3133232 {
323320 "format": "uuid4",
3333232 "type": "string"
3433232 },
3516348 {
3616348 "type": "null"
3716348 }
3834816 ],
3934816 },
4041120 "name": {
4141120 "type": "string"
4241120 },
4329931 "pluralAbbreviation": {
4429931 "anyOf": [
4527159 {
4627159 "type": "string"
4727159 },
4828302 {
4928302 "type": "null"
5028302 }
5129931 ],
5229931 },
5329217 "pluralName": {
5429217 "anyOf": [
5520289 {
5620289 "type": "string"
5720289 },
5827237 {
5927237 "type": "null"
6027237 }
6129217 ],
6229217 },
6329120 "useAbbreviation": {
6429120 "type": "boolean"
6529120 }
66159277 },
674317 "required": [
684317 "name"
694317 ],
70438613 "type": "object"
71154897}
CreateIngredientUnitAlias6 of 6 keywords
118857{
218820 "properties": {
318820 "name": {
418820 "type": "string"
518820 }
618820 },
720817 "required": [
820817 "name"
920817 ],
1022520 "type": "object"
1118857}
IngredientFood-Input35 of 41 keywords
196969{
2145249 "properties": {
324764 "aliases": {
424744 "items": {
624744 },
729120 "type": "array"
824764 },
91601 "createdAt": {
101601 "anyOf": [
1115011 {
121500 "format": "date-time",
1315011 "type": "string"
1415011 },
1510151 {
1610151 "type": "null"
1710151 }
181601 ],
191601 },
2029120 "description": {
2129120 "type": "string"
2229120 },
2328716 "extras": {
2428716 "anyOf": [
2526142 {
261n/a "additionalProperties": true,
2726142 "type": "object"
2826142 },
2926277 {
3026277 "type": "null"
3126277 }
3228716 ],
3328716 },
3426240 "householdsWithIngredientFood": {
3526220 "items": {
367020 "type": "string"
3726220 },
3828220 "type": "array"
3926240 },
4031633 "id": {
413160 "format": "uuid4",
4231633 "type": "string"
4331633 },
4414423 "label": {
4514423 "anyOf": [
4610157 {
4810157 },
4913433 {
5013433 "type": "null"
5113433 }
5214423 ]
5314423 },
5427216 "labelId": {
5527216 "anyOf": [
5625236 {
572520 "format": "uuid4",
5825236 "type": "string"
5925236 },
6020268 {
6120268 "type": "null"
6220268 }
6327216 ],
6427216 },
6537020 "name": {
6637020 "type": "string"
6737020 },
6826916 "pluralName": {
6926916 "anyOf": [
7018267 {
7118267 "type": "string"
7218267 },
7325134 {
7425134 "type": "null"
7525134 }
7626916 ],
7726916 },
781470 "update_at": {
791470 "anyOf": [
801398 {
811390 "format": "date-time",
821398 "type": "string"
831398 },
848139 {
858139 "type": "null"
868139 }
871470 ],
881470 }
89145249 },
9034551 "required": [
9134947 "id",
923906 "name"
9334551 ],
94396669 "type": "object"
9596969}
IngredientFoodAlias6 of 6 keywords
113144{
213120 "properties": {
313120 "name": {
413120 "type": "string"
513120 }
613120 },
71514 "required": [
81514 "name"
91514 ],
1015520 "type": "object"
1113144}
IngredientUnit-Input30 of 37 keywords
1107944{
2144292 "properties": {
331920 "abbreviation": {
431920 "type": "string"
531920 },
627366 "aliases": {
727346 "items": {
927346 },
1031920 "type": "array"
1127366 },
121730 "createdAt": {
131730 "anyOf": [
1415617 {
151560 "format": "date-time",
1615617 "type": "string"
1715617 },
1817156 {
1917156 "type": "null"
2017156 }
211730 ],
221730 },
2331320 "description": {
2431320 "type": "string"
2531320 },
2632247 "extras": {
2732247 "anyOf": [
2828584 {
291n/a "additionalProperties": true,
3028584 "type": "object"
3128584 },
3237332 {
3337332 "type": "null"
3437332 }
3532247 ],
3632247 },
3729820 "fraction": {
3829820 "type": "boolean"
3929820 },
4033232 "id": {
413320 "format": "uuid4",
4233232 "type": "string"
4333232 },
4441120 "name": {
4541120 "type": "string"
4641120 },
4729931 "pluralAbbreviation": {
4829931 "anyOf": [
4927159 {
5027159 "type": "string"
5127159 },
5228302 {
5328302 "type": "null"
5428302 }
5529931 ],
5629931 },
5729217 "pluralName": {
5829217 "anyOf": [
5920289 {
6020289 "type": "string"
6120289 },
6227237 {
6327237 "type": "null"
6427237 }
6529217 ],
6629217 },
671520 "update_at": {
681520 "anyOf": [
691448 {
701440 "format": "date-time",
711448 "type": "string"
721448 },
738144 {
748144 "type": "null"
758144 }
761520 ],
771520 },
7829120 "useAbbreviation": {
7929120 "type": "boolean"
8029120 }
81144292 },
8236078 "required": [
8336474 "id",
844317 "name"
8536078 ],
86438613 "type": "object"
87107944}
IngredientUnitAlias6 of 6 keywords
118857{
218820 "properties": {
318820 "name": {
418820 "type": "string"
518820 }
618820 },
720817 "required": [
820817 "name"
920817 ],
1022520 "type": "object"
1118857}
MultiPurposeLabelSummary1 of 11 keywords
110157{
2100 "properties": {
340 "color": {
440 "type": "string"
540 },
6100 "groupId": {
7100 "format": "uuid4",
8100 "type": "string"
9100 },
10100 "id": {
11100 "format": "uuid4",
12100 "type": "string"
13100 },
14100 "name": {
15100 "type": "string"
16100 }
17100 },
18100 "required": [
19100 "name",
20100 "groupId",
21100 "id"
22100 ],
2310157 "type": "object"
2410157}
ShoppingListItemRecipeRefCreate15 of 16 keywords
1392114{
239682 "properties": {
344529 "recipeId": {
44450 "format": "uuid4",
544529 "type": "string"
644529 },
726016 "recipeNote": {
826016 "anyOf": [
985191 {
1085191 "type": "string"
1185191 },
12175101 {
13175101 "type": "null"
14175101 }
1526016 ],
1626016 },
1725021 "recipeQuantity": {
1825021 "type": "number"
1925021 },
2026316 "recipeScale": {
2126316 "anyOf": [
22162117 {
23162117 "type": "number"
24162117 },
25101178 {
26101178 "type": "null"
27101178 }
2826316 ],
2926316 }
3039682 },
314744 "required": [
324744 "recipeId"
334744 ],
3447828 "type": "object"
35392114}
ShoppingListItemRecipeRefUpdate15 of 20 keywords
1183323{
239682 "properties": {
32310 "id": {
42310 "format": "uuid4",
52310 "type": "string"
62310 },
744529 "recipeId": {
84450 "format": "uuid4",
944529 "type": "string"
1044529 },
1126016 "recipeNote": {
1226016 "anyOf": [
1385191 {
1485191 "type": "string"
1585191 },
16175101 {
17175101 "type": "null"
18175101 }
1926016 ],
2026016 },
2125021 "recipeQuantity": {
2225021 "type": "number"
2325021 },
2426316 "recipeScale": {
2526316 "anyOf": [
26162117 {
27162117 "type": "number"
28162117 },
29101178 {
30101178 "type": "null"
31101178 }
3226316 ],
3326316 },
342310 "shoppingListItemId": {
352310 "format": "uuid4",
362310 "type": "string"
372310 }
3839682 },
39229249 "required": [
404744 "recipeId",
41231247 "id",
42231247 "shoppingListItemId"
43229249 ],
4447828 "type": "object"
45183323}
ShoppingListItemUpdateBulk48 of 52 keywords
1492754{
2506730 "properties": {
3102710 "checked": {
4102710 "type": "boolean"
5102710 },
6102710 "display": {
7102710 "type": "string"
8102710 },
910188 "extras": {
1010188 "anyOf": [
1198343 {
121n/a "additionalProperties": true,
1398343 "type": "object"
1498343 },
1535991 {
1635991 "type": "null"
1735991 }
1810188 ],
1910188 },
20837228 "food": {
21837228 "anyOf": [
2296969 {
2496969 },
25181884 {
27181884 },
28656409 {
29656409 "type": "null"
30656409 }
31837228 ],
32837228 },
339988 "foodId": {
349988 "anyOf": [
3595155 {
369510 "format": "uuid4",
3795155 "type": "string"
3895155 },
3947959 {
4047959 "type": "null"
4147959 }
429988 ],
439988 },
44122410 "id": {
4512240 "format": "uuid4",
46122410 "type": "string"
47122410 },
4810068 "labelId": {
4910068 "anyOf": [
5096153 {
519610 "format": "uuid4",
5296153 "type": "string"
5396153 },
5445969 {
5545969 "type": "null"
5645969 }
5710068 ],
5810068 },
5998811 "note": {
6098811 "anyOf": [
6194851 {
6294851 "type": "string"
6394851 },
6440959 {
6540959 "type": "null"
6640959 }
6798811 ],
6898811 },
69100212 "position": {
70100212 "type": "integer"
71100212 },
72100810 "quantity": {
73100810 "type": "number"
74100810 },
75903104 "recipeReferences": {
7690394 "items": {
77392114 "anyOf": [
78392114 {
80392114 },
81183323 {
83183323 }
84392114 ]
8590394 },
8699710 "type": "array"
87903104 },
88121410 "shoppingListId": {
8912140 "format": "uuid4",
90121410 "type": "string"
91121410 },
92756295 "unit": {
93756295 "anyOf": [
94107944 {
96107944 },
97154897 {
99154897 },
100602449 {
101602449 "type": "null"
102602449 }
103756295 ],
104756295 },
10597912 "unitId": {
10697912 "anyOf": [
10794843 {
1089484 "format": "uuid4",
10995239 "type": "string"
11094843 },
11131960 {
11231960 "type": "null"
11331960 }
11497912 ],
11597912 }
116506730 },
117122214 "required": [
118122412 "shoppingListId",
11912342 "id"
120122214 ],
121123610 "type": "object"
122492754}
Responses
codedescriptionhitsavg
200Successful Response5014ms
422Validation Error6176ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error41815ms
400Bad Request91ms
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
1718n/a{
2718n/a "anyOf": [
3630n/a {
4630n/a "type": "string"
5630n/a },
688630 {
788630 "type": "null"
888630 }
9718n/a ],
10718n/a}
Body
application/json170 / 192
1417400{
2417394 "items": {
4417394 },
58116 "type": "array"
6417400}
Referenced Components (11)215 of 241 keywords
CreateIngredientFood28 of 30 keywords
1321567{
2323154 "properties": {
327636 "aliases": {
427626 "items": {
627626 },
730210 "type": "array"
827636 },
928811 "description": {
1028811 "type": "string"
1128811 },
1229312 "extras": {
1329312 "anyOf": [
14202103 {
151n/a "additionalProperties": true,
16202103 "type": "object"
17202103 },
1891214 {
1991214 "type": "null"
2091214 }
2129312 ],
2229312 },
2328234 "householdsWithIngredientFood": {
2428221 "items": {
2593950 "type": "string"
2628221 },
2730313 "type": "array"
2828234 },
293938 "id": {
303938 "anyOf": [
3135447 {
323540 "format": "uuid4",
3335447 "type": "string"
3435447 },
3539362 {
3639362 "type": "null"
3739362 }
383938 ],
393938 },
4028811 "labelId": {
4128811 "anyOf": [
4220495 {
432040 "format": "uuid4",
4420495 "type": "string"
4520495 },
4684215 {
4784215 "type": "null"
4884215 }
4928811 ],
5028811 },
5145421 "name": {
5245421 "type": "string"
5345421 },
5428324 "pluralName": {
5528324 "anyOf": [
5670237 {
5770237 "type": "string"
5870237 },
5921394 {
6021394 "type": "null"
6121394 }
6228324 ],
6328324 }
64323154 },
654753 "required": [
664753 "name"
674753 ],
68478410 "type": "object"
69321567}
CreateIngredientFoodAlias6 of 6 keywords
186848{
286836 "properties": {
386836 "name": {
486836 "type": "string"
586836 }
686836 },
79042 "required": [
89042 "name"
99042 ],
1090610 "type": "object"
1186848}
CreateIngredientUnit29 of 30 keywords
1300586{
2302152 "properties": {
326520 "abbreviation": {
426520 "type": "string"
526520 },
623440 "aliases": {
723425 "items": {
923425 },
1025915 "type": "array"
1123440 },
1226710 "description": {
1326710 "type": "string"
1426710 },
1526723 "extras": {
1626723 "anyOf": [
1719694 {
181n/a "additionalProperties": true,
1919694 "type": "object"
2019694 },
2171219 {
2271219 "type": "null"
2371219 }
2426723 ],
2526723 },
2626810 "fraction": {
2726810 "type": "boolean"
2826810 },
2936410 "id": {
3036410 "anyOf": [
3132351 {
323230 "format": "uuid4",
3332351 "type": "string"
3432351 },
3541333 {
3641333 "type": "null"
3741333 }
3836410 ],
3936410 },
4044210 "name": {
4144210 "type": "string"
4244210 },
432588 "pluralAbbreviation": {
442588 "anyOf": [
4519571 {
4619571 "type": "string"
4719571 },
4863203 {
4963203 "type": "null"
5063203 }
512588 ],
522588 },
5326911 "pluralName": {
5426911 "anyOf": [
5567213 {
5667213 "type": "string"
5767213 },
5820278 {
5920278 "type": "null"
6020278 }
6126911 ],
6226911 },
6325710 "useAbbreviation": {
6425710 "type": "boolean"
6525710 }
66302152 },
674523 "required": [
684523 "name"
694523 ],
70455431 "type": "object"
71300586}
CreateIngredientUnitAlias6 of 6 keywords
156445{
256410 "properties": {
356410 "name": {
456410 "type": "string"
556410 }
656410 },
75742 "required": [
85742 "name"
95742 ],
1057633 "type": "object"
1156445}
IngredientFood-Input33 of 41 keywords
1214674{
2287190 "properties": {
327636 "aliases": {
427626 "items": {
627626 },
730210 "type": "array"
827636 },
91790 "createdAt": {
101790 "anyOf": [
1112455 {
121240 "format": "date-time",
1312455 "type": "string"
1412455 },
1555124 {
1655124 "type": "null"
1755124 }
181790 ],
191790 },
2028811 "description": {
2128811 "type": "string"
2228811 },
2329312 "extras": {
2429312 "anyOf": [
25202103 {
261n/a "additionalProperties": true,
27202103 "type": "object"
28202103 },
2991214 {
3091214 "type": "null"
3191214 }
3229312 ],
3329312 },
3428234 "householdsWithIngredientFood": {
3528221 "items": {
3693950 "type": "string"
3728221 },
3830313 "type": "array"
3928234 },
4035447 "id": {
413540 "format": "uuid4",
4235447 "type": "string"
4335447 },
441613 "label": {
451613 "anyOf": [
4637127 {
4837127 },
4912440 {
5012440 "type": "null"
5112440 }
521613 ]
531613 },
5428811 "labelId": {
5528811 "anyOf": [
5620495 {
572040 "format": "uuid4",
5820495 "type": "string"
5920495 },
6084215 {
6184215 "type": "null"
6284215 }
6328811 ],
6428811 },
6545421 "name": {
6645421 "type": "string"
6745421 },
6828324 "pluralName": {
6928324 "anyOf": [
7070237 {
7170237 "type": "string"
7270237 },
7321394 {
7421394 "type": "null"
7521394 }
7628324 ],
7728324 },
781670 "update_at": {
791670 "anyOf": [
8010364 {
811030 "format": "date-time",
8210364 "type": "string"
8310364 },
8464103 {
8564103 "type": "null"
8664103 }
871670 ],
881670 }
89287190 },
9039979 "required": [
9140177 "id",
924753 "name"
9339979 ],
94478410 "type": "object"
95214674}
IngredientFoodAlias6 of 6 keywords
186848{
286836 "properties": {
386836 "name": {
486836 "type": "string"
586836 }
686836 },
79042 "required": [
89042 "name"
99042 ],
1090610 "type": "object"
1186848}
IngredientUnit-Input33 of 37 keywords
1178708{
2260194 "properties": {
326520 "abbreviation": {
426520 "type": "string"
526520 },
623440 "aliases": {
723425 "items": {
923425 },
1025915 "type": "array"
1123440 },
121380 "createdAt": {
131380 "anyOf": [
149642 {
15960 "format": "date-time",
169642 "type": "string"
179642 },
184296 {
194296 "type": "null"
204296 }
211380 ],
221380 },
2326710 "description": {
2426710 "type": "string"
2526710 },
2626723 "extras": {
2726723 "anyOf": [
2819694 {
291n/a "additionalProperties": true,
3019694 "type": "object"
3119694 },
3271219 {
3371219 "type": "null"
3471219 }
3526723 ],
3626723 },
3726810 "fraction": {
3826810 "type": "boolean"
3926810 },
4032351 "id": {
413230 "format": "uuid4",
4232351 "type": "string"
4332351 },
4444210 "name": {
4544210 "type": "string"
4644210 },
472588 "pluralAbbreviation": {
482588 "anyOf": [
4919571 {
5019571 "type": "string"
5119571 },
5263203 {
5363203 "type": "null"
5463203 }
552588 ],
562588 },
5726911 "pluralName": {
5826911 "anyOf": [
5967213 {
6067213 "type": "string"
6167213 },
6220278 {
6320278 "type": "null"
6420278 }
6526911 ],
6626911 },
671361 "update_at": {
681361 "anyOf": [
6910037 {
701001 "format": "date-time",
7110136 "type": "string"
7210037 },
7336101 {
7436101 "type": "null"
7536101 }
761361 ],
771361 },
7825710 "useAbbreviation": {
7925710 "type": "boolean"
8025710 }
81260194 },
8237283 "required": [
8337481 "id",
844523 "name"
8537283 ],
86455431 "type": "object"
87178708}
IngredientUnitAlias6 of 6 keywords
156445{
256410 "properties": {
356410 "name": {
456410 "type": "string"
556410 }
656410 },
75742 "required": [
85742 "name"
95742 ],
1057633 "type": "object"
1156445}
MultiPurposeLabelSummary4 of 11 keywords
137127{
2373 "properties": {
3240 "color": {
4240 "type": "string"
5240 },
6400 "groupId": {
7400 "format": "uuid4",
8400 "type": "string"
9400 },
10373 "id": {
11370 "format": "uuid4",
12373 "type": "string"
13373 },
14400 "name": {
15400 "type": "string"
16400 }
17373 },
18400 "required": [
19400 "name",
20400 "groupId",
21400 "id"
22400 ],
2340124 "type": "object"
2437127}
ShoppingListItemCreate49 of 52 keywords
11079469{
21106435 "properties": {
38737 "checked": {
48737 "type": "boolean"
58737 },
68355 "display": {
78355 "type": "string"
88355 },
982318 "extras": {
1082318 "anyOf": [
11643198 {
121n/a "additionalProperties": true,
13643198 "type": "object"
14643198 },
15180661 {
16180661 "type": "null"
17180661 }
1882318 ],
1982318 },
20727161 "food": {
21727161 "anyOf": [
22214674 {
24214674 },
25321567 {
27321567 },
28406482 {
29406482 "type": "null"
30406482 }
31727161 ],
32727161 },
3381519 "foodId": {
3481519 "anyOf": [
35618216 {
3661814 "format": "uuid4",
37632202 "type": "string"
38618216 },
39197637 {
40197637 "type": "null"
41197637 }
4281519 ],
4381519 },
4483311 "id": {
4583311 "anyOf": [
46631213 {
476314 "format": "uuid4",
48635209 "type": "string"
49631213 },
50202642 {
51202642 "type": "null"
52202642 }
5383311 ],
5483311 },
5582313 "labelId": {
5682313 "anyOf": [
57625211 {
586250 "format": "uuid4",
59625211 "type": "string"
60625211 },
61198638 {
62198638 "type": "null"
63198638 }
6482313 ],
6582313 },
668258 "note": {
678258 "anyOf": [
68639194 {
69639194 "type": "string"
70639194 },
71186647 {
72186647 "type": "null"
73186647 }
748258 ],
758258 },
7682416 "position": {
7782416 "type": "integer"
7882416 },
7983810 "quantity": {
8083810 "type": "number"
8183810 },
8278157 "recipeReferences": {
8378150 "items": {
8578150 },
868317 "type": "array"
8778157 },
8815095 "shoppingListId": {
8915090 "format": "uuid4",
9015095 "type": "string"
9115095 },
92727159 "unit": {
93727159 "anyOf": [
94178708 {
96178708 },
97300586 {
99300586 },
100427459 {
101427459 "type": "null"
102427459 }
103727159 ],
104727159 },
1058284 "unitId": {
1068284 "anyOf": [
107645187 {
1086450 "format": "uuid4",
109645187 "type": "string"
110645187 },
111183649 {
112183649 "type": "null"
113183649 }
1148284 ],
1158284 }
1161106435 },
117151429 "required": [
118151429 "shoppingListId"
119151429 ],
12015435 "type": "object"
1211079469}
ShoppingListItemRecipeRefCreate15 of 16 keywords
11666113{
2167297 "properties": {
317585 "recipeId": {
417580 "format": "uuid4",
517585 "type": "string"
617585 },
785323 "recipeNote": {
885323 "anyOf": [
9428448 {
10428448 "type": "string"
11428448 },
12425451 {
13425451 "type": "null"
14425451 }
1585323 ],
1685323 },
1785338 "recipeQuantity": {
1885338 "type": "number"
1985338 },
2083931 "recipeScale": {
2183931 "anyOf": [
22400470 {
23400470 "type": "number"
24400470 },
25439431 {
26439431 "type": "null"
27439431 }
2883931 ],
2983931 }
30167297 },
31176311 "required": [
32176311 "recipeId"
33176311 ],
3417745 "type": "object"
351666113}
Responses
codedescriptionhitsavg
201Successful Response727ms
422Validation Error3584ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error41222ms
400Bad Request231ms
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
1730{
2730 "format": "uuid4",
373n/a "type": "string"
4730}
Headers
accept-language3 / 3
150n/a{
250n/a "anyOf": [
336n/a {
436n/a "type": "string"
536n/a },
61436 {
71436 "type": "null"
81436 }
950n/a ],
1050n/a}
Responses
codedescriptionhitsavg
200Successful Response3418ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error3921ms
Path Parameters
item_id2 / 2
#validinvalidschema
11304{
21304 "format": "uuid4",
3134n/a "type": "string"
41304}
Headers
accept-language3 / 3
157n/a{
257n/a "anyOf": [
339n/a {
439n/a "type": "string"
539n/a },
61839 {
71839 "type": "null"
81839 }
957n/a ],
1057n/a}
Responses
codedescriptionhitsavg
200Successful Response3711ms
422Validation Error47ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found938ms
Path Parameters
item_id1 / 2
#validinvalidschema
16140{
26140 "format": "uuid4",
3614n/a "type": "string"
46140}
Headers
accept-language3 / 3
1516n/a{
2516n/a "anyOf": [
3507n/a {
4507n/a "type": "string"
5507n/a },
69507 {
79507 "type": "null"
89507 }
9516n/a ],
10516n/a}
Body
application/json171 / 204
ShoppingListItemUpdate
1262336{
2263330 "properties": {
34795 "checked": {
44795 "type": "boolean"
54795 },
64795 "display": {
74795 "type": "string"
84795 },
94664 "extras": {
104664 "anyOf": [
114646 {
121n/a "additionalProperties": true,
134646 "type": "object"
144646 },
152468 {
162468 "type": "null"
172468 }
184664 ],
194664 },
20370115 "food": {
21370115 "anyOf": [
2246439 {
2446439 },
2560425 {
2760425 },
28310175 {
29310175 "type": "null"
30310175 }
31370115 ],
32370115 },
334724 "foodId": {
344724 "anyOf": [
3546214 {
364620 "format": "uuid4",
3746214 "type": "string"
3846214 },
3910466 {
4010466 "type": "null"
4110466 }
424724 ],
434724 },
444724 "labelId": {
454724 "anyOf": [
4645818 {
474580 "format": "uuid4",
4845818 "type": "string"
4945818 },
5014462 {
5114462 "type": "null"
5214462 }
534724 ],
544724 },
554674 "note": {
564674 "anyOf": [
574638 {
584638 "type": "string"
594638 },
604467 {
614467 "type": "null"
624467 }
634674 ],
644674 },
654746 "position": {
664746 "type": "integer"
674746 },
684665 "quantity": {
694665 "type": "number"
704665 },
7142048 "recipeReferences": {
7242043 "items": {
737643 "anyOf": [
747643 {
767643 },
773287 {
793287 }
807643 ]
8142043 },
824635 "type": "array"
8342048 },
845875 "shoppingListId": {
855870 "format": "uuid4",
865875 "type": "string"
875875 },
88348121 "unit": {
89348121 "anyOf": [
9045424 {
9245424 },
9363406 {
9563406 },
96285184 {
97285184 "type": "null"
98285184 }
99348121 ],
100348121 },
1014724 "unitId": {
1024724 "anyOf": [
10346115 {
1044610 "format": "uuid4",
10546115 "type": "string"
10646115 },
10711465 {
10811465 "type": "null"
10911465 }
1104724 ],
1114724 }
112263330 },
1135921 "required": [
1145921 "shoppingListId"
1155921 ],
1165935 "type": "object"
117262336}
Referenced Components (11)173 of 209 keywords
CreateIngredientFood28 of 30 keywords
160425{
262108 "properties": {
311532 "aliases": {
411522 "items": {
611522 },
713710 "type": "array"
811532 },
913610 "description": {
1013610 "type": "string"
1113610 },
121358 "extras": {
131358 "anyOf": [
1412518 {
151n/a "additionalProperties": true,
1612518 "type": "object"
1712518 },
1810133 {
1910133 "type": "null"
2010133 }
211358 ],
221358 },
2312324 "householdsWithIngredientFood": {
2412314 "items": {
252526 "type": "string"
2612314 },
2713710 "type": "array"
2812324 },
291518 "id": {
301518 "anyOf": [
3114811 {
321480 "format": "uuid4",
3314811 "type": "string"
3414811 },
353156 {
363156 "type": "null"
373156 }
381518 ],
391518 },
401308 "labelId": {
411308 "anyOf": [
4212513 {
431250 "format": "uuid4",
4412513 "type": "string"
4512513 },
465133 {
475133 "type": "null"
485133 }
491308 ],
501308 },
5115810 "name": {
5215810 "type": "string"
5315810 },
541278 "pluralName": {
551278 "anyOf": [
5610125 {
5710125 "type": "string"
5810125 },
5911718 {
6011718 "type": "null"
6111718 }
621278 ],
631278 }
6462108 },
651683 "required": [
661683 "name"
671683 ],
68171314 "type": "object"
6960425}
CreateIngredientFoodAlias6 of 6 keywords
1722{
2710 "properties": {
3710 "name": {
4710 "type": "string"
5710 }
6710 },
7172 "required": [
8172 "name"
9172 ],
101910 "type": "object"
11722}
CreateIngredientUnit29 of 30 keywords
163406{
265114 "properties": {
314810 "abbreviation": {
414810 "type": "string"
514810 },
612632 "aliases": {
712622 "items": {
912622 },
1014810 "type": "array"
1112632 },
1214510 "description": {
1314510 "type": "string"
1414510 },
151458 "extras": {
161458 "anyOf": [
1714211 {
181n/a "additionalProperties": true,
1914211 "type": "object"
2014211 },
213150 {
223150 "type": "null"
233150 }
241458 ],
251458 },
2614110 "fraction": {
2714110 "type": "boolean"
2814110 },
291548 "id": {
301548 "anyOf": [
311539 {
321530 "format": "uuid4",
331539 "type": "string"
341539 },
351161 {
361161 "type": "null"
371161 }
381548 ],
391548 },
4016710 "name": {
4116710 "type": "string"
4216710 },
431418 "pluralAbbreviation": {
441418 "anyOf": [
4513316 {
4613316 "type": "string"
4713316 },
488141 {
498141 "type": "null"
508141 }
511418 ],
521418 },
531398 "pluralName": {
541398 "anyOf": [
556141 {
566141 "type": "string"
576141 },
5813314 {
5913314 "type": "null"
6013314 }
611398 ],
621398 },
6313210 "useAbbreviation": {
6413210 "type": "boolean"
6513210 }
6665114 },
671773 "required": [
681773 "name"
691773 ],
70180289 "type": "object"
7163406}
CreateIngredientUnitAlias6 of 6 keywords
16022{
26010 "properties": {
36010 "name": {
46010 "type": "string"
56010 }
66010 },
7702 "required": [
8702 "name"
9702 ],
107210 "type": "object"
116022}
IngredientFood-Input31 of 41 keywords
146439{
259111 "properties": {
311532 "aliases": {
411522 "items": {
611522 },
713710 "type": "array"
811532 },
9790 "createdAt": {
10790 "anyOf": [
11781 {
12780 "format": "date-time",
13781 "type": "string"
14781 },
15178 {
16178 "type": "null"
17178 }
18790 ],
19790 },
2013610 "description": {
2113610 "type": "string"
2213610 },
231358 "extras": {
241358 "anyOf": [
2512518 {
261n/a "additionalProperties": true,
2712518 "type": "object"
2812518 },
2910133 {
3010133 "type": "null"
3110133 }
321358 ],
331358 },
3412324 "householdsWithIngredientFood": {
3512314 "items": {
362526 "type": "string"
3712314 },
3813710 "type": "array"
3912324 },
4014811 "id": {
411480 "format": "uuid4",
4214811 "type": "string"
4314811 },
44750 "label": {
45750 "anyOf": [
46372 {
48372 },
49723 {
50723 "type": "null"
51723 }
52750 ]
53750 },
541308 "labelId": {
551308 "anyOf": [
5612513 {
571250 "format": "uuid4",
5812513 "type": "string"
5912513 },
605133 {
615133 "type": "null"
625133 }
631308 ],
641308 },
6515810 "name": {
6615810 "type": "string"
6715810 },
681278 "pluralName": {
691278 "anyOf": [
7010125 {
7110125 "type": "string"
7210125 },
7311718 {
7411718 "type": "null"
7511718 }
761278 ],
771278 },
78720 "update_at": {
79720 "anyOf": [
80711 {
81710 "format": "date-time",
82711 "type": "string"
83711 },
84171 {
85171 "type": "null"
86171 }
87720 ],
88720 }
8959111 },
9015714 "required": [
9115912 "id",
921683 "name"
9315714 ],
94171314 "type": "object"
9546439}
IngredientFoodAlias6 of 6 keywords
1722{
2710 "properties": {
3710 "name": {
4710 "type": "string"
5710 }
6710 },
7172 "required": [
8172 "name"
9172 ],
101910 "type": "object"
11722}
IngredientUnit-Input30 of 37 keywords
145424{
264115 "properties": {
314810 "abbreviation": {
414810 "type": "string"
514810 },
612632 "aliases": {
712622 "items": {
912622 },
1014810 "type": "array"
1112632 },
12780 "createdAt": {
13780 "anyOf": [
14762 {
15760 "format": "date-time",
16762 "type": "string"
17762 },
18276 {
19276 "type": "null"
20276 }
21780 ],
22780 },
2314510 "description": {
2414510 "type": "string"
2514510 },
261458 "extras": {
271458 "anyOf": [
2814211 {
291n/a "additionalProperties": true,
3014211 "type": "object"
3114211 },
323150 {
333150 "type": "null"
343150 }
351458 ],
361458 },
3714110 "fraction": {
3814110 "type": "boolean"
3914110 },
401539 "id": {
411530 "format": "uuid4",
421539 "type": "string"
431539 },
4416710 "name": {
4516710 "type": "string"
4616710 },
471418 "pluralAbbreviation": {
481418 "anyOf": [
4913316 {
5013316 "type": "string"
5113316 },
528141 {
538141 "type": "null"
548141 }
551418 ],
561418 },
571398 "pluralName": {
581398 "anyOf": [
596141 {
606141 "type": "string"
616141 },
6213314 {
6313314 "type": "null"
6413314 }
651398 ],
661398 },
67730 "update_at": {
68730 "anyOf": [
69703 {
70700 "format": "date-time",
71703 "type": "string"
72703 },
73370 {
74370 "type": "null"
75370 }
76730 ],
77730 },
7813210 "useAbbreviation": {
7913210 "type": "boolean"
8013210 }
8164115 },
8216020 "required": [
8316218 "id",
841773 "name"
8516020 ],
86180289 "type": "object"
8745424}
IngredientUnitAlias6 of 6 keywords
16022{
26010 "properties": {
36010 "name": {
46010 "type": "string"
56010 }
66010 },
7702 "required": [
8702 "name"
9702 ],
107210 "type": "object"
116022}
MultiPurposeLabelSummary1 of 11 keywords
1372{
230 "properties": {
320 "color": {
420 "type": "string"
520 },
630 "groupId": {
730 "format": "uuid4",
830 "type": "string"
930 },
1030 "id": {
1130 "format": "uuid4",
1230 "type": "string"
1330 },
1430 "name": {
1530 "type": "string"
1630 }
1730 },
1830 "required": [
1930 "name",
2030 "groupId",
2130 "id"
2230 ],
23372 "type": "object"
24372}
ShoppingListItemRecipeRefCreate15 of 16 keywords
17643{
27836 "properties": {
310210 "recipeId": {
41020 "format": "uuid4",
510210 "type": "string"
610210 },
7728 "recipeNote": {
8728 "anyOf": [
91961 {
101961 "type": "string"
111961 },
125327 {
135327 "type": "null"
145327 }
15728 ],
16728 },
177010 "recipeQuantity": {
187010 "type": "number"
197010 },
20738 "recipeScale": {
21738 "anyOf": [
225625 {
235625 "type": "number"
245625 },
251764 {
261764 "type": "null"
271764 }
28738 ],
29738 }
307836 },
311122 "required": [
321122 "recipeId"
331122 ],
341145 "type": "object"
357643}
ShoppingListItemRecipeRefUpdate15 of 20 keywords
13287{
27836 "properties": {
3510 "id": {
4510 "format": "uuid4",
5510 "type": "string"
6510 },
710210 "recipeId": {
81020 "format": "uuid4",
910210 "type": "string"
1010210 },
11728 "recipeNote": {
12728 "anyOf": [
131961 {
141961 "type": "string"
151961 },
165327 {
175327 "type": "null"
185327 }
19728 ],
20728 },
217010 "recipeQuantity": {
227010 "type": "number"
237010 },
24738 "recipeScale": {
25738 "anyOf": [
265625 {
275625 "type": "number"
285625 },
291764 {
301764 "type": "null"
311764 }
32738 ],
33738 },
34510 "shoppingListItemId": {
35510 "format": "uuid4",
36510 "type": "string"
37510 }
387836 },
395064 "required": [
401122 "recipeId",
415163 "id",
425163 "shoppingListItemId"
435064 ],
441145 "type": "object"
453287}
Responses
codedescriptionhitsavg
200Successful Response7213ms
422Validation Error2913ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error24515ms
400Bad Request61ms
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 3 covered 6 partial 0 uncovered 0 not measured 88% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1123n/a{
2123n/a "anyOf": [
3119n/a {
4119n/a "type": "string"
5119n/a },
64119 {
74119 "type": "null"
84119 }
9123n/a ],
10123n/a}
orderByNullPosition5 / 5
114933{
214933 "anyOf": [
314438 {
514438 },
65177 {
75177 "type": "null"
85177 }
914933 ],
1014933}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
114438{
214438 "enum": [
377n/a "first",
467n/a "last"
514438 ],
6177n/a "type": "string"
714438}
orderDirection2 / 2
OrderDirection
121015{
221015 "enum": [
3141n/a "asc",
469n/a "desc"
521015 ],
6225n/a "type": "string"
721015}
queryFilter3 / 3
1172n/a{
2172n/a "anyOf": [
3164n/a {
4164n/a "type": "string"
5164n/a },
68164 {
78164 "type": "null"
88164 }
9172n/a ],
10172n/a}
paginationSeed3 / 3
1112n/a{
2112n/a "anyOf": [
3109n/a {
4109n/a "type": "string"
5109n/a },
63109 {
73109 "type": "null"
83109 }
9112n/a ],
10112n/a}
page1 / 1
120916{
220916 "type": "integer"
320916}
perPage1 / 1
121115{
221115 "type": "integer"
321115}
Headers
accept-language3 / 3
1338n/a{
2338n/a "anyOf": [
3261n/a {
4261n/a "type": "string"
5261n/a },
677261 {
777261 "type": "null"
877261 }
9338n/a ],
10338n/a}
Responses
codedescriptionhitsavg
200Successful Response19020ms
422Validation Error685ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request598ms
500Internal Server Error137239ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1342n/a{
2342n/a "anyOf": [
3231n/a {
4231n/a "type": "string"
5231n/a },
6111231 {
7111231 "type": "null"
8111231 }
9342n/a ],
10342n/a}
Body
application/json17 / 17
ShoppingListCreate
145156{
227746 "properties": {
322422 "createdAt": {
422422 "anyOf": [
518363 {
618310 "format": "date-time",
719353 "type": "string"
818363 },
941205 {
1041205 "type": "null"
1141205 }
1222422 ],
1322422 },
1421911 "extras": {
1521911 "anyOf": [
1614189 {
171n/a "additionalProperties": true,
1814189 "type": "object"
1914189 },
2078152 {
2178152 "type": "null"
2278152 }
2321911 ],
2421911 },
2521010 "name": {
2621010 "anyOf": [
2714575 {
2814575 "type": "string"
2914575 },
3065155 {
3165155 "type": "null"
3265155 }
3321010 ],
3421010 },
3523020 "update_at": {
3623020 "anyOf": [
3718169 {
381819 "format": "date-time",
3919060 "type": "string"
4018169 },
4149201 {
4249201 "type": "null"
4349201 }
4423020 ],
4523020 }
4627746 },
4749710 "type": "object"
4845156}
Responses
codedescriptionhitsavg
201Successful Response37594ms
422Validation Error644ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error9211ms
400Bad Request111ms
Examples
Body: application/json
{}ShoppingListCreate.extras
Path Parameters
item_id1 / 2
#validinvalidschema
1670{
2670 "format": "uuid4",
367n/a "type": "string"
4670}
Headers
accept-language3 / 3
134n/a{
234n/a "anyOf": [
321n/a {
421n/a "type": "string"
521n/a },
61321 {
71321 "type": "null"
81321 }
934n/a ],
1034n/a}
Responses
codedescriptionhitsavg
200Successful Response3630ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1910ms
400Bad Request1215ms
Path Parameters
item_id2 / 2
#validinvalidschema
11137{
21137 "format": "uuid4",
3120n/a "type": "string"
41137}
Headers
accept-language3 / 3
138n/a{
238n/a "anyOf": [
327n/a {
427n/a "type": "string"
527n/a },
61127 {
71127 "type": "null"
81127 }
938n/a ],
1038n/a}
Responses
codedescriptionhitsavg
200Successful Response6413ms
422Validation Error78ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2514ms
404Not Found249ms
Path Parameters
item_id1 / 2
#validinvalidschema
16360{
26360 "format": "uuid4",
3636n/a "type": "string"
46360}
Headers
accept-language3 / 3
1639n/a{
2639n/a "anyOf": [
3579n/a {
4579n/a "type": "string"
5579n/a },
660579 {
760579 "type": "null"
860579 }
9639n/a ],
10639n/a}
Body
application/json157 / 175
ShoppingListUpdate
1192427{
2245368 "properties": {
35106 "createdAt": {
45106 "anyOf": [
550511 {
65052 "format": "date-time",
75079 "type": "string"
850511 },
95511 {
105511 "type": "null"
115511 }
125106 ],
135106 },
145084 "extras": {
155084 "anyOf": [
1649913 {
171n/a "additionalProperties": true,
1849913 "type": "object"
1949913 },
209503 {
219503 "type": "null"
229503 }
235084 ],
245084 },
255575 "groupId": {
265570 "format": "uuid4",
275575 "type": "string"
285575 },
296075 "id": {
306070 "format": "uuid4",
316075 "type": "string"
326075 },
33171333 "listItems": {
34171328 "items": {
36171328 },
374995 "type": "array"
38171333 },
395064 "name": {
405064 "anyOf": [
4121489 {
4221489 "type": "string"
4321489 },
4448525 {
4548525 "type": "null"
4648525 }
475064 ],
485064 },
495486 "update_at": {
505486 "anyOf": [
5154113 {
525412 "format": "date-time",
5354311 "type": "string"
5454113 },
557547 {
567547 "type": "null"
577547 }
585486 ],
595486 },
606075 "userId": {
616070 "format": "uuid4",
626075 "type": "string"
636075 }
64245368 },
6556053 "required": [
6656251 "groupId",
676121 "userId",
686121 "id"
6956053 ],
706136 "type": "object"
71192427}
Referenced Components (7)171 of 186 keywords
IngredientFood-Input39 of 41 keywords
136392{
23893 "properties": {
310216 "aliases": {
410211 "items": {
610211 },
71135 "type": "array"
810216 },
91106 "createdAt": {
101106 "anyOf": [
111097 {
121092 "format": "date-time",
131115 "type": "string"
141097 },
151115 {
161115 "type": "null"
171115 }
181106 ],
191106 },
201105 "description": {
211105 "type": "string"
221105 },
231134 "extras": {
241134 "anyOf": [
251089 {
261n/a "additionalProperties": true,
271089 "type": "object"
281089 },
295112 {
305112 "type": "null"
315112 }
321134 ],
331134 },
3410110 "householdsWithIngredientFood": {
351015 "items": {
3645 "type": "string"
371015 },
381065 "type": "array"
3910110 },
401255 "id": {
411250 "format": "uuid4",
421255 "type": "string"
431255 },
448428 "label": {
458428 "anyOf": [
462110 {
482110 },
498230 {
508230 "type": "null"
518230 }
528428 ]
538428 },
541084 "labelId": {
551084 "anyOf": [
561057 {
571050 "format": "uuid4",
581057 "type": "string"
591057 },
603109 {
613109 "type": "null"
623109 }
631084 ],
641084 },
651255 "name": {
661255 "type": "string"
671255 },
681054 "pluralName": {
691054 "anyOf": [
703106 {
713106 "type": "string"
723106 },
731027 {
741027 "type": "null"
751027 }
761054 ],
771054 },
781026 "update_at": {
791026 "anyOf": [
801008 {
811002 "format": "date-time",
821026 "type": "string"
831008 },
842106 {
852106 "type": "null"
862106 }
871026 ],
881026 }
893893 },
901293 "required": [
911302 "id",
921302 "name"
931293 ],
94132296 "type": "object"
9536392}
IngredientFoodAlias6 of 6 keywords
11911{
2195 "properties": {
3195 "name": {
4195 "type": "string"
5195 }
6195 },
7241 "required": [
8241 "name"
9241 ],
10255 "type": "object"
111911}
IngredientUnit-Input36 of 37 keywords
144380{
24670 "properties": {
3905 "abbreviation": {
4905 "type": "string"
5905 },
67816 "aliases": {
77811 "items": {
97811 },
10895 "type": "array"
117816 },
12896 "createdAt": {
13896 "anyOf": [
148510 {
15852 "format": "date-time",
16878 "type": "string"
178510 },
18491 {
19491 "type": "null"
20491 }
21896 ],
22896 },
23895 "description": {
24895 "type": "string"
25895 },
26884 "extras": {
27884 "anyOf": [
28857 {
291n/a "additionalProperties": true,
30857 "type": "object"
31857 },
32389 {
33389 "type": "null"
34389 }
35884 ],
36884 },
37875 "fraction": {
38875 "type": "boolean"
39875 },
401105 "id": {
411100 "format": "uuid4",
421105 "type": "string"
431105 },
441105 "name": {
451105 "type": "string"
461105 },
47864 "pluralAbbreviation": {
48864 "anyOf": [
49828 {
50828 "type": "string"
51828 },
52486 {
53486 "type": "null"
54486 }
55864 ],
56864 },
57864 "pluralName": {
58864 "anyOf": [
59684 {
60684 "type": "string"
61684 },
628010 {
638010 "type": "null"
648010 }
65864 ],
66864 },
67826 "update_at": {
68826 "anyOf": [
69799 {
70792 "format": "date-time",
71817 "type": "string"
72799 },
73385 {
74385 "type": "null"
75385 }
76826 ],
77826 },
78825 "useAbbreviation": {
79825 "type": "boolean"
80825 }
814670 },
821143 "required": [
831152 "id",
841152 "name"
851143 ],
86117307 "type": "object"
8744380}
IngredientUnitAlias6 of 6 keywords
1911{
295 "properties": {
395 "name": {
495 "type": "string"
595 }
695 },
7141 "required": [
8141 "name"
9141 ],
10155 "type": "object"
11911}
MultiPurposeLabelSummary9 of 11 keywords
117532{
22340 "properties": {
34810 "color": {
44810 "type": "string"
54810 },
65110 "groupId": {
7510 "format": "uuid4",
85110 "type": "string"
95110 },
105110 "id": {
11510 "format": "uuid4",
125110 "type": "string"
135110 },
145110 "name": {
155110 "type": "string"
165110 }
172340 },
18578 "required": [
19614 "name",
20614 "groupId",
21614 "id"
22578 ],
2365484 "type": "object"
2417532}
ShoppingListItemOut-Input58 of 65 keywords
1184328{
2188319 "properties": {
34315 "checked": {
44315 "type": "boolean"
54315 },
64266 "createdAt": {
74266 "anyOf": [
841220 {
94122 "format": "date-time",
1041418 "type": "string"
1141220 },
1214418 {
1314418 "type": "null"
1414418 }
154266 ],
164266 },
174285 "display": {
184285 "type": "string"
194285 },
204314 "extras": {
214314 "anyOf": [
2241718 {
231n/a "additionalProperties": true,
2441718 "type": "object"
2541718 },
2614421 {
2714421 "type": "null"
2814421 }
294314 ],
304314 },
31328100 "food": {
32328100 "anyOf": [
3336392 {
3536392 },
36292136 {
37292136 "type": "null"
38292136 }
39328100 ]
40328100 },
414314 "foodId": {
424314 "anyOf": [
4341223 {
444120 "format": "uuid4",
4541223 "type": "string"
4641223 },
4719416 {
4819416 "type": "null"
4919416 }
504314 ],
514314 },
525015 "groupId": {
535010 "format": "uuid4",
545015 "type": "string"
555015 },
565015 "householdId": {
575010 "format": "uuid4",
585015 "type": "string"
595015 },
605015 "id": {
615010 "format": "uuid4",
625015 "type": "string"
635015 },
6440928 "label": {
6540928 "anyOf": [
6615422 {
6815422 },
6939443 {
7039443 "type": "null"
7139443 }
7240928 ]
7340928 },
744254 "labelId": {
754254 "anyOf": [
7641415 {
774140 "format": "uuid4",
7841415 "type": "string"
7941415 },
8011418 {
8111418 "type": "null"
8211418 }
834254 ],
844254 },
854244 "note": {
864244 "anyOf": [
8741414 {
8841414 "type": "string"
8941414 },
9010418 {
9110418 "type": "null"
9210418 }
934244 ],
944244 },
954206 "position": {
964206 "type": "integer"
974206 },
984205 "quantity": {
994205 "type": "number"
1004205 },
10138341 "recipeReferences": {
10238336 "items": {
10438336 },
1054195 "type": "array"
10638341 },
1075015 "shoppingListId": {
1085010 "format": "uuid4",
1095015 "type": "string"
1105015 },
11134777 "unit": {
11234777 "anyOf": [
11344380 {
11544380 },
116303121 {
117303121 "type": "null"
118303121 }
11934777 ]
12034777 },
1214224 "unitId": {
1224224 "anyOf": [
12340818 {
1244080 "format": "uuid4",
12540818 "type": "string"
12640818 },
12714412 {
12814412 "type": "null"
12914412 }
1304224 ],
1314224 },
1324186 "update_at": {
1334186 "anyOf": [
13440321 {
1354032 "format": "date-time",
13640519 "type": "string"
13740321 },
13815409 {
13915409 "type": "null"
14015409 }
1414186 ],
1424186 }
143188319 },
1445034 "required": [
1455061 "shoppingListId",
1465061 "id",
1475061 "groupId",
1485061 "householdId"
1495034 ],
1505075 "type": "object"
151184328}
ShoppingListItemRecipeRefOut17 of 20 keywords
112736{
213028 "properties": {
31525 "id": {
41520 "format": "uuid4",
51525 "type": "string"
61525 },
71525 "recipeId": {
81520 "format": "uuid4",
91525 "type": "string"
101525 },
11944 "recipeNote": {
12944 "anyOf": [
133167 {
143167 "type": "string"
153167 },
166335 {
176335 "type": "null"
186335 }
19944 ],
20944 },
21895 "recipeQuantity": {
22895 "type": "number"
23895 },
24924 "recipeScale": {
25924 "anyOf": [
266432 {
276432 "type": "number"
286432 },
292868 {
302868 "type": "null"
312868 }
32924 ],
33924 },
341525 "shoppingListItemId": {
351520 "format": "uuid4",
361525 "type": "string"
371525 }
3813028 },
391553 "required": [
401571 "recipeId",
411571 "id",
421571 "shoppingListItemId"
431553 ],
441585 "type": "object"
4512736}
Responses
codedescriptionhitsavg
200Successful Response442ms
422Validation Error4083ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1715ms
500Internal Server Error2212ms
400Bad Request3151ms
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_id1 / 2
#validinvalidschema
11610{
21610 "format": "uuid4",
3161n/a "type": "string"
41610}
Headers
accept-language3 / 3
178n/a{
278n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
61068 {
71068 "type": "null"
81068 }
978n/a ],
1078n/a}
Body
application/json9 / 12
17134{
27129 "items": {
47129 },
51005 "type": "array"
67134}
Referenced Components (1)9 of 12 keywords
ShoppingListMultiPurposeLabelUpdate9 of 12 keywords
127829{
228121 "properties": {
32965 "id": {
42960 "format": "uuid4",
52965 "type": "string"
62965 },
72965 "labelId": {
82960 "format": "uuid4",
92965 "type": "string"
102965 },
111766 "position": {
121766 "type": "integer"
131766 },
142965 "shoppingListId": {
152960 "format": "uuid4",
162965 "type": "string"
172965 }
1828121 },
192993 "required": [
203011 "shoppingListId",
213011 "labelId",
223011 "id"
232993 ],
243025 "type": "object"
2527829}
Responses
codedescriptionhitsavg
200Successful Response316ms
422Validation Error622ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request845ms
500Internal Server Error1114ms
404Not Found19ms
Examples
Body: application/json
0ShoppingListMultiPurposeLabelUpdate.position
Path Parameters
item_id1 / 2
#validinvalidschema
17440{
27440 "format": "uuid4",
3744n/a "type": "string"
47440}
Headers
accept-language3 / 3
1614n/a{
2614n/a "anyOf": [
3548n/a {
4548n/a "type": "string"
5548n/a },
666548 {
766548 "type": "null"
866548 }
9614n/a ],
10614n/a}
Body
application/json149 / 173
1407298{
2407293 "items": {
4407293 },
57005 "type": "array"
6407298}
Referenced Components (11)187 of 218 keywords
CreateIngredientFood28 of 30 keywords
1182413{
2184106 "properties": {
316734 "aliases": {
416722 "items": {
616722 },
718912 "type": "array"
816734 },
918110 "description": {
1018110 "type": "string"
1118110 },
121948 "extras": {
131948 "anyOf": [
1416141 {
151n/a "additionalProperties": true,
1616141 "type": "object"
1716141 },
1833169 {
1933169 "type": "null"
2033169 }
211948 ],
221948 },
2317820 "householdsWithIngredientFood": {
2417810 "items": {
2532110 "type": "string"
2617810 },
2718810 "type": "array"
2817820 },
292328 "id": {
302328 "anyOf": [
3122317 {
322230 "format": "uuid4",
3322317 "type": "string"
3422317 },
359231 {
369231 "type": "null"
379231 }
382328 ],
392328 },
401788 "labelId": {
411788 "anyOf": [
4214739 {
431470 "format": "uuid4",
4414739 "type": "string"
4514739 },
4631155 {
4731155 "type": "null"
4831155 }
491788 ],
501788 },
5127810 "name": {
5227810 "type": "string"
5327810 },
541758 "pluralName": {
551758 "anyOf": [
5632151 {
5732151 "type": "string"
5832151 },
5914340 {
6014340 "type": "null"
6114340 }
621758 ],
631758 }
64184106 },
652883 "required": [
662883 "name"
672883 ],
68291304 "type": "object"
69182413}
CreateIngredientFoodAlias6 of 6 keywords
122922{
222910 "properties": {
322910 "name": {
422910 "type": "string"
522910 }
622910 },
72392 "required": [
82392 "name"
92392 ],
1024110 "type": "object"
1122922}
CreateIngredientUnit29 of 30 keywords
1203411{
2205116 "properties": {
322710 "abbreviation": {
422710 "type": "string"
522710 },
620232 "aliases": {
720222 "items": {
920222 },
1022410 "type": "array"
1120232 },
1222610 "description": {
1322610 "type": "string"
1422610 },
152208 "extras": {
162208 "anyOf": [
1717256 {
181n/a "additionalProperties": true,
1917256 "type": "object"
2017256 },
2148180 {
2248180 "type": "null"
2348180 }
242208 ],
252208 },
2620510 "fraction": {
2720510 "type": "boolean"
2820510 },
2926110 "id": {
3026110 "anyOf": [
3124328 {
322430 "format": "uuid4",
3324328 "type": "string"
3424328 },
3518253 {
3618253 "type": "null"
3718253 }
3826110 ],
3926110 },
4030910 "name": {
4130910 "type": "string"
4230910 },
432168 "pluralAbbreviation": {
442168 "anyOf": [
4517252 {
4617252 "type": "string"
4717252 },
4844180 {
4944180 "type": "null"
5044180 }
512168 ],
522168 },
532168 "pluralName": {
542168 "anyOf": [
5547177 {
5647177 "type": "string"
5747177 },
5816955 {
5916955 "type": "null"
6016955 }
612168 ],
622168 },
6321710 "useAbbreviation": {
6421710 "type": "boolean"
6521710 }
66205116 },
673193 "required": [
683193 "name"
693193 ],
70322292 "type": "object"
71203411}
CreateIngredientUnitAlias6 of 6 keywords
134822{
234810 "properties": {
334810 "name": {
434810 "type": "string"
534810 }
634810 },
73582 "required": [
83582 "name"
93582 ],
1036010 "type": "object"
1134822}
IngredientFood-Input31 of 41 keywords
1123472{
2175115 "properties": {
316734 "aliases": {
416722 "items": {
616722 },
718912 "type": "array"
816734 },
91030 "createdAt": {
101030 "anyOf": [
118815 {
12880 "format": "date-time",
138815 "type": "string"
148815 },
151588 {
161588 "type": "null"
171588 }
181030 ],
191030 },
2018110 "description": {
2118110 "type": "string"
2218110 },
231948 "extras": {
241948 "anyOf": [
2516141 {
261n/a "additionalProperties": true,
2716141 "type": "object"
2816141 },
2933169 {
3033169 "type": "null"
3133169 }
321948 ],
331948 },
3417820 "householdsWithIngredientFood": {
3517810 "items": {
3632110 "type": "string"
3717810 },
3818810 "type": "array"
3917820 },
4022317 "id": {
412230 "format": "uuid4",
4222317 "type": "string"
4322317 },
441050 "label": {
451050 "anyOf": [
462481 {
482481 },
498124 {
508124 "type": "null"
518124 }
521050 ]
531050 },
541788 "labelId": {
551788 "anyOf": [
5614739 {
571470 "format": "uuid4",
5814739 "type": "string"
5914739 },
6031155 {
6131155 "type": "null"
6231155 }
631788 ],
641788 },
6527810 "name": {
6627810 "type": "string"
6727810 },
681758 "pluralName": {
691758 "anyOf": [
7032151 {
7132151 "type": "string"
7232151 },
7314340 {
7414340 "type": "null"
7514340 }
761758 ],
771758 },
78940 "update_at": {
79940 "anyOf": [
808113 {
81810 "format": "date-time",
828113 "type": "string"
838113 },
841381 {
851381 "type": "null"
861381 }
87940 ],
88940 }
89175115 },
9023853 "required": [
9124051 "id",
922883 "name"
9323853 ],
94291304 "type": "object"
95123472}
IngredientFoodAlias6 of 6 keywords
122922{
222910 "properties": {
322910 "name": {
422910 "type": "string"
522910 }
622910 },
72392 "required": [
82392 "name"
92392 ],
1024110 "type": "object"
1122922}
IngredientUnit-Input30 of 37 keywords
1135479{
2187134 "properties": {
322710 "abbreviation": {
422710 "type": "string"
522710 },
620232 "aliases": {
720222 "items": {
920222 },
1022410 "type": "array"
1120232 },
121190 "createdAt": {
131190 "anyOf": [
149623 {
15960 "format": "date-time",
169623 "type": "string"
179623 },
182396 {
192396 "type": "null"
202396 }
211190 ],
221190 },
2322610 "description": {
2422610 "type": "string"
2522610 },
262208 "extras": {
272208 "anyOf": [
2817256 {
291n/a "additionalProperties": true,
3017256 "type": "object"
3117256 },
3248180 {
3348180 "type": "null"
3448180 }
352208 ],
362208 },
3720510 "fraction": {
3820510 "type": "boolean"
3920510 },
4024328 "id": {
412430 "format": "uuid4",
4224328 "type": "string"
4324328 },
4430910 "name": {
4530910 "type": "string"
4630910 },
472168 "pluralAbbreviation": {
482168 "anyOf": [
4917252 {
5017252 "type": "string"
5117252 },
5244180 {
5344180 "type": "null"
5444180 }
552168 ],
562168 },
572168 "pluralName": {
582168 "anyOf": [
5947177 {
6047177 "type": "string"
6147177 },
6216955 {
6316955 "type": "null"
6416955 }
652168 ],
662168 },
671170 "update_at": {
681170 "anyOf": [
699621 {
70960 "format": "date-time",
719621 "type": "string"
729621 },
732196 {
742196 "type": "null"
752196 }
761170 ],
771170 },
7821710 "useAbbreviation": {
7921710 "type": "boolean"
8021710 }
81187134 },
8226953 "required": [
8327151 "id",
843193 "name"
8526953 ],
86322292 "type": "object"
87135479}
IngredientUnitAlias6 of 6 keywords
134822{
234810 "properties": {
334810 "name": {
434810 "type": "string"
534810 }
634810 },
73582 "required": [
83582 "name"
93582 ],
1036010 "type": "object"
1134822}
MultiPurposeLabelSummary1 of 11 keywords
12481{
2240 "properties": {
390 "color": {
490 "type": "string"
590 },
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 ],
232481 "type": "object"
242481}
RecipeIngredient-Input32 of 32 keywords
1615268{
2526261 "properties": {
35895 "display": {
45895 "type": "string"
55895 },
6482113 "food": {
7482113 "anyOf": [
8123472 {
10123472 },
11182413 {
13182413 },
14300295 {
15300295 "type": "null"
16300295 }
17482113 ],
18482113 },
195874 "note": {
205874 "anyOf": [
21477114 {
22477114 "type": "string"
23477114 },
24110481 {
25110481 "type": "null"
26110481 }
275874 ],
285874 },
295894 "originalText": {
305894 "anyOf": [
31114479 {
32114479 "type": "string"
33114479 },
34475118 {
35475118 "type": "null"
36475118 }
375894 ],
385894 },
396084 "quantity": {
406084 "anyOf": [
41500112 {
42500112 "type": "number"
43500112 },
44108504 {
45108504 "type": "null"
46108504 }
476084 ],
486084 },
495726 "referenceId": {
505721 "format": "uuid",
515735 "type": "string"
525726 },
535954 "title": {
545954 "anyOf": [
55116483 {
56116483 "type": "string"
57116483 },
58479120 {
59479120 "type": "null"
60479120 }
615954 ],
625954 },
63491123 "unit": {
64491123 "anyOf": [
65135479 {
67135479 },
68203411 {
70203411 },
71288326 {
72288326 "type": "null"
73288326 }
74491123 ],
75491123 }
76526261 },
778767 "type": "object"
78615268}
ShoppingListAddRecipeParamsBulk12 of 13 keywords
1778293{
2784280 "properties": {
310535 "recipeId": {
410530 "format": "uuid4",
510535 "type": "string"
610535 },
77075 "recipeIncrementQuantity": {
87075 "type": "number"
97075 },
10439270 "recipeIngredients": {
11439270 "anyOf": [
12274435 {
13274266 "items": {
15274266 },
16540169 "type": "array"
17274435 },
18165544 {
19165544 "type": "null"
20165544 }
21439270 ],
22439270 }
23784280 },
2410588 "required": [
2510588 "recipeId"
2610588 ],
2710665 "type": "object"
28778293}
Responses
codedescriptionhitsavg
200Successful Response6550ms
422Validation Error2883ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error38621ms
400Bad Request51ms
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_id1 / 2
#validinvalidschema
18200{
28200 "format": "uuid4",
3820n/a "type": "string"
48200}
recipe_id2 / 2
18146{
28146 "format": "uuid4",
3820n/a "type": "string"
48146}
Headers
accept-language3 / 3
1634n/a{
2634n/a "anyOf": [
3553n/a {
4553n/a "type": "string"
5553n/a },
681553 {
781553 "type": "null"
881553 }
9634n/a ],
10634n/a}
Body
application/json150 / 171
1478297{
2478297 "anyOf": [
3269506 {
5269506 },
6209566 {
7209566 "type": "null"
8209566 }
9478297 ],
10478297}
Referenced Components (11)187 of 214 keywords
CreateIngredientFood28 of 30 keywords
196361{
298125 "properties": {
313432 "aliases": {
413422 "items": {
613422 },
715610 "type": "array"
813432 },
915910 "description": {
1015910 "type": "string"
1115910 },
1215316 "extras": {
1315316 "anyOf": [
1413930 {
151n/a "additionalProperties": true,
1613930 "type": "object"
1713930 },
1814155 {
1914155 "type": "null"
2014155 }
2115316 ],
2215316 },
2314220 "householdsWithIngredientFood": {
2414210 "items": {
2515310 "type": "string"
2614210 },
2715210 "type": "array"
2814220 },
291828 "id": {
301828 "anyOf": [
3117218 {
321720 "format": "uuid4",
3317218 "type": "string"
3417218 },
3510180 {
3610180 "type": "null"
3710180 }
381828 ],
391828 },
4015121 "labelId": {
4115121 "anyOf": [
4213339 {
431330 "format": "uuid4",
4413339 "type": "string"
4513339 },
4618154 {
4718154 "type": "null"
4818154 }
4915121 ],
5015121 },
5121110 "name": {
5221110 "type": "string"
5321110 },
541478 "pluralName": {
551478 "anyOf": [
5614141 {
5714141 "type": "string"
5814141 },
5913322 {
6013322 "type": "null"
6113322 }
621478 ],
631478 }
6498125 },
652213 "required": [
662213 "name"
672213 ],
68224233 "type": "object"
6996361}
CreateIngredientFoodAlias6 of 6 keywords
19122{
29110 "properties": {
39110 "name": {
49110 "type": "string"
59110 }
69110 },
71012 "required": [
81012 "name"
91012 ],
1010310 "type": "object"
119122}
CreateIngredientUnit29 of 30 keywords
1111353{
2113136 "properties": {
317010 "abbreviation": {
417010 "type": "string"
517010 },
615045 "aliases": {
715035 "items": {
915035 },
1018510 "type": "array"
1115045 },
1216510 "description": {
1316510 "type": "string"
1416510 },
151778 "extras": {
161778 "anyOf": [
1715728 {
181n/a "additionalProperties": true,
1915728 "type": "object"
2015728 },
2120165 {
2220165 "type": "null"
2320165 }
241778 ],
251778 },
2617910 "fraction": {
2717910 "type": "boolean"
2817910 },
292088 "id": {
302088 "anyOf": [
3120016 {
322000 "format": "uuid4",
3320016 "type": "string"
3420016 },
358208 {
368208 "type": "null"
378208 }
382088 ],
392088 },
4023710 "name": {
4123710 "type": "string"
4223710 },
431608 "pluralAbbreviation": {
441608 "anyOf": [
4514523 {
4614523 "type": "string"
4714523 },
4815153 {
4915153 "type": "null"
5015153 }
511608 ],
521608 },
5316818 "pluralName": {
5416818 "anyOf": [
5517169 {
5617169 "type": "string"
5717169 },
5815135 {
5915135 "type": "null"
6015135 }
6116818 ],
6216818 },
6315110 "useAbbreviation": {
6415110 "type": "boolean"
6515110 }
66113136 },
672473 "required": [
682473 "name"
692473 ],
70250214 "type": "object"
71111353}
CreateIngredientUnitAlias6 of 6 keywords
112243{
212231 "properties": {
312231 "name": {
412231 "type": "string"
512231 }
612231 },
71532 "required": [
81532 "name"
91532 ],
1015510 "type": "object"
1112243}
IngredientFood-Input31 of 41 keywords
164393{
292131 "properties": {
313432 "aliases": {
413422 "items": {
613422 },
715610 "type": "array"
813432 },
9810 "createdAt": {
10810 "anyOf": [
11747 {
12740 "format": "date-time",
13747 "type": "string"
14747 },
15774 {
16774 "type": "null"
17774 }
18810 ],
19810 },
2015910 "description": {
2115910 "type": "string"
2215910 },
2315316 "extras": {
2415316 "anyOf": [
2513930 {
261n/a "additionalProperties": true,
2713930 "type": "object"
2813930 },
2914155 {
3014155 "type": "null"
3114155 }
3215316 ],
3315316 },
3414220 "householdsWithIngredientFood": {
3514210 "items": {
3615310 "type": "string"
3714210 },
3815210 "type": "array"
3914220 },
4017218 "id": {
411720 "format": "uuid4",
4217218 "type": "string"
4317218 },
44800 "label": {
45800 "anyOf": [
461169 {
481169 },
496911 {
506911 "type": "null"
516911 }
52800 ]
53800 },
5415121 "labelId": {
5515121 "anyOf": [
5613339 {
571330 "format": "uuid4",
5813339 "type": "string"
5913339 },
6018154 {
6118154 "type": "null"
6218154 }
6315121 ],
6415121 },
6521110 "name": {
6621110 "type": "string"
6721110 },
681478 "pluralName": {
691478 "anyOf": [
7014141 {
7114141 "type": "string"
7214141 },
7313322 {
7413322 "type": "null"
7513322 }
761478 ],
771478 },
78750 "update_at": {
79750 "anyOf": [
80696 {
81690 "format": "date-time",
82696 "type": "string"
83696 },
84669 {
85669 "type": "null"
86669 }
87750 ],
88750 }
8992131 },
9018836 "required": [
9119034 "id",
922213 "name"
9318836 ],
94224233 "type": "object"
9564393}
IngredientFoodAlias6 of 6 keywords
19122{
29110 "properties": {
39110 "name": {
49110 "type": "string"
59110 }
69110 },
71012 "required": [
81012 "name"
91012 ],
1010310 "type": "object"
119122}
IngredientUnit-Input33 of 37 keywords
175389{
2101148 "properties": {
317010 "abbreviation": {
417010 "type": "string"
517010 },
615045 "aliases": {
715035 "items": {
915035 },
1018510 "type": "array"
1115045 },
12977 "createdAt": {
13977 "anyOf": [
148915 {
15897 "format": "date-time",
16968 "type": "string"
178915 },
18896 {
19896 "type": "null"
20896 }
21977 ],
22977 },
2316510 "description": {
2416510 "type": "string"
2516510 },
261778 "extras": {
271778 "anyOf": [
2815728 {
291n/a "additionalProperties": true,
3015728 "type": "object"
3115728 },
3220165 {
3320165 "type": "null"
3420165 }
351778 ],
361778 },
3717910 "fraction": {
3817910 "type": "boolean"
3917910 },
4020016 "id": {
412000 "format": "uuid4",
4220016 "type": "string"
4320016 },
4423710 "name": {
4523710 "type": "string"
4623710 },
471608 "pluralAbbreviation": {
481608 "anyOf": [
4914523 {
5014523 "type": "string"
5114523 },
5215153 {
5315153 "type": "null"
5415153 }
551608 ],
561608 },
5716818 "pluralName": {
5816818 "anyOf": [
5917169 {
6017169 "type": "string"
6117169 },
6215135 {
6315135 "type": "null"
6415135 }
6516818 ],
6616818 },
67960 "update_at": {
68960 "anyOf": [
697917 {
70790 "format": "date-time",
717917 "type": "string"
727917 },
731779 {
741779 "type": "null"
751779 }
76960 ],
77960 },
7815110 "useAbbreviation": {
7915110 "type": "boolean"
8015110 }
81101148 },
8221436 "required": [
8321634 "id",
842473 "name"
8521436 ],
86250214 "type": "object"
8775389}
IngredientUnitAlias6 of 6 keywords
112243{
212231 "properties": {
312231 "name": {
412231 "type": "string"
512231 }
612231 },
71532 "required": [
81532 "name"
91532 ],
1015510 "type": "object"
1112243}
MultiPurposeLabelSummary1 of 11 keywords
11169{
2110 "properties": {
370 "color": {
470 "type": "string"
570 },
6110 "groupId": {
7110 "format": "uuid4",
8110 "type": "string"
9110 },
10110 "id": {
11110 "format": "uuid4",
12110 "type": "string"
13110 },
14110 "name": {
15110 "type": "string"
16110 }
17110 },
18110 "required": [
19110 "name",
20110 "groupId",
21110 "id"
22110 ],
231169 "type": "object"
241169}
RecipeIngredient-Input32 of 32 keywords
1281301{
2239294 "properties": {
34555 "display": {
44555 "type": "string"
54555 },
6324133 "food": {
7324133 "anyOf": [
864393 {
1064393 },
1196361 {
1396361 },
14228229 {
15228229 "type": "null"
16228229 }
17324133 ],
18324133 },
1944414 "note": {
2044414 "anyOf": [
2139959 {
2239959 "type": "string"
2339959 },
2445413 {
2545413 "type": "null"
2645413 }
2744414 ],
2844414 },
2943816 "originalText": {
3043816 "anyOf": [
3134420 {
3234420 "type": "string"
3334420 },
3440450 {
3540450 "type": "null"
3640450 }
3743816 ],
3843816 },
394294 "quantity": {
404294 "anyOf": [
4139934 {
4239934 "type": "number"
4339934 },
4430403 {
4530403 "type": "null"
4630403 }
474294 ],
484294 },
494276 "referenceId": {
504271 "format": "uuid",
514285 "type": "string"
524276 },
534434 "title": {
544434 "anyOf": [
5546401 {
5646401 "type": "string"
5746401 },
5839750 {
5939750 "type": "null"
6039750 }
614434 ],
624434 },
63321143 "unit": {
64321143 "anyOf": [
6575389 {
6775389 },
68111353 {
70111353 },
71210254 {
72210254 "type": "null"
73210254 }
74321143 ],
75321143 }
76239294 },
775757 "type": "object"
78281301}
ShoppingListAddRecipeParams9 of 9 keywords
1269506{
2209292 "properties": {
34425 "recipeIncrementQuantity": {
44425 "type": "number"
54425 },
6201287 "recipeIngredients": {
7201287 "anyOf": [
8167321 {
9167283 "items": {
11167283 },
1245038 "type": "array"
13167321 },
1434454 {
1534454 "type": "null"
1634454 }
17201287 ],
18201287 }
19209292 },
20561214 "type": "object"
21269506}
Responses
codedescriptionhitsavg
200Successful Response103111ms
422Validation Error2664ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error44625ms
400Bad Request51ms
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_id1 / 2
#validinvalidschema
15080{
25080 "format": "uuid4",
3508n/a "type": "string"
45080}
recipe_id2 / 2
15035{
25035 "format": "uuid4",
3508n/a "type": "string"
45035}
Headers
accept-language3 / 3
1323n/a{
2323n/a "anyOf": [
3232n/a {
4232n/a "type": "string"
5232n/a },
691232 {
791232 "type": "null"
891232 }
9323n/a ],
10323n/a}
Body
application/json6 / 6
141444{
241444 "anyOf": [
3189269 {
5189269 },
6225233 {
7225233 "type": "null"
8225233 }
941444 ],
1041444}
Referenced Components (1)4 of 4 keywords
ShoppingListRemoveRecipeParams4 of 4 keywords
1189269{
210031 "properties": {
310031 "recipeDecrementQuantity": {
410031 "type": "number"
510031 }
610031 },
7220238 "type": "object"
8189269}
Responses
codedescriptionhitsavg
200Successful Response17154ms
422Validation Error445ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error29111ms
400Bad Request21ms
Examples
Body: application/json
1ShoppingListRemoveRecipeParams.recipeDecrementQuantity
Households: Webhooks 7 operations 4 covered 3 partial 0 uncovered 0 not measured 95% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1147n/a{
2147n/a "anyOf": [
3139n/a {
4139n/a "type": "string"
5139n/a },
68139 {
78139 "type": "null"
88139 }
9147n/a ],
10147n/a}
orderByNullPosition5 / 5
19828{
29828 "anyOf": [
39234 {
59234 },
66120 {
76120 "type": "null"
86120 }
99828 ],
109828}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
19234{
29234 "enum": [
367n/a "first",
425n/a "last"
59234 ],
6120n/a "type": "string"
79234}
orderDirection2 / 2
OrderDirection
116815{
216815 "enum": [
3117n/a "asc",
451n/a "desc"
516815 ],
6183n/a "type": "string"
716815}
queryFilter3 / 3
1140n/a{
2140n/a "anyOf": [
3128n/a {
4128n/a "type": "string"
5128n/a },
612128 {
712128 "type": "null"
812128 }
9140n/a ],
10140n/a}
paginationSeed3 / 3
1129n/a{
2129n/a "anyOf": [
3125n/a {
4125n/a "type": "string"
5125n/a },
64125 {
74125 "type": "null"
84125 }
9129n/a ],
10129n/a}
page1 / 1
115417{
215417 "type": "integer"
315417}
perPage1 / 1
115029{
215029 "type": "integer"
315029}
Headers
accept-language3 / 3
1341n/a{
2341n/a "anyOf": [
3237n/a {
4237n/a "type": "string"
5237n/a },
6104237 {
7104237 "type": "null"
8104237 }
9341n/a ],
10341n/a}
Responses
codedescriptionhitsavg
200Successful Response28910ms
422Validation Error785ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request538ms
500Internal Server Error611ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1312n/a{
2312n/a "anyOf": [
3222n/a {
4222n/a "type": "string"
5222n/a },
690222 {
790222 "type": "null"
890222 }
9312n/a ],
10312n/a}
Body
application/json11 / 11
CreateWebhook
140060{
240836 "properties": {
32115 "enabled": {
42115 "type": "boolean"
52115 },
62215 "name": {
72215 "type": "string"
82215 },
94306 "scheduledTime": {
104301 "format": "time",
114315 "type": "string"
124306 },
1323411 "url": {
1423411 "type": "string"
1523411 },
1621715 "webhookType": {
1821715 }
1940836 },
2043618 "required": [
2143618 "scheduledTime"
2243618 ],
234546 "type": "object"
2440060}
Referenced Components (1)3 of 3 keywords
WebhookType3 of 3 keywords
121715{
221715 "enum": [
3217n/a "mealplan"
421715 ],
52275 "type": "string"
621715}
Responses
codedescriptionhitsavg
201Successful Response40318ms
422Validation Error694ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error33ms
400Bad Request51ms
Examples
Body: application/json
trueCreateWebhook.enabled
""CreateWebhook.name
""CreateWebhook.url
"mealplan"CreateWebhook.webhookType
Headers
accept-language3 / 3
#validinvalidschema
1126n/a{
2126n/a "anyOf": [
388n/a {
488n/a "type": "string"
588n/a },
63888 {
73888 "type": "null"
83888 }
9126n/a ],
10126n/a}
Responses
codedescriptionhitsavg
200Successful Response10814ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error2586ms
Path Parameters
item_id1 / 2
#validinvalidschema
1910{
2910 "format": "uuid4",
391n/a "type": "string"
4910}
Headers
accept-language3 / 3
152n/a{
252n/a "anyOf": [
332n/a {
432n/a "type": "string"
532n/a },
62032 {
72032 "type": "null"
82032 }
952n/a ],
1052n/a}
Responses
codedescriptionhitsavg
200Successful Response7817ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found136ms
Path Parameters
item_id1 / 2
#validinvalidschema
11730{
21730 "format": "uuid4",
3173n/a "type": "string"
41730}
Headers
accept-language3 / 3
150n/a{
250n/a "anyOf": [
337n/a {
437n/a "type": "string"
537n/a },
61337 {
71337 "type": "null"
81337 }
950n/a ],
1050n/a}
Responses
codedescriptionhitsavg
200Successful Response14810ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found258ms
Path Parameters
item_id2 / 2
#validinvalidschema
12141{
22141 "format": "uuid4",
3215n/a "type": "string"
42141}
Headers
accept-language3 / 3
1107n/a{
2107n/a "anyOf": [
386n/a {
486n/a "type": "string"
586n/a },
62186 {
72186 "type": "null"
82186 }
9107n/a ],
10107n/a}
Body
application/json11 / 11
CreateWebhook
113175{
213263 "properties": {
3715 "enabled": {
4715 "type": "boolean"
5715 },
6655 "name": {
7655 "type": "string"
8655 },
915242 "scheduledTime": {
1015237 "format": "time",
111895 "type": "string"
1215242 },
13875 "url": {
14875 "type": "string"
15875 },
16547 "webhookType": {
18547 }
1913263 },
201942 "required": [
211942 "scheduledTime"
221942 ],
2319610 "type": "object"
2413175}
Referenced Components (1)3 of 3 keywords
WebhookType3 of 3 keywords
1547{
2547 "enum": [
354n/a "mealplan"
4547 ],
5565 "type": "string"
6547}
Responses
codedescriptionhitsavg
200Successful Response15616ms
422Validation Error433ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error33ms
404Not Found138ms
Examples
Body: application/json
trueCreateWebhook.enabled
""CreateWebhook.name
""CreateWebhook.url
"mealplan"CreateWebhook.webhookType
Path Parameters
item_id1 / 2
#validinvalidschema
11910{
21910 "format": "uuid4",
3191n/a "type": "string"
41910}
Headers
accept-language3 / 3
187n/a{
287n/a "anyOf": [
358n/a {
458n/a "type": "string"
558n/a },
62958 {
72958 "type": "null"
82958 }
987n/a ],
1087n/a}
Responses
codedescriptionhitsavg
200Successful Response1698ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found228ms
Organizer: Categories 7 operations 4 covered 3 partial 0 uncovered 0 not measured 94% #
Query Parameters
search3 / 3
#validinvalidschema
1159n/a{
2159n/a "anyOf": [
3144n/a {
4144n/a "type": "string"
5144n/a },
615144 {
715144 "type": "null"
815144 }
9159n/a ],
10159n/a}
orderBy3 / 3
1197n/a{
2197n/a "anyOf": [
3185n/a {
4185n/a "type": "string"
5185n/a },
612185 {
712185 "type": "null"
812185 }
9197n/a ],
10197n/a}
orderByNullPosition5 / 5
115733{
215733 "anyOf": [
314446 {
514446 },
613177 {
713177 "type": "null"
813177 }
915733 ],
1015733}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
114446{
214446 "enum": [
3102n/a "first",
442n/a "last"
514446 ],
6177n/a "type": "string"
714446}
orderDirection2 / 2
OrderDirection
126816{
226816 "enum": [
3164n/a "asc",
4104n/a "desc"
526816 ],
6284n/a "type": "string"
726816}
queryFilter3 / 3
1165n/a{
2165n/a "anyOf": [
3157n/a {
4157n/a "type": "string"
5157n/a },
68157 {
78157 "type": "null"
88157 }
9165n/a ],
10165n/a}
paginationSeed3 / 3
1163n/a{
2163n/a "anyOf": [
3154n/a {
4154n/a "type": "string"
5154n/a },
69154 {
79154 "type": "null"
89154 }
9163n/a ],
10163n/a}
page1 / 1
122930{
222930 "type": "integer"
322930}
perPage1 / 1
124123{
224123 "type": "integer"
324123}
Headers
accept-language3 / 3
1424n/a{
2424n/a "anyOf": [
3288n/a {
4288n/a "type": "string"
5288n/a },
6136288 {
7136288 "type": "null"
8136288 }
9424n/a ],
10424n/a}
Responses
codedescriptionhitsavg
200Successful Response3299ms
422Validation Error815ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request828ms
500Internal Server Error1811ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1269n/a{
2269n/a "anyOf": [
3180n/a {
4180n/a "type": "string"
5180n/a },
689180 {
789180 "type": "null"
889180 }
9269n/a ],
10269n/a}
Body
application/json4 / 4
CategoryIn
129744{
229711 "properties": {
329711 "name": {
429711 "type": "string"
529711 }
629711 },
730817 "required": [
830817 "name"
930817 ],
1032516 "type": "object"
1129744}
Responses
codedescriptionhitsavg
201Successful Response14436ms
422Validation Error594ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1578ms
Headers
accept-language3 / 3
#validinvalidschema
1116n/a{
2116n/a "anyOf": [
379n/a {
479n/a "type": "string"
579n/a },
63779 {
73779 "type": "null"
83779 }
9116n/a ],
10116n/a}
Responses
codedescriptionhitsavg
200Successful Response10811ms
422Validation Error0never seen
Path Parameters
category_slug1 / 1
#validinvalidschema
1114n/a{
2114n/a "type": "string"
3114n/a}
Headers
accept-language3 / 3
166n/a{
266n/a "anyOf": [
348n/a {
448n/a "type": "string"
548n/a },
61848 {
71848 "type": "null"
81848 }
966n/a ],
1066n/a}
Responses
codedescriptionhitsavg
200Successful Response1059ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found94ms
Path Parameters
item_id1 / 2
#validinvalidschema
1430{
2430 "format": "uuid4",
343n/a "type": "string"
4430}
Headers
accept-language3 / 3
114n/a{
214n/a "anyOf": [
312n/a {
412n/a "type": "string"
512n/a },
6212 {
7212 "type": "null"
8212 }
914n/a ],
1014n/a}
Responses
codedescriptionhitsavg
200Successful Response2751ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found167ms
Path Parameters
item_id1 / 2
#validinvalidschema
12140{
22140 "format": "uuid4",
3214n/a "type": "string"
42140}
Headers
accept-language3 / 3
147n/a{
247n/a "anyOf": [
331n/a {
431n/a "type": "string"
531n/a },
61631 {
71631 "type": "null"
81631 }
947n/a ],
1047n/a}
Responses
codedescriptionhitsavg
200Successful Response1758ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found397ms
Path Parameters
item_id1 / 2
#validinvalidschema
11330{
21330 "format": "uuid4",
3133n/a "type": "string"
41330}
Headers
accept-language3 / 3
157n/a{
257n/a "anyOf": [
342n/a {
442n/a "type": "string"
542n/a },
61542 {
71542 "type": "null"
81542 }
957n/a ],
1057n/a}
Body
application/json4 / 4
CategoryIn
111411{
21145 "properties": {
31145 "name": {
41145 "type": "string"
51145 }
61145 },
71191 "required": [
81191 "name"
91191 ],
101205 "type": "object"
1111411}
Responses
codedescriptionhitsavg
200Successful Response3925ms
422Validation Error173ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found196ms
400Bad Request5811ms
Organizer: Tags 7 operations 4 covered 3 partial 0 uncovered 0 not measured 94% #
Query Parameters
search3 / 3
#validinvalidschema
1118n/a{
2118n/a "anyOf": [
3111n/a {
4111n/a "type": "string"
5111n/a },
67111 {
77111 "type": "null"
87111 }
9118n/a ],
10118n/a}
orderBy3 / 3
1138n/a{
2138n/a "anyOf": [
3128n/a {
4128n/a "type": "string"
5128n/a },
610128 {
710128 "type": "null"
810128 }
9138n/a ],
10138n/a}
orderByNullPosition5 / 5
112228{
212228 "anyOf": [
311733 {
511733 },
65145 {
75145 "type": "null"
85145 }
912228 ],
1012228}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
111733{
211733 "enum": [
381n/a "first",
436n/a "last"
511733 ],
6145n/a "type": "string"
711733}
orderDirection2 / 2
OrderDirection
118320{
218320 "enum": [
3110n/a "asc",
473n/a "desc"
518320 ],
6203n/a "type": "string"
718320}
queryFilter3 / 3
1126n/a{
2126n/a "anyOf": [
3124n/a {
4124n/a "type": "string"
5124n/a },
62124 {
72124 "type": "null"
82124 }
9126n/a ],
10126n/a}
paginationSeed3 / 3
1146n/a{
2146n/a "anyOf": [
3137n/a {
4137n/a "type": "string"
5137n/a },
69137 {
79137 "type": "null"
89137 }
9146n/a ],
10146n/a}
page1 / 1
118731{
218731 "type": "integer"
318731}
perPage1 / 1
117317{
217317 "type": "integer"
317317}
Headers
accept-language3 / 3
1362n/a{
2362n/a "anyOf": [
3265n/a {
4265n/a "type": "string"
5265n/a },
697265 {
797265 "type": "null"
897265 }
9362n/a ],
10362n/a}
Responses
codedescriptionhitsavg
200Successful Response2678ms
422Validation Error745ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request668ms
500Internal Server Error810ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1303n/a{
2303n/a "anyOf": [
3212n/a {
4212n/a "type": "string"
5212n/a },
691212 {
791212 "type": "null"
891212 }
9303n/a ],
10303n/a}
Body
application/json4 / 4
TagIn
134143{
234113 "properties": {
334113 "name": {
434113 "type": "string"
534113 }
634113 },
735422 "required": [
835422 "name"
935422 ],
103768 "type": "object"
1134143}
Responses
codedescriptionhitsavg
201Successful Response15739ms
422Validation Error564ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1838ms
400Bad Request51ms
Headers
accept-language3 / 3
#validinvalidschema
1105n/a{
2105n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
63768 {
73768 "type": "null"
83768 }
9105n/a ],
10105n/a}
Responses
codedescriptionhitsavg
200Successful Response10814ms
422Validation Error0never seen
Path Parameters
tag_slug1 / 1
#validinvalidschema
1114n/a{
2114n/a "type": "string"
3114n/a}
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 Response10012ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error146ms
Path Parameters
item_id1 / 2
#validinvalidschema
1490{
2490 "format": "uuid4",
349n/a "type": "string"
4490}
Headers
accept-language3 / 3
124n/a{
224n/a "anyOf": [
320n/a {
420n/a "type": "string"
520n/a },
6420 {
7420 "type": "null"
8420 }
924n/a ],
1024n/a}
Responses
codedescriptionhitsavg
200Successful Response2834ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request217ms
Path Parameters
item_id1 / 2
#validinvalidschema
12120{
22120 "format": "uuid4",
3212n/a "type": "string"
42120}
Headers
accept-language3 / 3
141n/a{
241n/a "anyOf": [
328n/a {
428n/a "type": "string"
528n/a },
61328 {
71328 "type": "null"
81328 }
941n/a ],
1041n/a}
Responses
codedescriptionhitsavg
200Successful Response1898ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found236ms
Path Parameters
item_id1 / 2
#validinvalidschema
11360{
21360 "format": "uuid4",
3136n/a "type": "string"
41360}
Headers
accept-language3 / 3
1150n/a{
2150n/a "anyOf": [
387n/a {
487n/a "type": "string"
587n/a },
66387 {
76387 "type": "null"
86387 }
9150n/a ],
10150n/a}
Body
application/json4 / 4
TagIn
111216{
21125 "properties": {
31125 "name": {
41125 "type": "string"
51125 }
61125 },
71176 "required": [
81176 "name"
91176 ],
101235 "type": "object"
1111216}
Responses
codedescriptionhitsavg
200Successful Response1324ms
422Validation Error243ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error999ms
Organizer: Tools 6 operations 5 covered 1 partial 0 uncovered 0 not measured 98% #
Query Parameters
search3 / 3
#validinvalidschema
1135n/a{
2135n/a "anyOf": [
3126n/a {
4126n/a "type": "string"
5126n/a },
69126 {
79126 "type": "null"
89126 }
9135n/a ],
10135n/a}
orderBy3 / 3
1140n/a{
2140n/a "anyOf": [
3132n/a {
4132n/a "type": "string"
5132n/a },
68132 {
78132 "type": "null"
88132 }
9140n/a ],
10140n/a}
orderByNullPosition5 / 5
111541{
211541 "anyOf": [
310947 {
510947 },
66150 {
76150 "type": "null"
86150 }
911541 ],
1011541}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
110947{
210947 "enum": [
389n/a "first",
420n/a "last"
510947 ],
6150n/a "type": "string"
710947}
orderDirection2 / 2
OrderDirection
118920{
218920 "enum": [
3125n/a "asc",
464n/a "desc"
518920 ],
6209n/a "type": "string"
718920}
queryFilter3 / 3
1149n/a{
2149n/a "anyOf": [
3143n/a {
4143n/a "type": "string"
5143n/a },
66143 {
76143 "type": "null"
86143 }
9149n/a ],
10149n/a}
paginationSeed3 / 3
1137n/a{
2137n/a "anyOf": [
3131n/a {
4131n/a "type": "string"
5131n/a },
66131 {
76131 "type": "null"
86131 }
9137n/a ],
10137n/a}
page1 / 1
120116{
220116 "type": "integer"
320116}
perPage1 / 1
118914{
218914 "type": "integer"
318914}
Headers
accept-language3 / 3
1367n/a{
2367n/a "anyOf": [
3265n/a {
4265n/a "type": "string"
5265n/a },
6102265 {
7102265 "type": "null"
8102265 }
9367n/a ],
10367n/a}
Responses
codedescriptionhitsavg
200Successful Response28815ms
422Validation Error775ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request738ms
500Internal Server Error1311ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1323n/a{
2323n/a "anyOf": [
3217n/a {
4217n/a "type": "string"
5217n/a },
6106217 {
7106217 "type": "null"
8106217 }
9323n/a ],
10323n/a}
Body
application/json6 / 6
RecipeToolCreate
132234{
232620 "properties": {
318115 "householdsWithTool": {
41817 "items": {
560614 "type": "string"
61817 },
71888 "type": "array"
818115 },
933210 "name": {
1033210 "type": "string"
1133210 }
1232620 },
133429 "required": [
143429 "name"
153429 ],
163515 "type": "object"
1732234}
Responses
codedescriptionhitsavg
201Successful Response16081ms
422Validation Error513ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1717ms
Examples
Body: application/json
[]RecipeToolCreate.householdsWithTool
Path Parameters
tool_slug1 / 1
#validinvalidschema
1251n/a{
2251n/a "type": "string"
3251n/a}
Headers
accept-language3 / 3
1232n/a{
2232n/a "anyOf": [
3160n/a {
4160n/a "type": "string"
5160n/a },
672160 {
772160 "type": "null"
872160 }
9232n/a ],
10232n/a}
Responses
codedescriptionhitsavg
200Successful Response2129ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error397ms
Path Parameters
item_id2 / 2
#validinvalidschema
11553{
21553 "format": "uuid4",
3158n/a "type": "string"
41553}
Headers
accept-language3 / 3
163n/a{
263n/a "anyOf": [
342n/a {
442n/a "type": "string"
542n/a },
62142 {
72142 "type": "null"
82142 }
963n/a ],
1063n/a}
Responses
codedescriptionhitsavg
200Successful Response4218ms
422Validation Error37ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1138ms
Path Parameters
item_id2 / 2
#validinvalidschema
121711{
221711 "format": "uuid4",
3228n/a "type": "string"
421711}
Headers
accept-language3 / 3
172n/a{
272n/a "anyOf": [
349n/a {
449n/a "type": "string"
549n/a },
62349 {
72349 "type": "null"
82349 }
972n/a ],
1072n/a}
Responses
codedescriptionhitsavg
200Successful Response1178ms
422Validation Error118ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1008ms
Path Parameters
item_id1 / 2
#validinvalidschema
11680{
21680 "format": "uuid4",
3168n/a "type": "string"
41680}
Headers
accept-language3 / 3
1167n/a{
2167n/a "anyOf": [
3107n/a {
4107n/a "type": "string"
5107n/a },
660107 {
760107 "type": "null"
860107 }
9167n/a ],
10167n/a}
Body
application/json6 / 6
RecipeToolCreate
112924{
213215 "properties": {
34410 "householdsWithTool": {
4445 "items": {
51705 "type": "string"
6445 },
7495 "type": "array"
84410 },
91395 "name": {
101395 "type": "string"
111395 }
1213215 },
131443 "required": [
141443 "name"
151443 ],
161476 "type": "object"
1712924}
Responses
codedescriptionhitsavg
200Successful Response3610ms
422Validation Error393ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request8511ms
404Not Found88ms
Examples
Body: application/json
[]RecipeToolCreate.householdsWithTool
Recipe: Bulk Actions 8 operations 5 covered 3 partial 0 uncovered 0 not measured 95% #
Headers
accept-language3 / 3
#validinvalidschema
1151n/a{
2151n/a "anyOf": [
3114n/a {
4114n/a "type": "string"
5114n/a },
637114 {
737114 "type": "null"
837114 }
9151n/a ],
10151n/a}
Body
application/json16 / 18
AssignCategories
18662{
28848 "properties": {
39738 "categories": {
49733 "items": {
69733 },
71305 "type": "array"
89738 },
912510 "recipes": {
101255 "items": {
111965 "type": "string"
121255 },
131305 "type": "array"
1412510 }
158848 },
161342 "required": [
171351 "recipes",
181351 "categories"
191342 ],
2013612 "type": "object"
218662}
Referenced Components (1)12 of 14 keywords
CategoryBase12 of 14 keywords
110833{
211319 "properties": {
3624 "groupId": {
4624 "anyOf": [
54521 {
6450 "format": "uuid4",
74521 "type": "string"
84521 },
91749 {
101749 "type": "null"
111749 }
12624 ],
13624 },
141265 "id": {
151260 "format": "uuid4",
161265 "type": "string"
171265 },
181245 "name": {
191245 "type": "string"
201245 },
211265 "slug": {
221265 "type": "string"
231265 }
2411319 },
251279 "required": [
261297 "name",
271315 "id",
281315 "slug"
291279 ],
301365 "type": "object"
3110833}
Responses
codedescriptionhitsavg
200Successful Response485ms
422Validation Error752ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error379ms
400Bad Request31ms
Headers
accept-language3 / 3
#validinvalidschema
198n/a{
298n/a "anyOf": [
368n/a {
468n/a "type": "string"
568n/a },
63068 {
73068 "type": "null"
83068 }
998n/a ],
1098n/a}
Body
application/json5 / 5
DeleteRecipes
15632{
25613 "properties": {
35613 "recipes": {
4565 "items": {
51145 "type": "string"
6565 },
7618 "type": "array"
85613 }
95613 },
106910 "required": [
116910 "recipes"
126910 ],
13799 "type": "object"
145632}
Responses
codedescriptionhitsavg
200Successful Response558ms
422Validation Error502ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request221ms
Headers
accept-language3 / 3
#validinvalidschema
196n/a{
296n/a "anyOf": [
369n/a {
469n/a "type": "string"
569n/a },
62769 {
72769 "type": "null"
82769 }
996n/a ],
1096n/a}
Responses
codedescriptionhitsavg
200Successful Response10818ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
188n/a{
288n/a "anyOf": [
366n/a {
466n/a "type": "string"
566n/a },
62266 {
72266 "type": "null"
82266 }
988n/a ],
1088n/a}
Body
application/json8 / 8
ExportRecipes
18234{
28620 "properties": {
33810 "exportType": {
53810 },
69210 "recipes": {
7925 "items": {
82405 "type": "string"
9925 },
10975 "type": "array"
119210 }
128620 },
131029 "required": [
141029 "recipes"
151029 ],
161115 "type": "object"
178234}
Referenced Components (1)3 of 3 keywords
ExportTypes3 of 3 keywords
13810{
23810 "enum": [
338n/a "json"
43810 ],
5435 "type": "string"
63810}
Responses
codedescriptionhitsavg
202Successful Response4116ms
422Validation Error532ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error409ms
Examples
Body: application/json
"json"ExportRecipes.exportType
Query Parameters
path1 / 2
#validinvalidschema
11080{
200 "format": "path",
3108n/a "type": "string"
41080}
Headers
accept-language3 / 3
1140n/a{
2140n/a "anyOf": [
379n/a {
479n/a "type": "string"
579n/a },
66179 {
76179 "type": "null"
86179 }
9140n/a ],
10140n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error13ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1067ms
500Internal Server Error28ms
Headers
accept-language3 / 3
#validinvalidschema
1120n/a{
2120n/a "anyOf": [
382n/a {
482n/a "type": "string"
582n/a },
63882 {
73882 "type": "null"
83882 }
9120n/a ],
10120n/a}
Responses
codedescriptionhitsavg
200Successful Response10823ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1133n/a{
2133n/a "anyOf": [
3115n/a {
4115n/a "type": "string"
5115n/a },
618115 {
718115 "type": "null"
818115 }
9133n/a ],
10133n/a}
Body
application/json14 / 14
AssignSettings
18580{
29862 "properties": {
313810 "recipes": {
41385 "items": {
5315 "type": "string"
61385 },
71435 "type": "array"
813810 },
910752 "settings": {
1110752 }
129862 },
1314713 "required": [
1414812 "recipes",
151591 "settings"
1614713 ],
171605 "type": "object"
188580}
Referenced Components (1)9 of 9 keywords
RecipeSettings9 of 9 keywords
110752{
25347 "properties": {
37915 "disableComments": {
47915 "type": "boolean"
57915 },
6638 "landscapeView": {
7638 "type": "boolean"
8638 },
97012 "locked": {
107012 "type": "boolean"
117012 },
12705 "public": {
13705 "type": "boolean"
14705 },
15615 "showAssets": {
16615 "type": "boolean"
17615 },
18595 "showNutrition": {
19595 "type": "boolean"
20595 }
215347 },
221545 "type": "object"
2310752}
Responses
codedescriptionhitsavg
200Successful Response805ms
422Validation Error872ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error108ms
400Bad Request31ms
Examples
Body: application/json
trueRecipeSettings.disableComments
falseRecipeSettings.landscapeView
falseRecipeSettings.locked
falseRecipeSettings.public
falseRecipeSettings.showAssets
falseRecipeSettings.showNutrition
Headers
accept-language3 / 3
#validinvalidschema
1342n/a{
2342n/a "anyOf": [
3249n/a {
4249n/a "type": "string"
5249n/a },
693249 {
793249 "type": "null"
893249 }
9342n/a ],
10342n/a}
Body
application/json17 / 18
AssignTags
136467{
236758 "properties": {
340221 "recipes": {
44027 "items": {
5144320 "type": "string"
64027 },
740914 "type": "array"
840221 },
937747 "tags": {
1037741 "items": {
111266154 "$ref": "#/components/schemas/TagBase"
1237741 },
134186 "type": "array"
1437747 }
1536758 },
164223 "required": [
174232 "recipes",
184241 "tags"
194223 ],
204256 "type": "object"
2136467}
Referenced Components (1)13 of 14 keywords
TagBase13 of 14 keywords
11266154{
21273142 "properties": {
369723 "groupId": {
469723 "anyOf": [
5334386 {
63344 "format": "uuid4",
7338382 "type": "string"
8334386 },
9363357 {
10363357 "type": "null"
11363357 }
1269723 ],
1369723 },
14139420 "id": {
1513940 "format": "uuid4",
16139420 "type": "string"
17139420 },
181301109 "name": {
191301109 "type": "string"
201301109 },
2114095 "slug": {
2214095 "type": "string"
2314095 }
241273142 },
2514087 "required": [
2614105 "name",
2714141 "id",
2814141 "slug"
2914087 ],
3014155 "type": "object"
311266154}
Responses
codedescriptionhitsavg
200Successful Response9219ms
422Validation Error823ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error27130ms
400Bad Request71ms
Recipe: Comments 6 operations 4 covered 2 partial 0 uncovered 0 not measured 94% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1153n/a{
2153n/a "anyOf": [
3141n/a {
4141n/a "type": "string"
5141n/a },
612141 {
712141 "type": "null"
812141 }
9153n/a ],
10153n/a}
orderByNullPosition5 / 5
112434{
212434 "anyOf": [
311840 {
511840 },
66152 {
76152 "type": "null"
86152 }
912434 ],
1012434}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
111840{
211840 "enum": [
373n/a "first",
445n/a "last"
511840 ],
6152n/a "type": "string"
711840}
orderDirection2 / 2
OrderDirection
119116{
219116 "enum": [
3127n/a "asc",
464n/a "desc"
519116 ],
6207n/a "type": "string"
719116}
queryFilter3 / 3
1125n/a{
2125n/a "anyOf": [
3119n/a {
4119n/a "type": "string"
5119n/a },
66119 {
76119 "type": "null"
86119 }
9125n/a ],
10125n/a}
paginationSeed3 / 3
1132n/a{
2132n/a "anyOf": [
3120n/a {
4120n/a "type": "string"
5120n/a },
612120 {
712120 "type": "null"
812120 }
9132n/a ],
10132n/a}
page1 / 1
117727{
217727 "type": "integer"
317727}
perPage1 / 1
115720{
215720 "type": "integer"
315720}
Headers
accept-language3 / 3
1345n/a{
2345n/a "anyOf": [
3246n/a {
4246n/a "type": "string"
5246n/a },
699246 {
799246 "type": "null"
899246 }
9345n/a ],
10345n/a}
Responses
codedescriptionhitsavg
200Successful Response28514ms
422Validation Error739ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request698ms
500Internal Server Error1412ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1339n/a{
2339n/a "anyOf": [
3244n/a {
4244n/a "type": "string"
5244n/a },
695244 {
795244 "type": "null"
895244 }
9339n/a ],
10339n/a}
Body
application/json6 / 6
RecipeCommentCreate
139447{
240328 "properties": {
340718 "recipeId": {
44078 "format": "uuid4",
541510 "type": "string"
640718 },
741810 "text": {
841810 "type": "string"
941810 }
1040328 },
114229 "required": [
124256 "recipeId",
134283 "text"
144229 ],
1543110 "type": "object"
1639447}
Responses
codedescriptionhitsavg
201Successful Response39420ms
422Validation Error645ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request31ms
Path Parameters
item_id1 / 2
#validinvalidschema
11790{
21790 "format": "uuid4",
3179n/a "type": "string"
41790}
Headers
accept-language3 / 3
158n/a{
258n/a "anyOf": [
338n/a {
438n/a "type": "string"
538n/a },
62038 {
72038 "type": "null"
82038 }
958n/a ],
1058n/a}
Responses
codedescriptionhitsavg
200Successful Response3418ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1459ms
Path Parameters
item_id2 / 2
#validinvalidschema
11154{
21154 "format": "uuid4",
3119n/a "type": "string"
41154}
Headers
accept-language3 / 3
127n/a{
227n/a "anyOf": [
320n/a {
420n/a "type": "string"
520n/a },
6720 {
7720 "type": "null"
8720 }
927n/a ],
1027n/a}
Responses
codedescriptionhitsavg
200Successful Response59ms
422Validation Error48ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found11012ms
Path Parameters
item_id1 / 2
#validinvalidschema
11330{
21330 "format": "uuid4",
3133n/a "type": "string"
41330}
Headers
accept-language3 / 3
172n/a{
272n/a "anyOf": [
354n/a {
454n/a "type": "string"
554n/a },
61854 {
71854 "type": "null"
81854 }
972n/a ],
1072n/a}
Body
application/json5 / 6
RecipeCommentUpdate
111217{
211410 "properties": {
31185 "id": {
41180 "format": "uuid4",
51185 "type": "string"
61185 },
71185 "text": {
81185 "type": "string"
91185 }
1011410 },
111222 "required": [
121231 "id",
131231 "text"
141222 ],
151245 "type": "object"
1611217}
Responses
codedescriptionhitsavg
200Successful Response422ms
422Validation Error213ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1089ms
Path Parameters
slug1 / 1
#validinvalidschema
1221n/a{
2221n/a "type": "string"
3221n/a}
Headers
accept-language3 / 3
1118n/a{
2118n/a "anyOf": [
379n/a {
479n/a "type": "string"
579n/a },
63979 {
73979 "type": "null"
83979 }
9118n/a ],
10118n/a}
Responses
codedescriptionhitsavg
200Successful Response20117ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error207ms
Recipe: CRUD 17 operations 9 covered 8 partial 0 uncovered 0 not measured 91% #
Query Parameters
categories5 / 7
#validinvalidschema
116927{
216927 "anyOf": [
316927 {
4169n/a "items": {
5448n/a "anyOf": [
6122354 {
7122326 "format": "uuid4",
8448n/a "type": "string"
9122354 },
10448n/a {
11448n/a "type": "string"
12448n/a }
13448n/a ]
14169n/a },
151960 "type": "array"
1616927 },
170196 {
180196 "type": "null"
190196 }
2016927 ],
2116927}
tags5 / 7
114114{
214114 "anyOf": [
314114 {
4141n/a "items": {
5255n/a "anyOf": [
6107162 {
7107148 "format": "uuid4",
8255n/a "type": "string"
9107162 },
10255n/a {
11255n/a "type": "string"
12255n/a }
13255n/a ]
14141n/a },
151550 "type": "array"
1614114 },
170155 {
180155 "type": "null"
190155 }
2014114 ],
2114114}
tools5 / 7
113823{
213823 "anyOf": [
313823 {
4138n/a "items": {
5292n/a "anyOf": [
6107211 {
7107185 "format": "uuid4",
8292n/a "type": "string"
9107211 },
10292n/a {
11292n/a "type": "string"
12292n/a }
13292n/a ]
14138n/a },
151610 "type": "array"
1613823 },
170161 {
180161 "type": "null"
190161 }
2013823 ],
2113823}
foods5 / 7
116020{
216020 "anyOf": [
316020 {
4160n/a "items": {
5421n/a "anyOf": [
6121320 {
7121300 "format": "uuid4",
8421n/a "type": "string"
9121320 },
10421n/a {
11421n/a "type": "string"
12421n/a }
13421n/a ]
14160n/a },
151800 "type": "array"
1616020 },
170180 {
180180 "type": "null"
190180 }
2016020 ],
2116020}
households5 / 7
117016{
217016 "anyOf": [
317016 {
4170n/a "items": {
5315n/a "anyOf": [
6120211 {
7120195 "format": "uuid4",
8315n/a "type": "string"
9120211 },
10315n/a {
11315n/a "type": "string"
12315n/a }
13315n/a ]
14170n/a },
151860 "type": "array"
1617016 },
170186 {
180186 "type": "null"
190186 }
2017016 ],
2117016}
orderBy3 / 3
1183n/a{
2183n/a "anyOf": [
3173n/a {
4173n/a "type": "string"
5173n/a },
610173 {
710173 "type": "null"
810173 }
9183n/a ],
10183n/a}
orderByNullPosition5 / 5
117626{
217626 "anyOf": [
316636 {
516636 },
610192 {
710192 "type": "null"
810192 }
917626 ],
1017626}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
116636{
216636 "enum": [
3147n/a "first",
419n/a "last"
516636 ],
6192n/a "type": "string"
716636}
orderDirection2 / 2
OrderDirection
119114{
219114 "enum": [
3163n/a "asc",
428n/a "desc"
519114 ],
6205n/a "type": "string"
719114}
queryFilter3 / 3
1173n/a{
2173n/a "anyOf": [
3167n/a {
4167n/a "type": "string"
5167n/a },
66167 {
76167 "type": "null"
86167 }
9173n/a ],
10173n/a}
paginationSeed3 / 3
1189n/a{
2189n/a "anyOf": [
3181n/a {
4181n/a "type": "string"
5181n/a },
68181 {
78181 "type": "null"
88181 }
9189n/a ],
10189n/a}
page1 / 1
118627{
218627 "type": "integer"
318627}
perPage1 / 1
120222{
220222 "type": "integer"
320222}
cookbook5 / 5
1188n/a{
2188n/a "anyOf": [
312464 {
412456 "format": "uuid4",
5180n/a "type": "string"
612464 },
7180n/a {
8180n/a "type": "string"
9180n/a },
108180 {
118180 "type": "null"
128180 }
13188n/a ],
14188n/a}
requireAllCategories1 / 1
122010{
222010 "type": "boolean"
322010}
requireAllTags1 / 1
119911{
219911 "type": "boolean"
319911}
requireAllTools1 / 1
118915{
218915 "type": "boolean"
318915}
requireAllFoods1 / 1
120715{
220715 "type": "boolean"
320715}
search3 / 3
1175n/a{
2175n/a "anyOf": [
3160n/a {
4160n/a "type": "string"
5160n/a },
615160 {
715160 "type": "null"
815160 }
9175n/a ],
10175n/a}
Headers
accept-language3 / 3
1491n/a{
2491n/a "anyOf": [
3405n/a {
4405n/a "type": "string"
5405n/a },
686405 {
786405 "type": "null"
886405 }
9491n/a ],
10491n/a}
Responses
codedescriptionhitsavg
200Successful Response24719ms
422Validation Error1175ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1216ms
400Bad Request279ms
500Internal Server Error7614ms
Examples
Query
"desc"orderDirection
1page
50perPage
falserequireAllCategories
falserequireAllTags
falserequireAllTools
falserequireAllFoods
Headers
accept-language3 / 3
#validinvalidschema
11157n/a{
21157n/a "anyOf": [
31116n/a {
41116n/a "type": "string"
51116n/a },
6411116 {
7411116 "type": "null"
8411116 }
91157n/a ],
101157n/a}
Body
application/json376 / 409
1399786{
2399772 "items": {
4399772 },
5117114 "type": "array"
6399786}
Referenced Components (22)481 of 519 keywords
CreateIngredientFood28 of 30 keywords
1120388{
2122147 "properties": {
316532 "aliases": {
416522 "items": {
616522 },
718710 "type": "array"
816532 },
918310 "description": {
1018310 "type": "string"
1118310 },
121648 "extras": {
131648 "anyOf": [
1414725 {
151n/a "additionalProperties": true,
1614725 "type": "object"
1714725 },
1817155 {
1917155 "type": "null"
2017155 }
211648 ],
221648 },
2315321 "householdsWithIngredientFood": {
2415310 "items": {
2519110 "type": "string"
2615310 },
2716311 "type": "array"
2815321 },
292338 "id": {
302338 "anyOf": [
3122912 {
322290 "format": "uuid4",
3322912 "type": "string"
3422912 },
354237 {
364237 "type": "null"
374237 }
382338 ],
392338 },
4015250 "labelId": {
4115250 "anyOf": [
4213963 {
431390 "format": "uuid4",
4413963 "type": "string"
4513963 },
4613189 {
4713189 "type": "null"
4813189 }
4915250 ],
5015250 },
5125710 "name": {
5225710 "type": "string"
5325710 },
541608 "pluralName": {
551608 "anyOf": [
5618150 {
5718150 "type": "string"
5818150 },
5914226 {
6014226 "type": "null"
6114226 }
621608 ],
631608 }
64122147 },
652673 "required": [
662673 "name"
672673 ],
68270238 "type": "object"
69120388}
CreateIngredientFoodAlias6 of 6 keywords
128222{
228210 "properties": {
328210 "name": {
428210 "type": "string"
528210 }
628210 },
72922 "required": [
82922 "name"
92922 ],
1029410 "type": "object"
1128222}
CreateIngredientUnit29 of 30 keywords
1103377{
2105127 "properties": {
316910 "abbreviation": {
416910 "type": "string"
516910 },
614232 "aliases": {
714222 "items": {
914222 },
1016410 "type": "array"
1114232 },
1216710 "description": {
1316710 "type": "string"
1416710 },
1516511 "extras": {
1616511 "anyOf": [
1715125 {
181n/a "additionalProperties": true,
1915125 "type": "object"
2015125 },
2114162 {
2214162 "type": "null"
2314162 }
2416511 ],
2516511 },
2615710 "fraction": {
2715710 "type": "boolean"
2815710 },
291878 "id": {
301878 "anyOf": [
3117619 {
321760 "format": "uuid4",
3317619 "type": "string"
3417619 },
3511184 {
3611184 "type": "null"
3711184 }
381878 ],
391878 },
4022010 "name": {
4122010 "type": "string"
4222010 },
431628 "pluralAbbreviation": {
441628 "anyOf": [
4514525 {
4614525 "type": "string"
4714525 },
4817153 {
4917153 "type": "null"
5017153 }
511628 ],
521628 },
531578 "pluralName": {
541578 "anyOf": [
5513152 {
5613152 "type": "string"
5713152 },
5814421 {
5914421 "type": "null"
6014421 }
611578 ],
621578 },
6314920 "useAbbreviation": {
6414920 "type": "boolean"
6514920 }
66105127 },
6723017 "required": [
6823017 "name"
6923017 ],
70247233 "type": "object"
71103377}
CreateIngredientUnitAlias6 of 6 keywords
16722{
26710 "properties": {
36710 "name": {
46710 "type": "string"
56710 }
66710 },
7772 "required": [
8772 "name"
9772 ],
107910 "type": "object"
116722}
IngredientFood-Input33 of 41 keywords
180428{
2110159 "properties": {
316532 "aliases": {
416522 "items": {
616522 },
718710 "type": "array"
816532 },
9980 "createdAt": {
10980 "anyOf": [
118018 {
12800 "format": "date-time",
138018 "type": "string"
148018 },
151880 {
161880 "type": "null"
171880 }
18980 ],
19980 },
2018310 "description": {
2118310 "type": "string"
2218310 },
231648 "extras": {
241648 "anyOf": [
2514725 {
261n/a "additionalProperties": true,
2714725 "type": "object"
2814725 },
2917155 {
3017155 "type": "null"
3117155 }
321648 ],
331648 },
3415321 "householdsWithIngredientFood": {
3515310 "items": {
3619110 "type": "string"
3715310 },
3816311 "type": "array"
3915321 },
4022912 "id": {
412290 "format": "uuid4",
4222912 "type": "string"
4322912 },
44958 "label": {
45958 "anyOf": [
461588 {
481588 },
498023 {
508023 "type": "null"
518023 }
52958 ]
53958 },
5415250 "labelId": {
5515250 "anyOf": [
5613963 {
571390 "format": "uuid4",
5813963 "type": "string"
5913963 },
6013189 {
6113189 "type": "null"
6213189 }
6315250 ],
6415250 },
6525710 "name": {
6625710 "type": "string"
6725710 },
681608 "pluralName": {
691608 "anyOf": [
7018150 {
7118150 "type": "string"
7218150 },
7314226 {
7414226 "type": "null"
7514226 }
761608 ],
771608 },
781010 "update_at": {
791010 "anyOf": [
807922 {
81790 "format": "date-time",
827922 "type": "string"
837922 },
842279 {
852279 "type": "null"
862279 }
871010 ],
881010 }
89110159 },
9023931 "required": [
9124129 "id",
922673 "name"
9323931 ],
94270238 "type": "object"
9580428}
IngredientFoodAlias6 of 6 keywords
128222{
228210 "properties": {
328210 "name": {
428210 "type": "string"
528210 }
628210 },
72922 "required": [
82922 "name"
92922 ],
1029410 "type": "object"
1128222}
IngredientReferences8 of 8 keywords
114715{
26210 "properties": {
36210 "referenceId": {
46210 "anyOf": [
53141 {
6316 "format": "uuid4",
73735 "type": "string"
83141 },
93141 {
103141 "type": "null"
113141 }
126210 ],
136210 }
146210 },
151575 "type": "object"
1614715}
IngredientUnit-Input30 of 37 keywords
168412{
296136 "properties": {
316910 "abbreviation": {
416910 "type": "string"
516910 },
614232 "aliases": {
714222 "items": {
914222 },
1016410 "type": "array"
1114232 },
12920 "createdAt": {
13920 "anyOf": [
14839 {
15830 "format": "date-time",
16839 "type": "string"
17839 },
18983 {
19983 "type": "null"
20983 }
21920 ],
22920 },
2316710 "description": {
2416710 "type": "string"
2516710 },
2616511 "extras": {
2716511 "anyOf": [
2815125 {
291n/a "additionalProperties": true,
3015125 "type": "object"
3115125 },
3214162 {
3314162 "type": "null"
3414162 }
3516511 ],
3616511 },
3715710 "fraction": {
3815710 "type": "boolean"
3915710 },
4017619 "id": {
411760 "format": "uuid4",
4217619 "type": "string"
4317619 },
4422010 "name": {
4522010 "type": "string"
4622010 },
471628 "pluralAbbreviation": {
481628 "anyOf": [
4914525 {
5014525 "type": "string"
5114525 },
5217153 {
5317153 "type": "null"
5417153 }
551628 ],
561628 },
571578 "pluralName": {
581578 "anyOf": [
5913152 {
6013152 "type": "string"
6113152 },
6214421 {
6314421 "type": "null"
6414421 }
651578 ],
661578 },
67810 "update_at": {
68810 "anyOf": [
69747 {
70740 "format": "date-time",
71747 "type": "string"
72747 },
73774 {
74774 "type": "null"
75774 }
76810 ],
77810 },
7814920 "useAbbreviation": {
7914920 "type": "boolean"
8014920 }
8196136 },
8219354 "required": [
8319552 "id",
8423017 "name"
8519354 ],
86247233 "type": "object"
8768412}
IngredientUnitAlias6 of 6 keywords
16722{
26710 "properties": {
36710 "name": {
46710 "type": "string"
56710 }
66710 },
7772 "required": [
8772 "name"
9772 ],
107910 "type": "object"
116722}
MultiPurposeLabelSummary4 of 11 keywords
11588{
2158 "properties": {
390 "color": {
490 "type": "string"
590 },
6230 "groupId": {
7230 "format": "uuid4",
8230 "type": "string"
9230 },
10230 "id": {
11230 "format": "uuid4",
12230 "type": "string"
13230 },
14158 "name": {
15158 "type": "string"
16158 }
17158 },
18230 "required": [
19230 "name",
20230 "groupId",
21230 "id"
22230 ],
232380 "type": "object"
241588}
Nutrition47 of 47 keywords
169999{
26064 "properties": {
3864 "calories": {
4864 "anyOf": [
51674 {
61674 "type": "string"
71674 },
87020 {
97020 "type": "null"
107020 }
11864 ],
12864 },
13964 "carbohydrateContent": {
14964 "anyOf": [
151684 {
161684 "type": "string"
171684 },
188020 {
198020 "type": "null"
208020 }
21964 ],
22964 },
23895 "cholesterolContent": {
24895 "anyOf": [
251777 {
261777 "type": "string"
271777 },
287222 {
297222 "type": "null"
307222 }
31895 ],
32895 },
338223 "fatContent": {
348223 "anyOf": [
351095 {
361095 "type": "string"
371095 },
387233 {
397233 "type": "null"
407233 }
418223 ],
428223 },
43884 "fiberContent": {
44884 "anyOf": [
451082 {
461082 "type": "string"
471082 },
487814 {
497814 "type": "null"
507814 }
51884 ],
52884 },
53864 "proteinContent": {
54864 "anyOf": [
551278 {
561278 "type": "string"
571278 },
587416 {
597416 "type": "null"
607416 }
61864 ],
62864 },
63814 "saturatedFatContent": {
64814 "anyOf": [
651273 {
661273 "type": "string"
671273 },
686916 {
696916 "type": "null"
706916 }
71814 ],
72814 },
73825 "sodiumContent": {
74825 "anyOf": [
75483 {
76483 "type": "string"
77483 },
78789 {
79789 "type": "null"
80789 }
81825 ],
82825 },
83924 "sugarContent": {
84924 "anyOf": [
851680 {
861680 "type": "string"
871680 },
887620 {
897620 "type": "null"
907620 }
91924 ],
92924 },
93784 "transFatContent": {
94784 "anyOf": [
951171 {
961171 "type": "string"
971171 },
986715 {
996715 "type": "null"
1006715 }
101784 ],
102784 },
103804 "unsaturatedFatContent": {
104804 "anyOf": [
1051866 {
1061866 "type": "string"
1071866 },
1086222 {
1096222 "type": "null"
1106222 }
111804 ],
112804 }
1136064 },
114133935 "type": "object"
11569999}
Recipe-Input125 of 128 keywords
1625791{
2559786 "properties": {
3102926 "assets": {
4102926 "anyOf": [
5100352 {
6100322 "items": {
8100322 },
9102530 "type": "array"
10100352 },
11261029 {
12261029 "type": "null"
13261029 }
14102926 ],
15102926 },
1696677 "comments": {
1796677 "anyOf": [
1894796 {
1994773 "items": {
2194773 },
22102023 "type": "array"
2394796 },
24191024 {
25191024 "type": "null"
26191024 }
2796677 ],
2896677 },
2910504 "cookTime": {
3010504 "anyOf": [
31301024 {
32301024 "type": "string"
33301024 },
34102034 {
35102034 "type": "null"
36102034 }
3710504 ],
3810504 },
3910476 "createdAt": {
4010476 "anyOf": [
41102528 {
4210252 "format": "date-time",
43102726 "type": "string"
44102528 },
45221031 {
46221031 "type": "null"
47221031 }
4810476 ],
4910476 },
5010466 "dateAdded": {
5110466 "anyOf": [
52101636 {
5310162 "format": "date",
54101834 "type": "string"
55101636 },
56301022 {
57301022 "type": "null"
58301022 }
5910466 ],
6010466 },
61104710 "dateUpdated": {
62104710 "anyOf": [
63102235 {
6410222 "format": "date-time",
65102433 "type": "string"
66102235 },
67251032 {
68251032 "type": "null"
69251032 }
70104710 ],
71104710 },
7210544 "description": {
7310544 "anyOf": [
74101741 {
75101741 "type": "string"
76101741 },
77371021 {
78371021 "type": "null"
79371021 }
8010544 ],
8110544 },
8210459 "extras": {
8310459 "anyOf": [
84101242 {
851n/a "additionalProperties": true,
86101242 "type": "object"
87101242 },
88331021 {
89331021 "type": "null"
90331021 }
9110459 ],
9210459 },
9310485 "groupId": {
9410480 "format": "uuid4",
9510485 "type": "string"
9610485 },
9710465 "householdId": {
9810460 "format": "uuid4",
9910465 "type": "string"
10010465 },
10110585 "id": {
10210585 "anyOf": [
103102934 {
10410291 "format": "uuid4",
105103033 "type": "string"
106102934 },
107291034 {
108291034 "type": "null"
109291034 }
11010585 ],
11110585 },
112994n/a "image": {
113994n/a "anyOf": [
114994n/a {},
1159886 {
1169886 "type": "null"
1179886 }
118994n/a ],
119994n/a },
12010386 "lastMade": {
12110386 "anyOf": [
122101628 {
12310162 "format": "date-time",
124101826 "type": "string"
125101628 },
126221022 {
127221022 "type": "null"
128221022 }
12910386 ],
13010386 },
13110274 "name": {
13210274 "anyOf": [
133211010 {
134211010 "type": "string"
135211010 },
136100625 {
137100625 "type": "null"
138100625 }
13910274 ],
14010274 },
141102024 "notes": {
142102024 "anyOf": [
143100044 {
144100020 "items": {
146100020 },
147102024 "type": "array"
148100044 },
149201024 {
150201024 "type": "null"
151201024 }
152102024 ],
153102024 },
154100068 "nutrition": {
155100068 "anyOf": [
15669999 {
15869999 },
159931137 {
160931137 "type": "null"
161931137 }
162100068 ]
163100068 },
16410254 "orgURL": {
16510254 "anyOf": [
166241005 {
167241005 "type": "string"
168241005 },
169100128 {
170100128 "type": "null"
171100128 }
17210254 ],
17310254 },
17410314 "performTime": {
17510314 "anyOf": [
176221013 {
177221013 "type": "string"
178221013 },
179100926 {
180100926 "type": "null"
181100926 }
18210314 ],
18310314 },
18410374 "prepTime": {
18510374 "anyOf": [
186241017 {
187241017 "type": "string"
188241017 },
189101328 {
190101328 "type": "null"
191101328 }
19210374 ],
19310374 },
194102315 "rating": {
195102315 "anyOf": [
196201018 {
197201018 "type": "number"
198201018 },
199100335 {
200100335 "type": "null"
201100335 }
202102315 ],
203102315 },
204101437 "recipeCategory": {
205101437 "anyOf": [
20698467 {
20798426 "items": {
20998426 },
210101041 "type": "array"
21198467 },
212301021 {
213301021 "type": "null"
214301021 }
215101437 ],
216101437 },
217751306 "recipeIngredient": {
218751301 "items": {
220751301 },
22110525 "type": "array"
222751306 },
22397745 "recipeInstructions": {
22497745 "anyOf": [
22595864 {
22695841 "items": {
22895841 },
22999923 "type": "array"
23095864 },
231191003 {
232191003 "type": "null"
233191003 }
23497745 ],
23597745 },
23610305 "recipeServings": {
23710305 "type": "number"
23810305 },
23910384 "recipeYield": {
24010384 "anyOf": [
241251017 {
242251017 "type": "string"
243251017 },
244101329 {
245101329 "type": "null"
246101329 }
24710384 ],
24810384 },
24910425 "recipeYieldQuantity": {
25010425 "type": "number"
25110425 },
25299743 "settings": {
25399743 "anyOf": [
25441999 {
25641999 },
25795684 {
25895684 "type": "null"
25995684 }
26099743 ]
26199743 },
26210415 "slug": {
26310415 "type": "string"
26410415 },
26599336 "tags": {
26699336 "anyOf": [
26797257 {
26897232 "items": {
27097232 },
271100425 "type": "array"
27297257 },
273211008 {
274211008 "type": "null"
275211008 }
27699336 ],
27799336 },
27898344 "tools": {
27998339 "items": {
28198339 },
28210225 "type": "array"
28398344 },
28410074 "totalTime": {
28510074 "anyOf": [
28618993 {
28718993 "type": "string"
28818993 },
28998922 {
29098922 "type": "null"
29198922 }
29210074 ],
29310074 },
29410026 "update_at": {
29510026 "anyOf": [
29699117 {
2979912 "format": "date-time",
29899315 "type": "string"
29999117 },
30011997 {
30111997 "type": "null"
30211997 }
30310026 ],
30410026 },
30510185 "userId": {
30610180 "format": "uuid4",
30710185 "type": "string"
30810185 }
309559786 },
31014115 "type": "object"
311625791}
RecipeAsset11 of 11 keywords
15423{
25614 "properties": {
3414 "fileName": {
4414 "anyOf": [
51827 {
61827 "type": "string"
71827 },
82322 {
92322 "type": "null"
102322 }
11414 ],
12414 },
13645 "icon": {
14645 "type": "string"
15645 },
16645 "name": {
17645 "type": "string"
18645 }
195614 },
20682 "required": [
21691 "name",
22691 "icon"
23682 ],
24707 "type": "object"
255423}
RecipeCategory15 of 17 keywords
110627{
210818 "properties": {
3674 "groupId": {
4674 "anyOf": [
54328 {
6430 "format": "uuid4",
74328 "type": "string"
84328 },
92447 {
102447 "type": "null"
112447 }
12674 ],
13674 },
14734 "id": {
15734 "anyOf": [
164433 {
17440 "format": "uuid4",
184433 "type": "string"
194433 },
202948 {
212948 "type": "null"
222948 }
23734 ],
24734 },
251205 "name": {
261205 "type": "string"
271205 },
281205 "slug": {
291205 "type": "string"
301205 }
3110818 },
321242 "required": [
331251 "name",
341251 "slug"
351242 ],
361267 "type": "object"
3710627}
RecipeCommentOut-Input14 of 17 keywords
16580{
27761 "properties": {
31316 "createdAt": {
41311 "format": "date-time",
51325 "type": "string"
61316 },
71325 "id": {
81320 "format": "uuid4",
91325 "type": "string"
101325 },
111325 "recipeId": {
121320 "format": "uuid4",
131325 "type": "string"
141325 },
151325 "text": {
161325 "type": "string"
171325 },
181266 "update_at": {
191261 "format": "date-time",
201275 "type": "string"
211266 },
2210829 "user": {
2410829 },
251325 "userId": {
261320 "format": "uuid4",
271325 "type": "string"
281325 }
297761 },
3012612 "required": [
311371 "recipeId",
321371 "text",
331371 "id",
341371 "createdAt",
351326 "update_at",
361371 "userId",
371371 "user"
3812612 ],
391387 "type": "object"
406580}
RecipeIngredient-Input32 of 32 keywords
1272356{
2244351 "properties": {
34695 "display": {
44695 "type": "string"
54695 },
6354154 "food": {
7354154 "anyOf": [
880428 {
1080428 },
11120388 {
13120388 },
14234274 {
15234274 "type": "null"
16234274 }
17354154 ],
18354154 },
194554 "note": {
204554 "anyOf": [
2140356 {
2240356 "type": "string"
2340356 },
2452407 {
2552407 "type": "null"
2652407 }
274554 ],
284554 },
2945518 "originalText": {
3045518 "anyOf": [
3129444 {
3229444 "type": "string"
3329444 },
3442647 {
3542647 "type": "null"
3642647 }
3745518 ],
3845518 },
394514 "quantity": {
404514 "anyOf": [
4140847 {
4240847 "type": "number"
4340847 },
4443412 {
4543412 "type": "null"
4643412 }
474514 ],
484514 },
4944512 "referenceId": {
504457 "format": "uuid",
514525 "type": "string"
5244512 },
534484 "title": {
544484 "anyOf": [
5553399 {
5653399 "type": "string"
5753399 },
5839557 {
5939557 "type": "null"
6039557 }
614484 ],
624484 },
63330150 "unit": {
64330150 "anyOf": [
6568412 {
6768412 },
68103377 {
70103377 },
71227253 {
72227253 "type": "null"
73227253 }
74330150 ],
75330150 }
76244351 },
776235 "type": "object"
78272356}
RecipeNote7 of 7 keywords
119724{
219915 "properties": {
320310 "text": {
420310 "type": "string"
520310 },
62085 "title": {
72085 "type": "string"
82085 }
919915 },
102122 "required": [
112131 "title",
122131 "text"
132122 ],
142147 "type": "object"
1519724}
RecipeSettings9 of 9 keywords
141999{
23738 "properties": {
3545 "disableComments": {
4545 "type": "boolean"
5545 },
6535 "landscapeView": {
7535 "type": "boolean"
8535 },
95013 "locked": {
105013 "type": "boolean"
115013 },
12485 "public": {
13485 "type": "boolean"
14485 },
15495 "showAssets": {
16495 "type": "boolean"
17495 },
18525 "showNutrition": {
19525 "type": "boolean"
20525 }
213738 },
2279961 "type": "object"
2341999}
RecipeStep21 of 21 keywords
18143{
28235 "properties": {
3686 "id": {
4686 "anyOf": [
55420 {
6542 "format": "uuid",
75618 "type": "string"
85420 },
91460 {
101460 "type": "null"
111460 }
12686 ],
13686 },
146216 "ingredientReferences": {
156211 "items": {
176211 },
18735 "type": "array"
196216 },
20724 "summary": {
21724 "anyOf": [
226016 {
236016 "type": "string"
246016 },
251264 {
261264 "type": "null"
271264 }
28724 ],
29724 },
301115 "text": {
311115 "type": "string"
321115 },
33714 "title": {
34714 "anyOf": [
355619 {
365619 "type": "string"
375619 },
381560 {
391560 "type": "null"
401560 }
41714 ],
42714 }
438235 },
441161 "required": [
451161 "text"
461161 ],
471177 "type": "object"
488143}
RecipeTag15 of 17 keywords
111997{
212188 "properties": {
3944 "groupId": {
4944 "anyOf": [
55246 {
6520 "format": "uuid4",
75246 "type": "string"
85246 },
94256 {
104256 "type": "null"
114256 }
12944 ],
13944 },
147674 "id": {
157674 "anyOf": [
1644106 {
17440 "format": "uuid4",
1844106 "type": "string"
1944106 },
2032118 {
2132118 "type": "null"
2232118 }
237674 ],
247674 },
252035 "name": {
262035 "type": "string"
272035 },
282035 "slug": {
292035 "type": "string"
302035 }
3112188 },
322072 "required": [
332081 "name",
342081 "slug"
352072 ],
362097 "type": "object"
3711997}
RecipeTool14 of 16 keywords
130239{
230729 "properties": {
31694 "groupId": {
41694 "anyOf": [
510172 {
61010 "format": "uuid4",
710172 "type": "string"
810172 },
968105 {
1068105 "type": "null"
1168105 }
121694 ],
131694 },
1415210 "householdsWithTool": {
151525 "items": {
165505 "type": "string"
171525 },
181575 "type": "array"
1915210 },
203285 "id": {
213280 "format": "uuid4",
223285 "type": "string"
233285 },
243305 "name": {
253305 "type": "string"
263305 },
273305 "slug": {
283305 "type": "string"
293305 }
3030729 },
313315 "required": [
323333 "id",
333351 "name",
343351 "slug"
353315 ],
363365 "type": "object"
3730239}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
110829{
211022 "properties": {
31229 "admin": {
41229 "type": "boolean"
51229 },
6974 "fullName": {
7974 "anyOf": [
82279 {
92279 "type": "string"
102279 },
117526 {
127526 "type": "null"
137526 }
14974 ],
15974 },
161265 "id": {
171260 "format": "uuid4",
181265 "type": "string"
191265 },
20934 "username": {
21934 "anyOf": [
222374 {
232374 "type": "string"
242374 },
257027 {
267027 "type": "null"
277027 }
28934 ],
29934 }
3011022 },
311302 "required": [
321311 "id",
331311 "admin"
341302 ],
351325 "type": "object"
3610829}
Responses
codedescriptionhitsavg
200Successful Response2513ms
422Validation Error6973ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error48310ms
400Bad Request161ms
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
1364n/a{
2364n/a "anyOf": [
3235n/a {
4235n/a "type": "string"
5235n/a },
6129235 {
7129235 "type": "null"
8129235 }
9364n/a ],
10364n/a}
Body
application/json4 / 4
CreateRecipe
138131{
23818 "properties": {
33818 "name": {
43818 "type": "string"
53818 }
63818 },
738918 "required": [
838918 "name"
938918 ],
104075 "type": "object"
1138131}
Responses
codedescriptionhitsavg
201Successful Response27473ms
422Validation Error414ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5517ms
400Bad Request6120ms
Headers
accept-language3 / 3
#validinvalidschema
11117n/a{
21117n/a "anyOf": [
31093n/a {
41093n/a "type": "string"
51093n/a },
6241093 {
7241093 "type": "null"
8241093 }
91117n/a ],
101117n/a}
Body
application/json371 / 409
1376760{
2376750 "items": {
4376750 },
5112610 "type": "array"
6376760}
Referenced Components (22)474 of 519 keywords
CreateIngredientFood28 of 30 keywords
165341{
267114 "properties": {
312032 "aliases": {
412022 "items": {
612022 },
714210 "type": "array"
812032 },
913910 "description": {
1013910 "type": "string"
1113910 },
121398 "extras": {
131398 "anyOf": [
1413116 {
151n/a "additionalProperties": true,
1613116 "type": "object"
1713116 },
188139 {
198139 "type": "null"
208139 }
211398 ],
221398 },
2312220 "householdsWithIngredientFood": {
2412210 "items": {
253310 "type": "string"
2612210 },
2713210 "type": "array"
2812220 },
291598 "id": {
301598 "anyOf": [
3115611 {
321560 "format": "uuid4",
3315611 "type": "string"
3415611 },
353164 {
363164 "type": "null"
373164 }
381598 ],
391598 },
401348 "labelId": {
411348 "anyOf": [
4212121 {
431210 "format": "uuid4",
4412121 "type": "string"
4512121 },
4613129 {
4713129 "type": "null"
4813129 }
491348 ],
501348 },
5116910 "name": {
5216910 "type": "string"
5316910 },
5412618 "pluralName": {
5512618 "anyOf": [
568136 {
578136 "type": "string"
588136 },
5911826 {
6011826 "type": "null"
6111826 }
6212618 ],
6312618 }
6467114 },
651793 "required": [
661793 "name"
671793 ],
68182224 "type": "object"
6965341}
CreateIngredientFoodAlias6 of 6 keywords
15322{
25310 "properties": {
35310 "name": {
45310 "type": "string"
55310 }
65310 },
7632 "required": [
8632 "name"
9632 ],
106510 "type": "object"
115322}
CreateIngredientUnit29 of 30 keywords
166335{
268121 "properties": {
315410 "abbreviation": {
415410 "type": "string"
515410 },
612932 "aliases": {
712922 "items": {
912922 },
1015110 "type": "array"
1112932 },
1214910 "description": {
1314910 "type": "string"
1414910 },
151498 "extras": {
161498 "anyOf": [
1714314 {
181n/a "additionalProperties": true,
1914314 "type": "object"
2014314 },
216151 {
226151 "type": "null"
236151 }
241498 ],
251498 },
2613817 "fraction": {
2713817 "type": "boolean"
2813817 },
291608 "id": {
301608 "anyOf": [
3115612 {
321560 "format": "uuid4",
3315612 "type": "string"
3415612 },
354164 {
364164 "type": "null"
374164 }
381608 ],
391608 },
4017710 "name": {
4117710 "type": "string"
4217710 },
431468 "pluralAbbreviation": {
441468 "anyOf": [
4513618 {
4613618 "type": "string"
4713618 },
4810144 {
4910144 "type": "null"
5010144 }
511468 ],
521468 },
531398 "pluralName": {
541398 "anyOf": [
557140 {
567140 "type": "string"
577140 },
5813215 {
5913215 "type": "null"
6013215 }
611398 ],
621398 },
6313610 "useAbbreviation": {
6413610 "type": "boolean"
6513610 }
6668121 },
671873 "required": [
681873 "name"
691873 ],
70190211 "type": "object"
7166335}
CreateIngredientUnitAlias6 of 6 keywords
14722{
24710 "properties": {
34710 "name": {
44710 "type": "string"
54710 }
64710 },
7572 "required": [
8572 "name"
9572 ],
105910 "type": "object"
114722}
IngredientFood-Input31 of 41 keywords
148358{
264117 "properties": {
312032 "aliases": {
412022 "items": {
612022 },
714210 "type": "array"
812032 },
9810 "createdAt": {
10810 "anyOf": [
11756 {
12750 "format": "date-time",
13756 "type": "string"
14756 },
15675 {
16675 "type": "null"
17675 }
18810 ],
19810 },
2013910 "description": {
2113910 "type": "string"
2213910 },
231398 "extras": {
241398 "anyOf": [
2513116 {
261n/a "additionalProperties": true,
2713116 "type": "object"
2813116 },
298139 {
308139 "type": "null"
318139 }
321398 ],
331398 },
3412220 "householdsWithIngredientFood": {
3512210 "items": {
363310 "type": "string"
3712210 },
3813210 "type": "array"
3912220 },
4015611 "id": {
411560 "format": "uuid4",
4215611 "type": "string"
4315611 },
44750 "label": {
45750 "anyOf": [
46768 {
48768 },
49687 {
50687 "type": "null"
51687 }
52750 ]
53750 },
541348 "labelId": {
551348 "anyOf": [
5612121 {
571210 "format": "uuid4",
5812121 "type": "string"
5912121 },
6013129 {
6113129 "type": "null"
6213129 }
631348 ],
641348 },
6516910 "name": {
6616910 "type": "string"
6716910 },
6812618 "pluralName": {
6912618 "anyOf": [
708136 {
718136 "type": "string"
728136 },
7311826 {
7411826 "type": "null"
7511826 }
7612618 ],
7712618 },
78760 "update_at": {
79760 "anyOf": [
80697 {
81690 "format": "date-time",
82697 "type": "string"
83697 },
84769 {
85769 "type": "null"
86769 }
87760 ],
88760 }
8964117 },
9016517 "required": [
9116715 "id",
921793 "name"
9316517 ],
94182224 "type": "object"
9548358}
IngredientFoodAlias6 of 6 keywords
15322{
25310 "properties": {
35310 "name": {
45310 "type": "string"
55310 }
65310 },
7632 "required": [
8632 "name"
9632 ],
106510 "type": "object"
115322}
IngredientReferences7 of 8 keywords
1509{
2244 "properties": {
3244 "referenceId": {
4244 "anyOf": [
51018 {
6100 "format": "uuid4",
71018 "type": "string"
81018 },
91414 {
101414 "type": "null"
111414 }
12244 ],
13244 }
14244 },
15545 "type": "object"
16509}
IngredientUnit-Input30 of 37 keywords
145356{
266123 "properties": {
315410 "abbreviation": {
415410 "type": "string"
515410 },
612932 "aliases": {
712922 "items": {
912922 },
1015110 "type": "array"
1112932 },
12790 "createdAt": {
13790 "anyOf": [
14763 {
15760 "format": "date-time",
16763 "type": "string"
17763 },
18376 {
19376 "type": "null"
20376 }
21790 ],
22790 },
2314910 "description": {
2414910 "type": "string"
2514910 },
261498 "extras": {
271498 "anyOf": [
2814314 {
291n/a "additionalProperties": true,
3014314 "type": "object"
3114314 },
326151 {
336151 "type": "null"
346151 }
351498 ],
361498 },
3713817 "fraction": {
3813817 "type": "boolean"
3913817 },
4015612 "id": {
411560 "format": "uuid4",
4215612 "type": "string"
4315612 },
4417710 "name": {
4517710 "type": "string"
4617710 },
471468 "pluralAbbreviation": {
481468 "anyOf": [
4913618 {
5013618 "type": "string"
5113618 },
5210144 {
5310144 "type": "null"
5410144 }
551468 ],
561468 },
571398 "pluralName": {
581398 "anyOf": [
597140 {
607140 "type": "string"
617140 },
6213215 {
6313215 "type": "null"
6413215 }
651398 ],
661398 },
67730 "update_at": {
68730 "anyOf": [
69694 {
70690 "format": "date-time",
71694 "type": "string"
72694 },
73469 {
74469 "type": "null"
75469 }
76730 ],
77730 },
7813610 "useAbbreviation": {
7913610 "type": "boolean"
8013610 }
8166123 },
8216624 "required": [
8316822 "id",
841873 "name"
8516624 ],
86190211 "type": "object"
8745356}
IngredientUnitAlias6 of 6 keywords
14722{
24710 "properties": {
34710 "name": {
44710 "type": "string"
54710 }
64710 },
7572 "required": [
8572 "name"
9572 ],
105910 "type": "object"
114722}
MultiPurposeLabelSummary1 of 11 keywords
1768{
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 ],
23768 "type": "object"
24768}
Nutrition47 of 47 keywords
143973{
24249 "properties": {
3685 "calories": {
4685 "anyOf": [
5469 {
6469 "type": "string"
7469 },
8649 {
9649 "type": "null"
10649 }
11685 ],
12685 },
13715 "carbohydrateContent": {
14715 "anyOf": [
15571 {
16571 "type": "string"
17571 },
186610 {
196610 "type": "null"
206610 }
21715 ],
22715 },
23664 "cholesterolContent": {
24664 "anyOf": [
25466 {
26466 "type": "string"
27466 },
28628 {
29628 "type": "null"
30628 }
31664 ],
32664 },
33674 "fatContent": {
34674 "anyOf": [
35764 {
36764 "type": "string"
37764 },
386011 {
396011 "type": "null"
406011 }
41674 ],
42674 },
43657 "fiberContent": {
44657 "anyOf": [
45567 {
46567 "type": "string"
47567 },
486012 {
496012 "type": "null"
506012 }
51657 ],
52657 },
53617 "proteinContent": {
54617 "anyOf": [
55365 {
56365 "type": "string"
57365 },
585810 {
595810 "type": "null"
605810 }
61617 ],
62617 },
63644 "saturatedFatContent": {
64644 "anyOf": [
65662 {
66662 "type": "string"
67662 },
685810 {
695810 "type": "null"
705810 }
71644 ],
72644 },
73614 "sodiumContent": {
74614 "anyOf": [
75461 {
76461 "type": "string"
77461 },
78578 {
79578 "type": "null"
80578 }
81614 ],
82614 },
83614 "sugarContent": {
84614 "anyOf": [
85560 {
86560 "type": "string"
87560 },
88569 {
89569 "type": "null"
90569 }
91614 ],
92614 },
93604 "transFatContent": {
94604 "anyOf": [
95559 {
96559 "type": "string"
97559 },
98559 {
99559 "type": "null"
100559 }
101604 ],
102604 },
103604 "unsaturatedFatContent": {
104604 "anyOf": [
105757 {
106757 "type": "string"
107757 },
1085311 {
1095311 "type": "null"
1105311 }
111604 ],
112604 }
1134249 },
11492924 "type": "object"
11543973}
Recipe-Input124 of 128 keywords
1454779{
2406773 "properties": {
3100727 "assets": {
4100727 "anyOf": [
598549 {
698522 "items": {
898522 },
9100727 "type": "array"
1098549 },
11221012 {
12221012 "type": "null"
13221012 }
14100727 ],
15100727 },
1694784 "comments": {
1794784 "anyOf": [
1894289 {
1994273 "items": {
2194273 },
22101516 "type": "array"
2394289 },
2451026 {
2551026 "type": "null"
2651026 }
2794784 ],
2894784 },
2910314 "cookTime": {
3010314 "anyOf": [
31171018 {
32171018 "type": "string"
33171018 },
34101421 {
35101421 "type": "null"
36101421 }
3710314 ],
3810314 },
3910146 "createdAt": {
4010146 "anyOf": [
41100119 {
4210012 "format": "date-time",
43100317 "type": "string"
44100119 },
45131007 {
46131007 "type": "null"
47131007 }
4810146 ],
4910146 },
5010246 "dateAdded": {
5110246 "anyOf": [
52100723 {
5310072 "format": "date",
54100921 "type": "string"
55100723 },
56171013 {
57171013 "type": "null"
58171013 }
5910246 ],
6010246 },
6110306 "dateUpdated": {
6210306 "anyOf": [
63100927 {
6410092 "format": "date-time",
65101125 "type": "string"
66100927 },
67211015 {
68211015 "type": "null"
69211015 }
7010306 ],
7110306 },
7210174 "description": {
7310174 "anyOf": [
74100813 {
75100813 "type": "string"
76100813 },
7791012 {
7891012 "type": "null"
7991012 }
8010174 ],
8110174 },
8210384 "extras": {
8310384 "anyOf": [
84101131 {
851n/a "additionalProperties": true,
86101131 "type": "object"
87101131 },
88271015 {
89271015 "type": "null"
90271015 }
9110384 ],
9210384 },
9310165 "groupId": {
9410160 "format": "uuid4",
9510165 "type": "string"
9610165 },
97101211 "householdId": {
9810120 "format": "uuid4",
99101211 "type": "string"
100101211 },
10110244 "id": {
10210244 "anyOf": [
103100721 {
10410070 "format": "uuid4",
105100721 "type": "string"
106100721 },
107171011 {
108171011 "type": "null"
109171011 }
11010244 ],
11110244 },
112992n/a "image": {
113992n/a "anyOf": [
114992n/a {},
1159866 {
1169866 "type": "null"
1179866 }
118992n/a ],
119992n/a },
12010086 "lastMade": {
12110086 "anyOf": [
12299222 {
1239922 "format": "date-time",
12499420 "type": "string"
12599222 },
12616998 {
12716998 "type": "null"
12816998 }
12910086 ],
13010086 },
13110024 "name": {
13210024 "anyOf": [
1337999 {
1347999 "type": "string"
1357999 },
13699511 {
13799511 "type": "null"
13899511 }
13910024 ],
14010024 },
14199136 "notes": {
14299136 "anyOf": [
14397552 {
14497518 "items": {
14697518 },
14799334 "type": "array"
14897552 },
149161011 {
150161011 "type": "null"
151161011 }
15299136 ],
15399136 },
15496353 "nutrition": {
15596353 "anyOf": [
15643973 {
15843973 },
15992096 {
16092096 "type": "null"
16192096 }
16296353 ]
16396353 },
16410186 "orgURL": {
16510186 "anyOf": [
166151009 {
167151009 "type": "string"
168151009 },
169100321 {
170100321 "type": "null"
171100321 }
17210186 ],
17310186 },
17410134 "performTime": {
17510134 "anyOf": [
17681009 {
17781009 "type": "string"
17881009 },
179100512 {
180100512 "type": "null"
181100512 }
18210134 ],
18310134 },
18410094 "prepTime": {
18510094 "anyOf": [
18691004 {
18791004 "type": "string"
18891004 },
189100013 {
190100013 "type": "null"
191100013 }
19210094 ],
19310094 },
19410184 "rating": {
19510184 "anyOf": [
196201002 {
197201002 "type": "number"
198201002 },
19999824 {
20099824 "type": "null"
20199824 }
20210184 ],
20310184 },
20498630 "recipeCategory": {
20598630 "anyOf": [
20697046 {
20797026 "items": {
20997026 },
21099620 "type": "array"
21197046 },
212161000 {
213161000 "type": "null"
214161000 }
21598630 ],
21698630 },
217725272 "recipeIngredient": {
218725267 "items": {
220725267 },
2219925 "type": "array"
222725272 },
22396444 "recipeInstructions": {
22496444 "anyOf": [
22594761 {
22694740 "items": {
22894740 },
22998721 "type": "array"
23094761 },
23117991 {
23217991 "type": "null"
23317991 }
23496444 ],
23596444 },
23610015 "recipeServings": {
23710015 "type": "number"
23810015 },
23910024 "recipeYield": {
24010024 "anyOf": [
24116990 {
24216990 "type": "string"
24316990 },
24498620 {
24598620 "type": "null"
24698620 }
24710024 ],
24810024 },
2499915 "recipeYieldQuantity": {
2509915 "type": "number"
2519915 },
25297536 "settings": {
25397536 "anyOf": [
25433978 {
25633978 },
25794269 {
25894269 "type": "null"
25994269 }
26097536 ]
26197536 },
2629995 "slug": {
2639995 "type": "string"
2649995 },
26597830 "tags": {
26697830 "anyOf": [
26796444 {
26896426 "items": {
27096426 },
27199018 "type": "array"
27296444 },
27314994 {
27414994 "type": "null"
27514994 }
27697830 ],
27797830 },
27896452 "tools": {
27996443 "items": {
28196443 },
28210079 "type": "array"
28396452 },
28410165 "totalTime": {
28510165 "anyOf": [
286201001 {
287201001 "type": "string"
288201001 },
28999625 {
29099625 "type": "null"
29199625 }
29210165 ],
29310165 },
29410097 "update_at": {
29510097 "anyOf": [
29699323 {
2979932 "format": "date-time",
29899521 "type": "string"
29999323 },
300161000 {
301161000 "type": "null"
302161000 }
30310097 ],
30410097 },
3059935 "userId": {
3069930 "format": "uuid4",
3079935 "type": "string"
3089935 }
309406773 },
31012276 "type": "object"
311454779}
RecipeAsset11 of 11 keywords
13223{
23414 "properties": {
3304 "fileName": {
4304 "anyOf": [
5925 {
6925 "type": "string"
7925 },
82113 {
92113 "type": "null"
102113 }
11304 ],
12304 },
13425 "icon": {
14425 "type": "string"
15425 },
16425 "name": {
17425 "type": "string"
18425 }
193414 },
20462 "required": [
21471 "name",
22471 "icon"
23462 ],
24487 "type": "object"
253223}
RecipeCategory15 of 17 keywords
17527{
27718 "properties": {
3544 "groupId": {
4544 "anyOf": [
52830 {
6280 "format": "uuid4",
72830 "type": "string"
82830 },
92632 {
102632 "type": "null"
112632 }
12544 ],
13544 },
14454 "id": {
15454 "anyOf": [
163217 {
17320 "format": "uuid4",
183217 "type": "string"
193217 },
201336 {
211336 "type": "null"
221336 }
23454 ],
24454 },
25895 "name": {
26895 "type": "string"
27895 },
28895 "slug": {
29895 "type": "string"
30895 }
317718 },
32932 "required": [
33941 "name",
34941 "slug"
35932 ],
36957 "type": "object"
377527}
RecipeCommentOut-Input14 of 17 keywords
17786{
28472 "properties": {
313421 "createdAt": {
41341 "format": "date-time",
513520 "type": "string"
613421 },
71505 "id": {
81500 "format": "uuid4",
91505 "type": "string"
101505 },
111505 "recipeId": {
121500 "format": "uuid4",
131505 "type": "string"
141505 },
151505 "text": {
161505 "type": "string"
171505 },
181496 "update_at": {
191491 "format": "date-time",
201505 "type": "string"
211496 },
2213025 "user": {
2413025 },
251505 "userId": {
261500 "format": "uuid4",
271505 "type": "string"
281505 }
298472 },
301497 "required": [
311551 "recipeId",
321551 "text",
331551 "id",
341551 "createdAt",
351551 "update_at",
361551 "userId",
371551 "user"
381497 ],
391567 "type": "object"
407786}
RecipeIngredient-Input32 of 32 keywords
1160281{
2154276 "properties": {
33955 "display": {
43955 "type": "string"
53955 },
6285121 "food": {
7285121 "anyOf": [
848358 {
1048358 },
1165341 {
1365341 },
14220186 {
15220186 "type": "null"
16220186 }
17285121 ],
18285121 },
193944 "note": {
203944 "anyOf": [
2137820 {
2237820 "type": "string"
2337820 },
2416382 {
2516382 "type": "null"
2616382 }
273944 ],
283944 },
293964 "originalText": {
303964 "anyOf": [
3115385 {
3215385 "type": "string"
3315385 },
3438119 {
3538119 "type": "null"
3638119 }
373964 ],
383964 },
393874 "quantity": {
403874 "anyOf": [
4137714 {
4237714 "type": "number"
4337714 },
4410381 {
4510381 "type": "null"
4610381 }
473874 ],
483874 },
493896 "referenceId": {
503891 "format": "uuid",
513905 "type": "string"
523896 },
533934 "title": {
543934 "anyOf": [
5522375 {
5622375 "type": "string"
5722375 },
5837126 {
5937126 "type": "null"
6037126 }
613934 ],
623934 },
63273128 "unit": {
64273128 "anyOf": [
6545356 {
6745356 },
6866335 {
7066335 },
71207194 {
72207194 "type": "null"
73207194 }
74273128 ],
75273128 }
76154276 },
774365 "type": "object"
78160281}
RecipeNote7 of 7 keywords
12319{
22510 "properties": {
3295 "text": {
4295 "type": "string"
5295 },
6295 "title": {
7295 "type": "string"
8295 }
92510 },
10332 "required": [
11341 "title",
12341 "text"
13332 ],
14357 "type": "object"
152319}
RecipeSettings9 of 9 keywords
133978{
23232 "properties": {
3457 "disableComments": {
4457 "type": "boolean"
5457 },
6415 "landscapeView": {
7415 "type": "boolean"
8415 },
9405 "locked": {
10405 "type": "boolean"
11405 },
12515 "public": {
13515 "type": "boolean"
14515 },
15475 "showAssets": {
16475 "type": "boolean"
17475 },
18445 "showNutrition": {
19445 "type": "boolean"
20445 }
213232 },
2265946 "type": "object"
2333978}
RecipeStep21 of 21 keywords
13341{
23433 "properties": {
3456 "id": {
4456 "anyOf": [
54011 {
6402 "format": "uuid",
7429 "type": "string"
84011 },
9546 {
10546 "type": "null"
11546 }
12456 ],
13456 },
143714 "ingredientReferences": {
15379 "items": {
17379 },
18465 "type": "array"
193714 },
20484 "summary": {
21484 "anyOf": [
224210 {
234210 "type": "string"
244210 },
25646 {
26646 "type": "null"
27646 }
28484 ],
29484 },
30615 "text": {
31615 "type": "string"
32615 },
33464 "title": {
34464 "anyOf": [
35437 {
36437 "type": "string"
37437 },
38347 {
39347 "type": "null"
40347 }
41464 ],
42464 }
433433 },
44661 "required": [
45661 "text"
46661 ],
47677 "type": "object"
483341}
RecipeTag15 of 17 keywords
17027{
27218 "properties": {
3564 "groupId": {
4564 "anyOf": [
54416 {
6440 "format": "uuid4",
74416 "type": "string"
84416 },
91248 {
101248 "type": "null"
111248 }
12564 ],
13564 },
14524 "id": {
15524 "anyOf": [
164412 {
17440 "format": "uuid4",
184412 "type": "string"
194412 },
20848 {
21848 "type": "null"
22848 }
23524 ],
24524 },
25845 "name": {
26845 "type": "string"
27845 },
28845 "slug": {
29845 "type": "string"
30845 }
317218 },
32882 "required": [
33891 "name",
34891 "slug"
35882 ],
36907 "type": "object"
377027}
RecipeTool14 of 16 keywords
114153{
214742 "properties": {
310417 "groupId": {
410417 "anyOf": [
56259 {
6620 "format": "uuid4",
76259 "type": "string"
86259 },
94279 {
104279 "type": "null"
114279 }
1210417 ],
1310417 },
1410910 "householdsWithTool": {
151095 "items": {
163835 "type": "string"
171095 },
181145 "type": "array"
1910910 },
201805 "id": {
211800 "format": "uuid4",
221805 "type": "string"
231805 },
241835 "name": {
251835 "type": "string"
261835 },
271835 "slug": {
281835 "type": "string"
291835 }
3014742 },
311836 "required": [
321854 "id",
331881 "name",
341881 "slug"
351836 ],
361895 "type": "object"
3714153}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
113025{
213218 "properties": {
31445 "admin": {
41445 "type": "boolean"
51445 },
6984 "fullName": {
7984 "anyOf": [
82775 {
92775 "type": "string"
102775 },
117131 {
127131 "type": "null"
137131 }
14984 ],
15984 },
161445 "id": {
171440 "format": "uuid4",
181445 "type": "string"
191445 },
201014 "username": {
211014 "anyOf": [
222976 {
232976 "type": "string"
242976 },
257233 {
267233 "type": "null"
277233 }
281014 ],
291014 }
3013218 },
311482 "required": [
321491 "id",
331491 "admin"
341482 ],
351505 "type": "object"
3613025}
Responses
codedescriptionhitsavg
200Successful Response147ms
422Validation Error6793ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error46210ms
400Bad Request101ms
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
185n/a{
285n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
62362 {
72362 "type": "null"
82362 }
985n/a ],
1085n/a}
Body
application/json5 / 5
ScrapeRecipeData
14231{
25210 "properties": {
3475 "data": {
4475 "type": "string"
5475 },
6315 "includeTags": {
7315 "type": "boolean"
8315 }
95210 },
105216 "required": [
115216 "data"
125216 ],
13685 "type": "object"
144231}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error562ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request723ms
Examples
Body: application/json
falseScrapeRecipeData.includeTags
Query Parameters
translateLanguage3 / 3
#validinvalidschema
157n/a{
257n/a "anyOf": [
355n/a {
455n/a "type": "string"
555n/a },
6255 {
7255 "type": "null"
8255 }
957n/a ],
1057n/a}
Headers
accept-language3 / 3
1115n/a{
2115n/a "anyOf": [
388n/a {
488n/a "type": "string"
588n/a },
62788 {
72788 "type": "null"
82788 }
9115n/a ],
10115n/a}
Body
multipart/form-data4 / 6
Body_create_recipe_from_image_api_recipes_create_image_post
15568{
2550 "properties": {
3550 "images": {
455n/a "items": {
5241n/a "format": "binary",
6241n/a "type": "string"
755n/a },
8550 "type": "array"
9550 }
10550 },
115568 "required": [
125568 "images"
135568 ],
14123n/a "type": "object"
155568}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error883ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request567ms
Headers
accept-language3 / 3
#validinvalidschema
1400n/a{
2400n/a "anyOf": [
3243n/a {
4243n/a "type": "string"
5243n/a },
6157243 {
7157243 "type": "null"
8157243 }
9400n/a ],
10400n/a}
Body
application/json5 / 5
ScrapeRecipe
138343{
239317 "properties": {
327310 "includeTags": {
427310 "type": "boolean"
527310 },
638812 "url": {
738812 "type": "string"
838812 }
939317 },
1040020 "required": [
1140020 "url"
1240020 ],
134206 "type": "object"
1438343}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error594ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request39845ms
Examples
Body: application/json
{ "includeTags": true, "url": "https://myfavoriterecipes.com/recipes" }ScrapeRecipe
falseScrapeRecipe.includeTags
Headers
accept-language3 / 3
#validinvalidschema
1163n/a{
2163n/a "anyOf": [
3140n/a {
4140n/a "type": "string"
5140n/a },
623140 {
723140 "type": "null"
823140 }
9163n/a ],
10163n/a}
Body
application/json39 / 43
CreateRecipeByUrlBulk
17795{
27785 "properties": {
37785 "imports": {
47780 "items": {
67780 },
71575 "type": "array"
87785 }
97785 },
101625 "required": [
111625 "imports"
121625 ],
131675 "type": "object"
147795}
Referenced Components (3)46 of 50 keywords
CreateRecipeBulk16 of 16 keywords
111785{
211879 "properties": {
310144 "categories": {
410144 "anyOf": [
57471 {
67440 "items": {
87440 },
911431 "type": "array"
107471 },
1127118 {
1227118 "type": "null"
1327118 }
1410144 ],
1510144 },
1610144 "tags": {
1710144 "anyOf": [
187867 {
197830 "items": {
217830 },
2210837 "type": "array"
237867 },
2423122 {
2523122 "type": "null"
2623122 }
2710144 ],
2810144 },
291915 "url": {
301915 "type": "string"
311915 }
3211879 },
331961 "required": [
341961 "url"
351961 ],
361975 "type": "object"
3711785}
RecipeCategory15 of 17 keywords
19947{
210138 "properties": {
3708 "groupId": {
4708 "anyOf": [
54632 {
6460 "format": "uuid4",
74632 "type": "string"
84632 },
92454 {
102454 "type": "null"
112454 }
12708 ],
13708 },
146524 "id": {
156524 "anyOf": [
164148 {
17410 "format": "uuid4",
184148 "type": "string"
194148 },
202465 {
212465 "type": "null"
222465 }
236524 ],
246524 },
251335 "name": {
261335 "type": "string"
271335 },
2811721 "slug": {
2911721 "type": "string"
3011721 }
3110138 },
321372 "required": [
331381 "name",
341381 "slug"
351372 ],
361397 "type": "object"
379947}
RecipeTag15 of 17 keywords
110035{
210226 "properties": {
3544 "groupId": {
4544 "anyOf": [
53226 {
6320 "format": "uuid4",
73226 "type": "string"
83226 },
92236 {
102236 "type": "null"
112236 }
12544 ],
13544 },
14594 "id": {
15594 "anyOf": [
164023 {
17400 "format": "uuid4",
184023 "type": "string"
194023 },
201944 {
211944 "type": "null"
221944 }
23594 ],
24594 },
2511413 "name": {
2611413 "type": "string"
2711413 },
281225 "slug": {
291225 "type": "string"
301225 }
3110226 },
321262 "required": [
331271 "name",
341271 "slug"
351262 ],
361287 "type": "object"
3710035}
Responses
codedescriptionhitsavg
202Successful Response7737ms
422Validation Error1103ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request237ms
Headers
accept-language3 / 3
#validinvalidschema
176n/a{
276n/a "anyOf": [
351n/a {
451n/a "type": "string"
551n/a },
62551 {
72551 "type": "null"
82551 }
976n/a ],
1076n/a}
Body
multipart/form-data5 / 5
Body_create_recipe_from_zip_api_recipes_create_zip_post
15228{
252n/a "properties": {
352n/a "archive": {
452n/a "format": "binary",
552n/a "type": "string"
652n/a }
752n/a },
85228 "required": [
95228 "archive"
105228 ],
1180n/a "type": "object"
125228}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error414ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error669ms
400Bad Request41ms
Query Parameters
foods3 / 5
#validinvalidschema
113732{
213732 "anyOf": [
313732 {
413732 "items": {
539063 "format": "uuid4",
6453n/a "type": "string"
713732 },
81690 "type": "array"
913732 },
100169 {
110169 "type": "null"
120169 }
1313732 ],
1413732}
tools3 / 5
111227{
211227 "anyOf": [
311227 {
411227 "items": {
535428 "format": "uuid4",
6382n/a "type": "string"
711227 },
81390 "type": "array"
911227 },
100139 {
110139 "type": "null"
120139 }
1311227 ],
1411227}
orderBy3 / 3
1164n/a{
2164n/a "anyOf": [
3151n/a {
4151n/a "type": "string"
5151n/a },
613151 {
713151 "type": "null"
813151 }
9164n/a ],
10164n/a}
orderByNullPosition5 / 5
113929{
213929 "anyOf": [
312543 {
512543 },
614154 {
714154 "type": "null"
814154 }
913929 ],
1013929}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112543{
212543 "enum": [
398n/a "first",
427n/a "last"
512543 ],
6154n/a "type": "string"
712543}
orderDirection2 / 2
OrderDirection
117121{
217121 "enum": [
3139n/a "asc",
432n/a "desc"
517121 ],
6192n/a "type": "string"
717121}
queryFilter3 / 3
1175n/a{
2175n/a "anyOf": [
3164n/a {
4164n/a "type": "string"
5164n/a },
611164 {
711164 "type": "null"
811164 }
9175n/a ],
10175n/a}
paginationSeed3 / 3
1155n/a{
2155n/a "anyOf": [
3142n/a {
4142n/a "type": "string"
5142n/a },
613142 {
713142 "type": "null"
813142 }
9155n/a ],
10155n/a}
limit1 / 1
120019{
220019 "type": "integer"
320019}
maxMissingFoods1 / 1
120022{
220022 "type": "integer"
320022}
maxMissingTools1 / 1
120920{
220920 "type": "integer"
320920}
includeFoodsOnHand1 / 1
120613{
220613 "type": "boolean"
320613}
includeToolsOnHand1 / 1
121112{
221112 "type": "boolean"
321112}
Headers
accept-language3 / 3
1419n/a{
2419n/a "anyOf": [
3319n/a {
4319n/a "type": "string"
5319n/a },
6100319 {
7100319 "type": "null"
8100319 }
9419n/a ],
10419n/a}
Responses
codedescriptionhitsavg
200Successful Response32015ms
422Validation Error1395ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request539ms
500Internal Server Error2125ms
Examples
Query
"desc"orderDirection
10limit
5maxMissingFoods
5maxMissingTools
trueincludeFoodsOnHand
trueincludeToolsOnHand
Headers
accept-language3 / 3
#validinvalidschema
170n/a{
270n/a "anyOf": [
350n/a {
450n/a "type": "string"
550n/a },
62050 {
72050 "type": "null"
82050 }
970n/a ],
1070n/a}
Body
application/json5 / 5
ScrapeRecipeTest
19421{
29510 "properties": {
3995 "url": {
4995 "type": "string"
5995 },
6625 "useOpenAI": {
7625 "type": "boolean"
8625 }
99510 },
101046 "required": [
111046 "url"
121046 ],
131105 "type": "object"
149421}
Responses
codedescriptionhitsavg
200Successful Response398ms
422Validation Error323ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error5611ms
400Bad Request11ms
Examples
Body: application/json
falseScrapeRecipeTest.useOpenAI
Path Parameters
slug1 / 1
#validinvalidschema
144n/a{
244n/a "type": "string"
344n/a}
Headers
accept-language3 / 3
125n/a{
225n/a "anyOf": [
318n/a {
418n/a "type": "string"
518n/a },
6718 {
7718 "type": "null"
8718 }
925n/a ],
1025n/a}
Responses
codedescriptionhitsavg
200Successful Response3176ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1316ms
Path Parameters
slug1 / 1
#validinvalidschema
1226n/a{
2226n/a "type": "string"
3226n/a}
Headers
accept-language3 / 3
1182n/a{
2182n/a "anyOf": [
3128n/a {
4128n/a "type": "string"
5128n/a },
654128 {
754128 "type": "null"
854128 }
9182n/a ],
10182n/a}
Responses
codedescriptionhitsavg
200Successful Response19735ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2719ms
500Internal Server Error235ms
Path Parameters
slug1 / 1
#validinvalidschema
12309n/a{
22309n/a "type": "string"
32309n/a}
Headers
accept-language3 / 3
12173n/a{
22173n/a "anyOf": [
32144n/a {
42144n/a "type": "string"
52144n/a },
6292144 {
7292144 "type": "null"
8292144 }
92173n/a ],
102173n/a}
Body
application/json373 / 407
Recipe-Input
15571731{
24431721 "properties": {
3196352 "assets": {
4196352 "anyOf": [
5195659 {
6195644 "items": {
8195644 },
9200015 "type": "array"
10195659 },
1172008 {
1272008 "type": "null"
1372008 }
14196352 ],
15196352 },
161872148 "comments": {
171872148 "anyOf": [
181860160 {
191860140 "items": {
211860140 },
22200020 "type": "array"
231860160 },
24122008 {
25122008 "type": "null"
26122008 }
271872148 ],
281872148 },
2920108 "cookTime": {
3020108 "anyOf": [
31122006 {
32122006 "type": "string"
33122006 },
34199820 {
35199820 "type": "null"
36199820 }
3720108 ],
3820108 },
39199612 "createdAt": {
40199612 "anyOf": [
41199315 {
4219934 "format": "date-time",
43199711 "type": "string"
44199315 },
4532005 {
4632005 "type": "null"
4732005 }
48199612 ],
49199612 },
50200812 "dateAdded": {
51200812 "anyOf": [
52200515 {
5320054 "format": "date",
54200911 "type": "string"
55200515 },
5632017 {
5732017 "type": "null"
5832017 }
59200812 ],
60200812 },
61199712 "dateUpdated": {
62199712 "anyOf": [
63199415 {
6419944 "format": "date-time",
65199811 "type": "string"
66199415 },
6732006 {
6832006 "type": "null"
6932006 }
70199712 ],
71199712 },
7220028 "description": {
7320028 "anyOf": [
74199713 {
75199713 "type": "string"
76199713 },
7752005 {
7852005 "type": "null"
7952005 }
8020028 ],
8120028 },
8220038 "extras": {
8320038 "anyOf": [
84199120 {
851n/a "additionalProperties": true,
86199120 "type": "object"
87199120 },
88121999 {
89121999 "type": "null"
90121999 }
9120038 ],
9220038 },
93200413 "groupId": {
9420043 "format": "uuid4",
95200710 "type": "string"
96200413 },
97199110 "householdId": {
9819910 "format": "uuid4",
99199110 "type": "string"
100199110 },
1011000999 "id": {
1021000999 "anyOf": [
1039961003 {
104996991 "format": "uuid4",
105198712 "type": "string"
1069961003 },
10741995 {
10841995 "type": "null"
10941995 }
1101000999 ],
1111000999 },
1121984n/a "image": {
1131984n/a "anyOf": [
1141984n/a {},
115197212 {
116197212 "type": "null"
117197212 }
1181984n/a ],
1191984n/a },
120198112 "lastMade": {
121198112 "anyOf": [
122197617 {
12319764 "format": "date-time",
124198013 "type": "string"
125197617 },
12651988 {
12751988 "type": "null"
12851988 }
129198112 ],
130198112 },
13119898 "name": {
13219898 "anyOf": [
133161981 {
134161981 "type": "string"
135161981 },
136197324 {
137197324 "type": "null"
138197324 }
13919898 ],
14019898 },
141195544 "notes": {
142195544 "anyOf": [
143194950 {
144194936 "items": {
146194936 },
147198514 "type": "array"
148194950 },
14961993 {
15061993 "type": "null"
15161993 }
152195544 ],
153195544 },
154190296 "nutrition": {
155190296 "anyOf": [
156771921 {
157771921 "$ref": "#/components/schemas/Nutrition"
158771921 },
1591825173 {
1601825173 "type": "null"
1611825173 }
162190296 ]
163190296 },
16419848 "orgURL": {
16519848 "anyOf": [
166101982 {
167101982 "type": "string"
168101982 },
169197418 {
170197418 "type": "null"
171197418 }
17219848 ],
17319848 },
17419788 "performTime": {
17519788 "anyOf": [
17691977 {
17791977 "type": "string"
17891977 },
179196917 {
180196917 "type": "null"
181196917 }
18219788 ],
18319788 },
18419808 "prepTime": {
18519808 "anyOf": [
18651983 {
18751983 "type": "string"
18851983 },
189197513 {
190197513 "type": "null"
191197513 }
19219808 ],
19319808 },
19419828 "rating": {
19519828 "anyOf": [
196121978 {
197121978 "type": "number"
198121978 },
199197020 {
200197020 "type": "null"
201197020 }
20219828 ],
20319828 },
204191760 "recipeCategory": {
205191760 "anyOf": [
206190869 {
207190852 "items": {
209190852 },
210196017 "type": "array"
211190869 },
21291968 {
21391968 "type": "null"
21491968 }
215191760 ],
216191760 },
2171451541 "recipeIngredient": {
2181451531 "items": {
2201451531 },
221198210 "type": "array"
2221451541 },
223188088 "recipeInstructions": {
224188088 "anyOf": [
225187791 {
226187780 "items": {
228187780 },
229195711 "type": "array"
230187791 },
23131965 {
23231965 "type": "null"
23331965 }
234188088 ],
235188088 },
236196410 "recipeServings": {
237196410 "type": "number"
238196410 },
23919718 "recipeYield": {
24019718 "anyOf": [
241201959 {
242201959 "type": "string"
243201959 },
244195128 {
245195128 "type": "null"
246195128 }
24719718 ],
24819718 },
249195111 "recipeYieldQuantity": {
250195111 "type": "number"
251195111 },
252190168 "settings": {
253190168 "anyOf": [
254441925 {
256441925 },
2571857112 {
2581857112 "type": "null"
2591857112 }
260190168 ]
261190168 },
262196410 "slug": {
263196410 "type": "string"
264196410 },
265189760 "tags": {
266189760 "anyOf": [
267189166 {
268189152 "items": {
270189152 },
271194314 "type": "array"
272189166 },
27361951 {
27461951 "type": "null"
27561951 }
276189760 ],
277189760 },
278187984 "tools": {
279187974 "items": {
281187974 },
282195310 "type": "array"
283187984 },
28419508 "totalTime": {
28519508 "anyOf": [
286121946 {
287121946 "type": "string"
288121946 },
289193820 {
290193820 "type": "null"
291193820 }
29219508 ],
29319508 },
294194712 "update_at": {
295194712 "anyOf": [
296194415 {
29719444 "format": "date-time",
298194811 "type": "string"
299194415 },
30031956 {
30131956 "type": "null"
30231956 }
303194712 ],
304194712 },
305197110 "userId": {
30619710 "format": "uuid4",
307197110 "type": "string"
308197110 }
3094431721 },
310227810 "type": "object"
3115571731}
Referenced Components (21)352 of 391 keywords
CreateIngredientFood28 of 30 keywords
1117662{
2121208 "properties": {
322464 "aliases": {
422444 "items": {
622444 },
726820 "type": "array"
822464 },
926320 "description": {
1026320 "type": "string"
1126320 },
1226816 "extras": {
1326816 "anyOf": [
1425331 {
151n/a "additionalProperties": true,
1625331 "type": "object"
1725331 },
1815269 {
1915269 "type": "null"
2015269 }
2126816 ],
2226816 },
2323640 "householdsWithIngredientFood": {
2423620 "items": {
256220 "type": "string"
2623620 },
2725620 "type": "array"
2823640 },
2928416 "id": {
3028416 "anyOf": [
3127624 {
322760 "format": "uuid4",
3327624 "type": "string"
3427624 },
358292 {
368292 "type": "null"
378292 }
3828416 ],
3928416 },
4024716 "labelId": {
4124716 "anyOf": [
4223924 {
432390 "format": "uuid4",
4423924 "type": "string"
4523924 },
468255 {
478255 "type": "null"
488255 }
4924716 ],
5024716 },
5130520 "name": {
5230520 "type": "string"
5330520 },
5424716 "pluralName": {
5524716 "anyOf": [
5610253 {
5710253 "type": "string"
5810253 },
5923726 {
6023726 "type": "null"
6123726 }
6224716 ],
6324716 }
64121208 },
653256 "required": [
663256 "name"
673256 ],
68331448 "type": "object"
69117662}
CreateIngredientFoodAlias6 of 6 keywords
16944{
26920 "properties": {
36920 "name": {
46920 "type": "string"
56920 }
66920 },
7894 "required": [
8894 "name"
9894 ],
109320 "type": "object"
116944}
CreateIngredientUnit30 of 30 keywords
1125648{
2129238 "properties": {
329220 "abbreviation": {
429220 "type": "string"
529220 },
625064 "aliases": {
725044 "items": {
925044 },
1029420 "type": "array"
1125064 },
1228820 "description": {
1328820 "type": "string"
1428820 },
1529116 "extras": {
1629116 "anyOf": [
1727928 {
181n/a "additionalProperties": true,
1927928 "type": "object"
2027928 },
2112295 {
2212295 "type": "null"
2312295 }
2429116 ],
2529116 },
2628620 "fraction": {
2728620 "type": "boolean"
2828620 },
2931126 "id": {
3031126 "anyOf": [
3130730 {
3230710 "format": "uuid4",
3331720 "type": "string"
3430730 },
354333 {
364333 "type": "null"
374333 }
3831126 ],
3931126 },
4034320 "name": {
4134320 "type": "string"
4234320 },
4327616 "pluralAbbreviation": {
4427616 "anyOf": [
4526626 {
4626626 "type": "string"
4726626 },
4810282 {
4910282 "type": "null"
5010282 }
5127616 ],
5227616 },
5327516 "pluralName": {
5427516 "anyOf": [
5512279 {
5612279 "type": "string"
5712279 },
5826328 {
5926328 "type": "null"
6026328 }
6127516 ],
6227516 },
6327220 "useAbbreviation": {
6427220 "type": "boolean"
6527220 }
66129238 },
673636 "required": [
683636 "name"
693636 ],
70369404 "type": "object"
71125648}
CreateIngredientUnitAlias6 of 6 keywords
17144{
27120 "properties": {
37120 "name": {
47120 "type": "string"
57120 }
67120 },
7914 "required": [
8914 "name"
9914 ],
109520 "type": "object"
117144}
IngredientFood-Input31 of 41 keywords
180699{
2113216 "properties": {
322464 "aliases": {
422444 "items": {
622444 },
726820 "type": "array"
822464 },
91450 "createdAt": {
101450 "anyOf": [
111432 {
121430 "format": "date-time",
131432 "type": "string"
141432 },
152143 {
162143 "type": "null"
172143 }
181450 ],
191450 },
2026320 "description": {
2126320 "type": "string"
2226320 },
2326816 "extras": {
2426816 "anyOf": [
2525331 {
261n/a "additionalProperties": true,
2725331 "type": "object"
2825331 },
2915269 {
3015269 "type": "null"
3115269 }
3226816 ],
3326816 },
3423640 "householdsWithIngredientFood": {
3523620 "items": {
366220 "type": "string"
3723620 },
3825620 "type": "array"
3923640 },
4027624 "id": {
412760 "format": "uuid4",
4227624 "type": "string"
4327624 },
441380 "label": {
451380 "anyOf": [
464134 {
484134 },
491344 {
501344 "type": "null"
511344 }
521380 ]
531380 },
5424716 "labelId": {
5524716 "anyOf": [
5623924 {
572390 "format": "uuid4",
5823924 "type": "string"
5923924 },
608255 {
618255 "type": "null"
628255 }
6324716 ],
6424716 },
6530520 "name": {
6630520 "type": "string"
6730520 },
6824716 "pluralName": {
6924716 "anyOf": [
7010253 {
7110253 "type": "string"
7210253 },
7323726 {
7423726 "type": "null"
7523726 }
7624716 ],
7724716 },
781310 "update_at": {
791310 "anyOf": [
801283 {
811280 "format": "date-time",
821283 "type": "string"
831283 },
843128 {
853128 "type": "null"
863128 }
871310 ],
881310 }
89113216 },
9029635 "required": [
9130031 "id",
923256 "name"
9329635 ],
94331448 "type": "object"
9580699}
IngredientFoodAlias6 of 6 keywords
16944{
26920 "properties": {
36920 "name": {
46920 "type": "string"
56920 }
66920 },
7894 "required": [
8894 "name"
9894 ],
109320 "type": "object"
116944}
IngredientReferences7 of 8 keywords
13518{
2158 "properties": {
3158 "referenceId": {
4158 "anyOf": [
5716 {
670 "format": "uuid4",
7716 "type": "string"
8716 },
9815 {
10815 "type": "null"
11815 }
12158 ],
13158 }
14158 },
154310 "type": "object"
163518}
IngredientUnit-Input31 of 37 keywords
191682{
2125242 "properties": {
329220 "abbreviation": {
429220 "type": "string"
529220 },
625064 "aliases": {
725044 "items": {
925044 },
1029420 "type": "array"
1125064 },
121610 "createdAt": {
131610 "anyOf": [
141556 {
151550 "format": "date-time",
161556 "type": "string"
171556 },
186155 {
196155 "type": "null"
206155 }
211610 ],
221610 },
2328820 "description": {
2428820 "type": "string"
2528820 },
2629116 "extras": {
2729116 "anyOf": [
2827928 {
291n/a "additionalProperties": true,
3027928 "type": "object"
3127928 },
3212295 {
3312295 "type": "null"
3412295 }
3529116 ],
3629116 },
3728620 "fraction": {
3828620 "type": "boolean"
3928620 },
4030730 "id": {
4130710 "format": "uuid4",
4231720 "type": "string"
4330730 },
4434320 "name": {
4534320 "type": "string"
4634320 },
4727616 "pluralAbbreviation": {
4827616 "anyOf": [
4926626 {
5026626 "type": "string"
5126626 },
5210282 {
5310282 "type": "null"
5410282 }
5527616 ],
5627616 },
5727516 "pluralName": {
5827516 "anyOf": [
5912279 {
6012279 "type": "string"
6112279 },
6226328 {
6326328 "type": "null"
6426328 }
6527516 ],
6627516 },
671500 "update_at": {
681500 "anyOf": [
691473 {
701470 "format": "date-time",
711473 "type": "string"
721473 },
733147 {
743147 "type": "null"
753147 }
761500 ],
771500 },
7827220 "useAbbreviation": {
7927220 "type": "boolean"
8027220 }
81125242 },
8233336 "required": [
8333732 "id",
843636 "name"
8533336 ],
86369404 "type": "object"
8791682}
IngredientUnitAlias6 of 6 keywords
17144{
27120 "properties": {
37120 "name": {
47120 "type": "string"
57120 }
67120 },
7914 "required": [
8914 "name"
9914 ],
109520 "type": "object"
117144}
MultiPurposeLabelSummary1 of 11 keywords
14134{
240 "properties": {
320 "color": {
420 "type": "string"
520 },
640 "groupId": {
740 "format": "uuid4",
840 "type": "string"
940 },
1040 "id": {
1140 "format": "uuid4",
1240 "type": "string"
1340 },
1440 "name": {
1540 "type": "string"
1640 }
1740 },
1840 "required": [
1940 "name",
2040 "groupId",
2140 "id"
2240 ],
234134 "type": "object"
244134}
Nutrition47 of 47 keywords
1771921{
27288 "properties": {
31298 "calories": {
41298 "anyOf": [
57130 {
67130 "type": "string"
77130 },
812215 {
912215 "type": "null"
1012215 }
111298 ],
121298 },
131308 "carbohydrateContent": {
141308 "anyOf": [
157131 {
167131 "type": "string"
177131 },
1812315 {
1912315 "type": "null"
2012315 }
211308 ],
221308 },
231278 "cholesterolContent": {
241278 "anyOf": [
256129 {
266129 "type": "string"
276129 },
2812114 {
2912114 "type": "null"
3012114 }
311278 ],
321278 },
331268 "fatContent": {
341268 "anyOf": [
352132 {
362132 "type": "string"
372132 },
3812410 {
3912410 "type": "null"
4012410 }
411268 ],
421268 },
431258 "fiberContent": {
441258 "anyOf": [
459124 {
469124 "type": "string"
479124 },
4811617 {
4911617 "type": "null"
5011617 }
511258 ],
521258 },
531218 "proteinContent": {
541218 "anyOf": [
557122 {
567122 "type": "string"
577122 },
5811415 {
5911415 "type": "null"
6011415 }
611218 ],
621218 },
631198 "saturatedFatContent": {
641198 "anyOf": [
656121 {
666121 "type": "string"
676121 },
6811314 {
6911314 "type": "null"
7011314 }
711198 ],
721198 },
731178 "sodiumContent": {
741178 "anyOf": [
753122 {
763122 "type": "string"
773122 },
7811411 {
7911411 "type": "null"
8011411 }
811178 ],
821178 },
831158 "sugarContent": {
841158 "anyOf": [
853120 {
863120 "type": "string"
873120 },
8811211 {
8911211 "type": "null"
9011211 }
911158 ],
921158 },
931138 "transFatContent": {
941138 "anyOf": [
952119 {
962119 "type": "string"
972119 },
9811110 {
9911110 "type": "null"
10011110 }
1011138 ],
1021138 },
1031118 "unsaturatedFatContent": {
1041118 "anyOf": [
1052117 {
1062117 "type": "string"
1072117 },
10810910 {
10910910 "type": "null"
11010910 }
1111118 ],
1121118 }
1137288 },
1141651833 "type": "object"
115771921}
RecipeAsset11 of 11 keywords
11346{
21728 "properties": {
3308 "fileName": {
4308 "anyOf": [
5236 {
6236 "type": "string"
7236 },
82810 {
92810 "type": "null"
102810 }
11308 ],
12308 },
133310 "icon": {
143310 "type": "string"
153310 },
163310 "name": {
173310 "type": "string"
183310 }
191728 },
20414 "required": [
21432 "name",
22432 "icon"
23414 ],
244514 "type": "object"
251346}
RecipeCategory15 of 17 keywords
11454{
21836 "properties": {
3418 "groupId": {
4418 "anyOf": [
53910 {
6390 "format": "uuid4",
73910 "type": "string"
83910 },
9247 {
10247 "type": "null"
11247 }
12418 ],
13418 },
14418 "id": {
15418 "anyOf": [
163811 {
17380 "format": "uuid4",
183811 "type": "string"
193811 },
20346 {
21346 "type": "null"
22346 }
23418 ],
24418 },
254210 "name": {
264210 "type": "string"
274210 },
284210 "slug": {
294210 "type": "string"
304210 }
311836 },
32504 "required": [
33522 "name",
34522 "slug"
35504 ],
365414 "type": "object"
371454}
RecipeCommentOut-Input14 of 17 keywords
162142{
276114 "properties": {
317612 "createdAt": {
41762 "format": "date-time",
517810 "type": "string"
617612 },
717810 "id": {
81780 "format": "uuid4",
917810 "type": "string"
1017810 },
1117810 "recipeId": {
121780 "format": "uuid4",
1317810 "type": "string"
1417810 },
1517810 "text": {
1617810 "type": "string"
1717810 },
1817612 "update_at": {
191762 "format": "date-time",
2017810 "type": "string"
2117612 },
2213850 "user": {
2413850 },
2517810 "userId": {
261780 "format": "uuid4",
2717810 "type": "string"
2817810 }
2976114 },
3017614 "required": [
311882 "recipeId",
321882 "text",
331882 "id",
341882 "createdAt",
351882 "update_at",
361882 "userId",
371882 "user"
3817614 ],
3919014 "type": "object"
4062142}
RecipeIngredient-Input32 of 32 keywords
1302541{
2285531 "properties": {
376710 "display": {
476710 "type": "string"
576710 },
6557222 "food": {
7557222 "anyOf": [
880699 {
1080699 },
11117662 {
13117662 },
14440339 {
15440339 "type": "null"
16440339 }
17557222 ],
18557222 },
197698 "note": {
207698 "anyOf": [
2175423 {
2275423 "type": "string"
2375423 },
2415762 {
2515762 "type": "null"
2615762 }
277698 ],
287698 },
297638 "originalText": {
307638 "anyOf": [
3120751 {
3220751 "type": "string"
3320751 },
3474328 {
3574328 "type": "null"
3674328 }
377638 ],
387638 },
3976611 "quantity": {
4076611 "anyOf": [
4173641 {
4273641 "type": "number"
4373641 },
4430747 {
4530747 "type": "null"
4630747 }
4776611 ],
4876611 },
4975312 "referenceId": {
507532 "format": "uuid",
5175510 "type": "string"
5275312 },
537538 "title": {
547538 "anyOf": [
5519742 {
5619742 "type": "string"
5719742 },
5873427 {
5973427 "type": "null"
6073427 }
617538 ],
627538 },
63521252 "unit": {
64521252 "anyOf": [
6591682 {
6791682 },
68125648 {
70125648 },
71396377 {
72396377 "type": "null"
73396377 }
74521252 ],
75521252 }
76285531 },
7783310 "type": "object"
78302541}
RecipeNote7 of 7 keywords
15538{
25920 "properties": {
36710 "text": {
46710 "type": "string"
56710 },
66710 "title": {
76710 "type": "string"
86710 }
95920 },
10754 "required": [
11772 "title",
12772 "text"
13754 ],
147914 "type": "object"
155538}
RecipeSettings9 of 9 keywords
1441925{
24160 "properties": {
37610 "disableComments": {
47610 "type": "boolean"
57610 },
67510 "landscapeView": {
77510 "type": "boolean"
87510 },
97710 "locked": {
107710 "type": "boolean"
117710 },
127310 "public": {
137310 "type": "boolean"
147310 },
156810 "showAssets": {
166810 "type": "boolean"
176810 },
186810 "showNutrition": {
196810 "type": "boolean"
206810 }
214160 },
221041865 "type": "object"
23441925}
RecipeStep21 of 21 keywords
14582{
24766 "properties": {
38412 "id": {
48412 "anyOf": [
57719 {
6774 "format": "uuid",
78115 "type": "string"
87719 },
9789 {
10789 "type": "null"
11789 }
128412 ],
138412 },
146728 "ingredientReferences": {
156718 "items": {
176718 },
188510 "type": "array"
196728 },
20878 "summary": {
21878 "anyOf": [
227916 {
237916 "type": "string"
247916 },
25887 {
26887 "type": "null"
27887 }
28878 ],
29878 },
3010110 "text": {
3110110 "type": "string"
3210110 },
33828 "title": {
34828 "anyOf": [
357614 {
367614 "type": "string"
377614 },
38684 {
39684 "type": "null"
40684 }
41828 ],
42828 }
434766 },
441112 "required": [
451112 "text"
461112 ],
4711314 "type": "object"
484582}
RecipeTag15 of 17 keywords
13154{
23536 "properties": {
3488 "groupId": {
4488 "anyOf": [
54115 {
6410 "format": "uuid4",
74115 "type": "string"
84115 },
9749 {
10749 "type": "null"
11749 }
12488 ],
13488 },
14508 "id": {
15508 "anyOf": [
164612 {
17460 "format": "uuid4",
184612 "type": "string"
194612 },
20454 {
21454 "type": "null"
22454 }
23508 ],
24508 },
255910 "name": {
265910 "type": "string"
275910 },
285910 "slug": {
295910 "type": "string"
305910 }
313536 },
32674 "required": [
33692 "name",
34692 "slug"
35674 ],
367114 "type": "object"
373154}
RecipeTool14 of 16 keywords
14274{
24858 "properties": {
3798 "groupId": {
4798 "anyOf": [
56918 {
6690 "format": "uuid4",
76918 "type": "string"
86918 },
91077 {
101077 "type": "null"
111077 }
12798 ],
13798 },
146720 "householdsWithTool": {
156710 "items": {
164810 "type": "string"
176710 },
187710 "type": "array"
196720 },
209410 "id": {
21940 "format": "uuid4",
229410 "type": "string"
239410 },
249410 "name": {
259410 "type": "string"
269410 },
279410 "slug": {
289410 "type": "string"
299410 }
304858 },
311006 "required": [
321042 "id",
331042 "name",
341042 "slug"
351006 ],
3610610 "type": "object"
374274}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
113850{
214236 "properties": {
316610 "admin": {
416610 "type": "boolean"
516610 },
61328 "fullName": {
71328 "anyOf": [
812128 {
912128 "type": "string"
1012128 },
1112020 {
1212020 "type": "null"
1312020 }
141328 ],
151328 },
1616610 "id": {
171660 "format": "uuid4",
1816610 "type": "string"
1916610 },
201418 "username": {
211418 "anyOf": [
2215134 {
2315134 "type": "string"
2415134 },
2512623 {
2612623 "type": "null"
2712623 }
281418 ],
291418 }
3014236 },
311744 "required": [
321762 "id",
331762 "admin"
341744 ],
3517810 "type": "object"
3613850}
Responses
codedescriptionhitsavg
200Successful Response13684ms
422Validation Error16406ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found47311ms
500Internal Server Error5743ms
400Bad Request319ms
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
11194n/a{
21194n/a "type": "string"
31194n/a}
Headers
accept-language3 / 3
11124n/a{
21124n/a "anyOf": [
31092n/a {
41092n/a "type": "string"
51092n/a },
6321092 {
7321092 "type": "null"
8321092 }
91124n/a ],
101124n/a}
Body
application/json369 / 407
Recipe-Input
1400735{
2364730 "properties": {
399326 "assets": {
499326 "anyOf": [
598732 {
698722 "items": {
898722 },
9100910 "type": "array"
1098732 },
1161013 {
1261013 "type": "null"
1361013 }
1499326 ],
1599326 },
1693374 "comments": {
1793374 "anyOf": [
1892978 {
1992970 "items": {
2192970 },
229998 "type": "array"
2392978 },
2441003 {
2541003 "type": "null"
2641003 }
2793374 ],
2893374 },
2910104 "cookTime": {
3010104 "anyOf": [
3171007 {
3271007 "type": "string"
3371007 },
34100311 {
35100311 "type": "null"
36100311 }
3710104 ],
3810104 },
3910056 "createdAt": {
4010056 "anyOf": [
4110038 {
4210032 "format": "date-time",
4310056 "type": "string"
4410038 },
4521009 {
4621009 "type": "null"
4721009 }
4810056 ],
4910056 },
509996 "dateAdded": {
519996 "anyOf": [
529987 {
539982 "format": "date",
5410005 "type": "string"
559987 },
5611004 {
5711004 "type": "null"
5811004 }
599996 ],
609996 },
6110066 "dateUpdated": {
6210066 "anyOf": [
6310048 {
6410042 "format": "date-time",
6510066 "type": "string"
6610048 },
6721010 {
6821010 "type": "null"
6921010 }
7010066 ],
7110066 },
7210014 "description": {
7310014 "anyOf": [
749996 {
759996 "type": "string"
769996 },
7721003 {
7821003 "type": "null"
7921003 }
8010014 ],
8110014 },
8210064 "extras": {
8310064 "anyOf": [
8499713 {
851n/a "additionalProperties": true,
8699713 "type": "object"
8799713 },
8891001 {
8991001 "type": "null"
9091001 }
9110064 ],
9210064 },
939995 "groupId": {
949990 "format": "uuid4",
959995 "type": "string"
969995 },
9710105 "householdId": {
9810100 "format": "uuid4",
9910105 "type": "string"
10010105 },
10110044 "id": {
10210044 "anyOf": [
1039999 {
1049990 "format": "uuid4",
1059999 "type": "string"
1069999 },
10751003 {
10851003 "type": "null"
10951003 }
11010044 ],
11110044 },
112992n/a "image": {
113992n/a "anyOf": [
114992n/a {},
1159866 {
1169866 "type": "null"
1179866 }
118992n/a ],
119992n/a },
1209976 "lastMade": {
1219976 "anyOf": [
12299310 {
1239932 "format": "date-time",
1249958 "type": "string"
12599310 },
1264999 {
1274999 "type": "null"
1284999 }
1299976 ],
1309976 },
1319974 "name": {
1329974 "anyOf": [
1339992 {
1349992 "type": "string"
1359992 },
13698813 {
13798813 "type": "null"
13898813 }
1399974 ],
1409974 },
14198022 "notes": {
14298022 "anyOf": [
14397428 {
14497418 "items": {
14697418 },
14799210 "type": "array"
14897428 },
1496996 {
1506996 "type": "null"
1516996 }
15298022 ],
15398022 },
15494455 "nutrition": {
15594455 "anyOf": [
15634965 {
15834965 },
15991089 {
16091089 "type": "null"
16191089 }
16294455 ]
16394455 },
1649924 "orgURL": {
1659924 "anyOf": [
16610986 {
16710986 "type": "string"
16810986 },
16998214 {
17098214 "type": "null"
17198214 }
1729924 ],
1739924 },
1749894 "performTime": {
1759894 "anyOf": [
1765988 {
1775988 "type": "string"
1785988 },
1799849 {
1809849 "type": "null"
1819849 }
1829894 ],
1839894 },
18410024 "prepTime": {
18510024 "anyOf": [
18641002 {
18741002 "type": "string"
18841002 },
1899988 {
1909988 "type": "null"
1919988 }
19210024 ],
19310024 },
1949864 "rating": {
1959864 "anyOf": [
1962988 {
1972988 "type": "number"
1982988 },
1999846 {
2009846 "type": "null"
2019846 }
2029864 ],
2039864 },
20497437 "recipeCategory": {
20597437 "anyOf": [
20696546 {
20796533 "items": {
20996533 },
21099813 "type": "array"
21196546 },
21291002 {
21391002 "type": "null"
21491002 }
21597437 ],
21697437 },
217723269 "recipeIngredient": {
218723264 "items": {
220723264 },
2219875 "type": "array"
222723269 },
22395144 "recipeInstructions": {
22495144 "anyOf": [
22593956 {
22693940 "items": {
22893940 },
22997916 "type": "array"
23093956 },
23112983 {
23212983 "type": "null"
23312983 }
23495144 ],
23595144 },
2369905 "recipeServings": {
2379905 "type": "number"
2389905 },
2399784 "recipeYield": {
2409784 "anyOf": [
2413979 {
2423979 "type": "string"
2433979 },
2449757 {
2459757 "type": "null"
2469757 }
2479784 ],
2489784 },
2499875 "recipeYieldQuantity": {
2509875 "type": "number"
2519875 },
25295334 "settings": {
25395334 "anyOf": [
25422965 {
25622965 },
25793156 {
25893156 "type": "null"
25993156 }
26095334 ]
26195334 },
2629905 "slug": {
2639905 "type": "string"
2649905 },
26595330 "tags": {
26695330 "anyOf": [
26794835 {
26894826 "items": {
27094826 },
2719749 "type": "array"
27294835 },
2735978 {
2745978 "type": "null"
2755978 }
27695330 ],
27795330 },
27893842 "tools": {
27993837 "items": {
28193837 },
2829755 "type": "array"
28393842 },
2849814 "totalTime": {
2859814 "anyOf": [
2865980 {
2875980 "type": "string"
2885980 },
2899769 {
2909769 "type": "null"
2919769 }
2929814 ],
2939814 },
2949756 "update_at": {
2959756 "anyOf": [
2969729 {
2979722 "format": "date-time",
2989747 "type": "string"
2999729 },
3003978 {
3013978 "type": "null"
3023978 }
3039756 ],
3049756 },
3059905 "userId": {
3069900 "format": "uuid4",
3079905 "type": "string"
3089905 }
309364730 },
31011305 "type": "object"
311400735}
Referenced Components (21)350 of 391 keywords
CreateIngredientFood28 of 30 keywords
154337{
256104 "properties": {
311032 "aliases": {
411022 "items": {
611022 },
713210 "type": "array"
811032 },
913110 "description": {
1013110 "type": "string"
1113110 },
121298 "extras": {
131298 "anyOf": [
1412413 {
151n/a "additionalProperties": true,
1612413 "type": "object"
1712413 },
185132 {
195132 "type": "null"
205132 }
211298 ],
221298 },
2311820 "householdsWithIngredientFood": {
2411810 "items": {
252910 "type": "string"
2611810 },
2712810 "type": "array"
2811820 },
291378 "id": {
301378 "anyOf": [
311369 {
321360 "format": "uuid4",
331369 "type": "string"
341369 },
351144 {
361144 "type": "null"
371144 }
381378 ],
391378 },
401258 "labelId": {
411258 "anyOf": [
4211914 {
431190 "format": "uuid4",
4411914 "type": "string"
4511914 },
466127 {
476127 "type": "null"
486127 }
491258 ],
501258 },
5114810 "name": {
5214810 "type": "string"
5314810 },
541228 "pluralName": {
551228 "anyOf": [
562128 {
572128 "type": "string"
582128 },
5912010 {
6012010 "type": "null"
6112010 }
621228 ],
631228 }
6456104 },
651583 "required": [
661583 "name"
671583 ],
68161230 "type": "object"
6954337}
CreateIngredientFoodAlias6 of 6 keywords
13622{
23610 "properties": {
33610 "name": {
43610 "type": "string"
53610 }
63610 },
7462 "required": [
8462 "name"
9462 ],
104810 "type": "object"
113622}
CreateIngredientUnit29 of 30 keywords
167319{
269114 "properties": {
314610 "abbreviation": {
414610 "type": "string"
514610 },
612732 "aliases": {
712722 "items": {
912722 },
1014910 "type": "array"
1112732 },
1214610 "description": {
1314610 "type": "string"
1414610 },
151458 "extras": {
161458 "anyOf": [
1714112 {
181n/a "additionalProperties": true,
1914112 "type": "object"
2014112 },
214149 {
224149 "type": "null"
234149 }
241458 ],
251458 },
2614010 "fraction": {
2714010 "type": "boolean"
2814010 },
291588 "id": {
301588 "anyOf": [
3115511 {
321550 "format": "uuid4",
3315511 "type": "string"
3415511 },
353163 {
363163 "type": "null"
373163 }
381588 ],
391588 },
4017110 "name": {
4117110 "type": "string"
4217110 },
431408 "pluralAbbreviation": {
441408 "anyOf": [
4513216 {
4613216 "type": "string"
4713216 },
488140 {
498140 "type": "null"
508140 }
511408 ],
521408 },
531358 "pluralName": {
541358 "anyOf": [
554139 {
564139 "type": "string"
574139 },
5813112 {
5913112 "type": "null"
6013112 }
611358 ],
621358 },
6313010 "useAbbreviation": {
6413010 "type": "boolean"
6513010 }
6669114 },
671813 "required": [
681813 "name"
691813 ],
70184202 "type": "object"
7167319}
CreateIngredientUnitAlias6 of 6 keywords
16622{
26610 "properties": {
36610 "name": {
46610 "type": "string"
56610 }
66610 },
7762 "required": [
8762 "name"
9762 ],
107810 "type": "object"
116622}
IngredientFood-Input31 of 41 keywords
138353{
255105 "properties": {
311032 "aliases": {
411022 "items": {
611022 },
713210 "type": "array"
811032 },
9730 "createdAt": {
10730 "anyOf": [
11721 {
12720 "format": "date-time",
13721 "type": "string"
14721 },
15172 {
16172 "type": "null"
17172 }
18730 ],
19730 },
2013110 "description": {
2113110 "type": "string"
2213110 },
231298 "extras": {
241298 "anyOf": [
2512413 {
261n/a "additionalProperties": true,
2712413 "type": "object"
2812413 },
295132 {
305132 "type": "null"
315132 }
321298 ],
331298 },
3411820 "householdsWithIngredientFood": {
3511810 "items": {
362910 "type": "string"
3711810 },
3812810 "type": "array"
3911820 },
401369 "id": {
411360 "format": "uuid4",
421369 "type": "string"
431369 },
44690 "label": {
45690 "anyOf": [
46465 {
48465 },
49654 {
50654 "type": "null"
51654 }
52690 ]
53690 },
541258 "labelId": {
551258 "anyOf": [
5611914 {
571190 "format": "uuid4",
5811914 "type": "string"
5911914 },
606127 {
616127 "type": "null"
626127 }
631258 ],
641258 },
6514810 "name": {
6614810 "type": "string"
6714810 },
681228 "pluralName": {
691228 "anyOf": [
702128 {
712128 "type": "string"
722128 },
7312010 {
7412010 "type": "null"
7512010 }
761228 ],
771228 },
78660 "update_at": {
79660 "anyOf": [
80651 {
81650 "format": "date-time",
82651 "type": "string"
83651 },
84165 {
85165 "type": "null"
86165 }
87660 ],
88660 }
8955105 },
9014318 "required": [
9114516 "id",
921583 "name"
9314318 ],
94161230 "type": "object"
9538353}
IngredientFoodAlias6 of 6 keywords
13622{
23610 "properties": {
33610 "name": {
43610 "type": "string"
53610 }
63610 },
7462 "required": [
8462 "name"
9462 ],
104810 "type": "object"
113622}
IngredientReferences7 of 8 keywords
1639{
2354 "properties": {
3354 "referenceId": {
4354 "anyOf": [
51920 {
6190 "format": "uuid4",
71920 "type": "string"
81920 },
91623 {
101623 "type": "null"
111623 }
12354 ],
13354 }
14354 },
15675 "type": "object"
16639}
IngredientUnit-Input30 of 37 keywords
147339{
266117 "properties": {
314610 "abbreviation": {
414610 "type": "string"
514610 },
612732 "aliases": {
712722 "items": {
912722 },
1014910 "type": "array"
1112732 },
12780 "createdAt": {
13780 "anyOf": [
14762 {
15760 "format": "date-time",
16762 "type": "string"
17762 },
18276 {
19276 "type": "null"
20276 }
21780 ],
22780 },
2314610 "description": {
2414610 "type": "string"
2514610 },
261458 "extras": {
271458 "anyOf": [
2814112 {
291n/a "additionalProperties": true,
3014112 "type": "object"
3114112 },
324149 {
334149 "type": "null"
344149 }
351458 ],
361458 },
3714010 "fraction": {
3814010 "type": "boolean"
3914010 },
4015511 "id": {
411550 "format": "uuid4",
4215511 "type": "string"
4315511 },
4417110 "name": {
4517110 "type": "string"
4617110 },
471408 "pluralAbbreviation": {
481408 "anyOf": [
4913216 {
5013216 "type": "string"
5113216 },
528140 {
538140 "type": "null"
548140 }
551408 ],
561408 },
571358 "pluralName": {
581358 "anyOf": [
594139 {
604139 "type": "string"
614139 },
6213112 {
6313112 "type": "null"
6413112 }
651358 ],
661358 },
67730 "update_at": {
68730 "anyOf": [
69712 {
70710 "format": "date-time",
71712 "type": "string"
72712 },
73271 {
74271 "type": "null"
75271 }
76730 ],
77730 },
7813010 "useAbbreviation": {
7913010 "type": "boolean"
8013010 }
8166117 },
8216420 "required": [
8316618 "id",
841813 "name"
8516420 ],
86184202 "type": "object"
8747339}
IngredientUnitAlias6 of 6 keywords
16622{
26610 "properties": {
36610 "name": {
46610 "type": "string"
56610 }
66610 },
7762 "required": [
8762 "name"
9762 ],
107810 "type": "object"
116622}
MultiPurposeLabelSummary1 of 11 keywords
1465{
240 "properties": {
310 "color": {
410 "type": "string"
510 },
640 "groupId": {
740 "format": "uuid4",
840 "type": "string"
940 },
1040 "id": {
1140 "format": "uuid4",
1240 "type": "string"
1340 },
1440 "name": {
1540 "type": "string"
1640 }
1740 },
1840 "required": [
1940 "name",
2040 "groupId",
2140 "id"
2240 ],
23465 "type": "object"
24465}
Nutrition47 of 47 keywords
134965{
23351 "properties": {
3624 "calories": {
4624 "anyOf": [
5165 {
6165 "type": "string"
7165 },
8615 {
9615 "type": "null"
10615 }
11624 ],
12624 },
13624 "carbohydrateContent": {
14624 "anyOf": [
15165 {
16165 "type": "string"
17165 },
18615 {
19615 "type": "null"
20615 }
21624 ],
22624 },
23614 "cholesterolContent": {
24614 "anyOf": [
25164 {
26164 "type": "string"
27164 },
28605 {
29605 "type": "null"
30605 }
31614 ],
32614 },
33604 "fatContent": {
34604 "anyOf": [
35163 {
36163 "type": "string"
37163 },
38595 {
39595 "type": "null"
40595 }
41604 ],
42604 },
43594 "fiberContent": {
44594 "anyOf": [
45162 {
46162 "type": "string"
47162 },
48585 {
49585 "type": "null"
50585 }
51594 ],
52594 },
53594 "proteinContent": {
54594 "anyOf": [
55162 {
56162 "type": "string"
57162 },
58585 {
59585 "type": "null"
60585 }
61594 ],
62594 },
63574 "saturatedFatContent": {
64574 "anyOf": [
65160 {
66160 "type": "string"
67160 },
68565 {
69565 "type": "null"
70565 }
71574 ],
72574 },
73564 "sodiumContent": {
74564 "anyOf": [
75159 {
76159 "type": "string"
77159 },
78555 {
79555 "type": "null"
80555 }
81564 ],
82564 },
835511 "sugarContent": {
845511 "anyOf": [
85165 {
86165 "type": "string"
87165 },
885412 {
895412 "type": "null"
905412 }
915511 ],
925511 },
93544 "transFatContent": {
94544 "anyOf": [
95157 {
96157 "type": "string"
97157 },
98535 {
99535 "type": "null"
100535 }
101544 ],
102544 },
103534 "unsaturatedFatContent": {
104534 "anyOf": [
105156 {
106156 "type": "string"
107156 },
108525 {
109525 "type": "null"
110525 }
111534 ],
112534 }
1133351 },
11485914 "type": "object"
11534965}
RecipeAsset11 of 11 keywords
13523{
23714 "properties": {
3294 "fileName": {
4294 "anyOf": [
5726 {
6726 "type": "string"
7726 },
82211 {
92211 "type": "null"
102211 }
11294 ],
12294 },
13455 "icon": {
14455 "type": "string"
15455 },
16455 "name": {
17455 "type": "string"
18455 }
193714 },
20492 "required": [
21501 "name",
22501 "icon"
23492 ],
24517 "type": "object"
253523}
RecipeCategory15 of 17 keywords
12750{
25218 "properties": {
3334 "groupId": {
4334 "anyOf": [
52611 {
6260 "format": "uuid4",
72611 "type": "string"
82611 },
9730 {
10730 "type": "null"
11730 }
12334 ],
13334 },
14374 "id": {
15374 "anyOf": [
162714 {
17270 "format": "uuid4",
182714 "type": "string"
192714 },
201031 {
211031 "type": "null"
221031 }
23374 ],
24374 },
25645 "name": {
26645 "type": "string"
27645 },
28415 "slug": {
29415 "type": "string"
30415 }
315218 },
324525 "required": [
33691 "name",
344624 "slug"
354525 ],
36707 "type": "object"
372750}
RecipeCommentOut-Input14 of 17 keywords
11171{
21857 "properties": {
3686 "createdAt": {
4681 "format": "date-time",
5695 "type": "string"
6686 },
7695 "id": {
8690 "format": "uuid4",
9695 "type": "string"
10695 },
11695 "recipeId": {
12690 "format": "uuid4",
13695 "type": "string"
14695 },
15695 "text": {
16695 "type": "string"
17695 },
18686 "update_at": {
19681 "format": "date-time",
20695 "type": "string"
21686 },
224925 "user": {
244925 },
25695 "userId": {
26690 "format": "uuid4",
27695 "type": "string"
28695 }
291857 },
30687 "required": [
31741 "recipeId",
32741 "text",
33741 "id",
34741 "createdAt",
35741 "update_at",
36741 "userId",
37741 "user"
38687 ],
39757 "type": "object"
401171}
RecipeIngredient-Input32 of 32 keywords
1168264{
2161259 "properties": {
33885 "display": {
43885 "type": "string"
53885 },
6280111 "food": {
7280111 "anyOf": [
838353 {
1038353 },
1154337 {
1354337 },
14226165 {
15226165 "type": "null"
16226165 }
17280111 ],
18280111 },
193914 "note": {
203914 "anyOf": [
2138213 {
2238213 "type": "string"
2338213 },
249386 {
259386 "type": "null"
269386 }
273914 ],
283914 },
293814 "originalText": {
303814 "anyOf": [
319376 {
329376 "type": "string"
339376 },
3437213 {
3537213 "type": "null"
3637213 }
373814 ],
383814 },
393844 "quantity": {
403844 "anyOf": [
4136919 {
4236919 "type": "number"
4336919 },
4415373 {
4515373 "type": "null"
4615373 }
473844 ],
483844 },
493856 "referenceId": {
503851 "format": "uuid",
513865 "type": "string"
523856 },
533874 "title": {
543874 "anyOf": [
5516375 {
5616375 "type": "string"
5716375 },
5837120 {
5937120 "type": "null"
6037120 }
613874 ],
623874 },
63265121 "unit": {
64265121 "anyOf": [
6547339 {
6747339 },
6867319 {
7067319 },
71198188 {
72198188 "type": "null"
73198188 }
74265121 ],
75265121 }
76161259 },
774275 "type": "object"
78168264}
RecipeNote7 of 7 keywords
13019{
23210 "properties": {
3365 "text": {
4365 "type": "string"
5365 },
6365 "title": {
7365 "type": "string"
8365 }
93210 },
10402 "required": [
11411 "title",
12411 "text"
13402 ],
14427 "type": "object"
153019}
RecipeSettings9 of 9 keywords
122965{
22130 "properties": {
3415 "disableComments": {
4415 "type": "boolean"
5415 },
6405 "landscapeView": {
7405 "type": "boolean"
8405 },
9395 "locked": {
10395 "type": "boolean"
11395 },
12385 "public": {
13385 "type": "boolean"
14385 },
15375 "showAssets": {
16375 "type": "boolean"
17375 },
18365 "showNutrition": {
19365 "type": "boolean"
20365 }
212130 },
2252935 "type": "object"
2322965}
RecipeStep21 of 21 keywords
12641{
22733 "properties": {
3446 "id": {
4446 "anyOf": [
5437 {
6432 "format": "uuid",
7455 "type": "string"
8437 },
9149 {
10149 "type": "null"
11149 }
12446 ],
13446 },
143614 "ingredientReferences": {
15369 "items": {
17369 },
18455 "type": "array"
193614 },
20454 "summary": {
21454 "anyOf": [
22445 {
23445 "type": "string"
24445 },
25148 {
26148 "type": "null"
27148 }
28454 ],
29454 },
30545 "text": {
31545 "type": "string"
32545 },
33444 "title": {
34444 "anyOf": [
35408 {
36408 "type": "string"
37408 },
38444 {
39444 "type": "null"
40444 }
41444 ],
42444 }
432733 },
44591 "required": [
45591 "text"
46591 ],
47607 "type": "object"
482641}
RecipeTag15 of 17 keywords
12427{
22618 "properties": {
3284 "groupId": {
4284 "anyOf": [
52210 {
6220 "format": "uuid4",
72210 "type": "string"
82210 },
9626 {
10626 "type": "null"
11626 }
12284 ],
13284 },
14304 "id": {
15304 "anyOf": [
16268 {
17260 "format": "uuid4",
18268 "type": "string"
19268 },
20430 {
21430 "type": "null"
22430 }
23304 ],
24304 },
25385 "name": {
26385 "type": "string"
27385 },
28385 "slug": {
29385 "type": "string"
30385 }
312618 },
32422 "required": [
33431 "name",
34431 "slug"
35422 ],
36447 "type": "object"
372427}
RecipeTool14 of 16 keywords
13637{
23929 "properties": {
3444 "groupId": {
4444 "anyOf": [
53711 {
6370 "format": "uuid4",
73711 "type": "string"
83711 },
9741 {
10741 "type": "null"
11741 }
12444 ],
13444 },
143910 "householdsWithTool": {
15395 "items": {
16545 "type": "string"
17395 },
18445 "type": "array"
193910 },
20625 "id": {
21620 "format": "uuid4",
22625 "type": "string"
23625 },
24625 "name": {
25625 "type": "string"
26625 },
27625 "slug": {
28625 "type": "string"
29625 }
303929 },
31653 "required": [
32671 "id",
33671 "name",
34671 "slug"
35653 ],
36685 "type": "object"
373637}
mealie__schema__recipe__recipe_comments__UserBase15 of 16 keywords
14925{
25118 "properties": {
3635 "admin": {
4635 "type": "boolean"
5635 },
6604 "fullName": {
7604 "anyOf": [
8262 {
9262 "type": "string"
10262 },
11586 {
12586 "type": "null"
13586 }
14604 ],
15604 },
16635 "id": {
17630 "format": "uuid4",
18635 "type": "string"
19635 },
20604 "username": {
21604 "anyOf": [
22163 {
23163 "type": "string"
24163 },
25595 {
26595 "type": "null"
27595 }
28604 ],
29604 }
305118 },
31672 "required": [
32681 "id",
33681 "admin"
34672 ],
35695 "type": "object"
364925}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error6663ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4117ms
500Internal Server Error8632ms
400Bad Request315ms
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
1373n/a{
2373n/a "type": "string"
3373n/a}
Headers
accept-language3 / 3
1292n/a{
2292n/a "anyOf": [
3198n/a {
4198n/a "type": "string"
5198n/a },
694198 {
794198 "type": "null"
894198 }
9292n/a ],
10292n/a}
Body
application/json5 / 5
RecipeDuplicate
134620{
215414 "properties": {
315414 "name": {
415414 "anyOf": [
511454 {
611454 "type": "string"
711454 },
840128 {
940128 "type": "null"
1040128 }
1115414 ],
1215414 }
1315414 },
143606 "type": "object"
1534620}
Responses
codedescriptionhitsavg
201Successful Response26456ms
422Validation Error265ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found4220ms
400Bad Request3940ms
500Internal Server Error237ms
Path Parameters
slug1 / 1
#validinvalidschema
1224n/a{
2224n/a "type": "string"
3224n/a}
Headers
accept-language3 / 3
182n/a{
282n/a "anyOf": [
360n/a {
460n/a "type": "string"
560n/a },
62260 {
72260 "type": "null"
82260 }
982n/a ],
1082n/a}
Body
application/json5 / 5
RecipeLastMade
116434{
216419 "properties": {
316419 "timestamp": {
416411 "format": "date-time",
51758 "type": "string"
616419 }
716419 },
81838 "required": [
91838 "timestamp"
101838 ],
111917 "type": "object"
1216434}
Responses
codedescriptionhitsavg
200Successful Response13984ms
422Validation Error565ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2622ms
400Bad Request31ms
Recipe: Exports 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1117n/a{
2117n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
63780 {
73780 "type": "null"
83780 }
9117n/a ],
10117n/a}
Responses
codedescriptionhitsavg
200Successful Response1087ms
422Validation Error0never seen
Path Parameters
slug1 / 1
#validinvalidschema
1222n/a{
2222n/a "type": "string"
3222n/a}
Query Parameters
template_name1 / 1
1221n/a{
2221n/a "type": "string"
3221n/a}
Headers
accept-language3 / 3
1187n/a{
2187n/a "anyOf": [
3102n/a {
4102n/a "type": "string"
5102n/a },
685102 {
785102 "type": "null"
885102 }
9187n/a ],
10187n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error13ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found718ms
500Internal Server Error15033ms
Path Parameters
slug1 / 1
#validinvalidschema
1134n/a{
2134n/a "type": "string"
3134n/a}
Headers
accept-language3 / 3
1114n/a{
2114n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
63480 {
73480 "type": "null"
83480 }
9114n/a ],
10114n/a}
Responses
codedescriptionhitsavg
200Successful Response1348ms
422Validation Error0never seen
Path Parameters
slug1 / 1
#validinvalidschema
1233n/a{
2233n/a "type": "string"
3233n/a}
Query Parameters
token1 / 1
1232n/a{
2232n/a "type": "string"
3232n/a}
Headers
accept-language3 / 3
1119n/a{
2119n/a "anyOf": [
375n/a {
475n/a "type": "string"
575n/a },
64475 {
74475 "type": "null"
84475 }
9119n/a ],
10119n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error13ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request887ms
401Unauthorized1447ms
Recipe: Images and Assets 8 operations 7 covered 1 partial 0 uncovered 0 not measured 97% #
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found31ms
Path Parameters
recipe_id2 / 2
#validinvalidschema
12158{
22158 "format": "uuid4",
3223n/a "type": "string"
42158}
file_name1 / 1
1223n/a{
2223n/a "type": "string"
3223n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error82ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error1803ms
Path Parameters
recipe_id1 / 1
#validinvalidschema
1228n/a{
2228n/a "type": "string"
3228n/a}
timeline_event_id1 / 1
1228n/a{
2228n/a "type": "string"
3228n/a}
file_name2 / 2
ImageType
121810{
221810 "enum": [
390n/a "original.webp",
455n/a "min-original.webp",
573n/a "tiny-original.webp"
621810 ],
7228n/a "type": "string"
821810}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error101ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1841ms
Path Parameters
recipe_id1 / 1
#validinvalidschema
1362n/a{
2362n/a "type": "string"
3362n/a}
file_name2 / 2
ImageType
134022{
234022 "enum": [
346n/a "original.webp",
4104n/a "min-original.webp",
5190n/a "tiny-original.webp"
634022 ],
7362n/a "type": "string"
834022}
Responses
codedescriptionhitsavg
200Successful Response981ms
422Validation Error221ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2081ms
Path Parameters
user_id1 / 2
#validinvalidschema
13400{
23400 "format": "uuid4",
3340n/a "type": "string"
43400}
file_name1 / 1
1340n/a{
2340n/a "type": "string"
3340n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3063ms
Path Parameters
slug1 / 1
#validinvalidschema
1130n/a{
2130n/a "type": "string"
3130n/a}
Headers
accept-language3 / 3
150n/a{
250n/a "anyOf": [
334n/a {
434n/a "type": "string"
534n/a },
61634 {
71634 "type": "null"
81634 }
950n/a ],
1050n/a}
Body
multipart/form-data8 / 8
Body_upload_recipe_asset_api_recipes__slug__assets_post
110018{
2115n/a "properties": {
3114n/a "extension": {
4114n/a "type": "string"
5114n/a },
6114n/a "file": {
7114n/a "format": "binary",
8114n/a "type": "string"
9114n/a },
10114n/a "icon": {
11114n/a "type": "string"
12114n/a },
13103n/a "name": {
14103n/a "type": "string"
15103n/a }
16115n/a },
1710018 "required": [
1810315 "name",
191144 "icon",
201144 "extension",
211144 "file"
2210018 ],
23118n/a "type": "object"
2410018}
Responses
codedescriptionhitsavg
200Successful Response5669ms
422Validation Error208ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request5110ms
500Internal Server Error322ms
Path Parameters
slug1 / 1
#validinvalidschema
1148n/a{
2148n/a "type": "string"
3148n/a}
Headers
accept-language3 / 3
170n/a{
270n/a "anyOf": [
357n/a {
457n/a "type": "string"
557n/a },
61357 {
71357 "type": "null"
81357 }
970n/a ],
1070n/a}
Body
application/json5 / 5
ScrapeRecipe
111818{
212010 "properties": {
3785 "includeTags": {
4785 "type": "boolean"
5785 },
61235 "url": {
71235 "type": "string"
81235 }
912010 },
101283 "required": [
111283 "url"
121283 ],
131315 "type": "object"
1411818}
Responses
codedescriptionhitsavg
200Successful Response7868ms
422Validation Error283ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found237ms
500Internal Server Error1816ms
400Bad Request12ms
Examples
Body: application/json
{ "includeTags": true, "url": "https://myfavoriterecipes.com/recipes" }ScrapeRecipe
falseScrapeRecipe.includeTags
Path Parameters
slug1 / 1
#validinvalidschema
1127n/a{
2127n/a "type": "string"
3127n/a}
Headers
accept-language3 / 3
159n/a{
259n/a "anyOf": [
338n/a {
438n/a "type": "string"
538n/a },
62138 {
72138 "type": "null"
82138 }
959n/a ],
1059n/a}
Body
multipart/form-data6 / 6
Body_update_recipe_image_api_recipes__slug__image_put
11092{
2111n/a "properties": {
3110n/a "extension": {
4110n/a "type": "string"
5110n/a },
6110n/a "image": {
7110n/a "format": "binary",
8110n/a "type": "string"
9110n/a }
10111n/a },
111092 "required": [
121101 "image",
131101 "extension"
141092 ],
15111n/a "type": "object"
161092}
Responses
codedescriptionhitsavg
200Successful Response7350ms
422Validation Error44ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found713ms
400Bad Request11ms
500Internal Server Error4241ms
Recipe: Ingredient Parser 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1110n/a{
2110n/a "anyOf": [
374n/a {
474n/a "type": "string"
574n/a },
63674 {
73674 "type": "null"
83674 }
9110n/a ],
10110n/a}
Body
application/json7 / 7
IngredientRequest
18531{
28717 "properties": {
39111 "ingredient": {
49111 "type": "string"
59111 },
64412 "parser": {
84412 }
98717 },
101028 "required": [
111028 "ingredient"
121028 ],
131106 "type": "object"
148531}
Referenced Components (1)3 of 3 keywords
RegisteredParser3 of 3 keywords
14412{
24412 "enum": [
332n/a "nlp",
410n/a "brute",
52n/a "openai"
64412 ],
7515 "type": "string"
84412}
Responses
codedescriptionhitsavg
200Successful Response826ms
422Validation Error422ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error23ms
400Bad Request41ms
Examples
Body: application/json
"nlp"IngredientRequest.parser
Headers
accept-language3 / 3
#validinvalidschema
197n/a{
297n/a "anyOf": [
370n/a {
470n/a "type": "string"
570n/a },
62770 {
72770 "type": "null"
82770 }
997n/a ],
1097n/a}
Body
application/json8 / 8
IngredientsRequest
18941{
29029 "properties": {
39622 "ingredients": {
49617 "items": {
524841 "type": "string"
69617 },
71135 "type": "array"
89622 },
94313 "parser": {
114313 }
129029 },
131187 "required": [
141187 "ingredients"
151187 ],
161255 "type": "object"
178941}
Referenced Components (1)3 of 3 keywords
RegisteredParser3 of 3 keywords
14313{
24313 "enum": [
329n/a "nlp",
48n/a "brute",
56n/a "openai"
64313 ],
74511 "type": "string"
84313}
Responses
codedescriptionhitsavg
200Successful Response8210ms
422Validation Error483ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error63ms
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
111917{
211917 "format": "uuid4",
3136n/a "type": "string"
411917}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error171ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found852ms
Recipe: Timeline 6 operations 1 covered 5 partial 0 uncovered 0 not measured 94% #
Query Parameters
orderBy3 / 3
#validinvalidschema
1157n/a{
2157n/a "anyOf": [
3147n/a {
4147n/a "type": "string"
5147n/a },
610147 {
710147 "type": "null"
810147 }
9157n/a ],
10157n/a}
orderByNullPosition5 / 5
113436{
213436 "anyOf": [
312743 {
512743 },
67163 {
77163 "type": "null"
87163 }
913436 ],
1013436}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112743{
212743 "enum": [
373n/a "first",
454n/a "last"
512743 ],
6163n/a "type": "string"
712743}
orderDirection2 / 2
OrderDirection
121524{
221524 "enum": [
3137n/a "asc",
478n/a "desc"
521524 ],
6239n/a "type": "string"
721524}
queryFilter3 / 3
1147n/a{
2147n/a "anyOf": [
3135n/a {
4135n/a "type": "string"
5135n/a },
612135 {
712135 "type": "null"
812135 }
9147n/a ],
10147n/a}
paginationSeed3 / 3
1154n/a{
2154n/a "anyOf": [
3142n/a {
4142n/a "type": "string"
5142n/a },
612142 {
712142 "type": "null"
812142 }
9154n/a ],
10154n/a}
page1 / 1
122018{
222018 "type": "integer"
322018}
perPage1 / 1
119127{
219127 "type": "integer"
319127}
Headers
accept-language3 / 3
1385n/a{
2385n/a "anyOf": [
3273n/a {
4273n/a "type": "string"
5273n/a },
6112273 {
7112273 "type": "null"
8112273 }
9385n/a ],
10385n/a}
Responses
codedescriptionhitsavg
200Successful Response28914ms
422Validation Error765ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request758ms
500Internal Server Error4915ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1338n/a{
2338n/a "anyOf": [
3243n/a {
4243n/a "type": "string"
5243n/a },
695243 {
795243 "type": "null"
895243 }
9338n/a ],
10338n/a}
Body
application/json22 / 23
RecipeTimelineEventIn
131274{
232655 "properties": {
31905 "eventMessage": {
41905 "anyOf": [
594101 {
694101 "type": "string"
794101 },
89699 {
99699 "type": "null"
109699 }
111905 ],
121905 },
133658 "eventType": {
153658 },
162016 "image": {
172016 "anyOf": [
1811295 {
2011295 },
2189118 {
2289118 "type": "null"
2389118 }
242016 ],
252016 },
263657 "recipeId": {
273652 "format": "uuid4",
283675 "type": "string"
293657 },
3036311 "subject": {
3136311 "type": "string"
3236311 },
3317712 "timestamp": {
341771 "format": "date-time",
3517811 "type": "string"
3617712 },
372007 "userId": {
382007 "anyOf": [
3913275 {
401320 "format": "uuid4",
4113275 "type": "string"
4213275 },
4368139 {
4468139 "type": "null"
4568139 }
462007 ],
472007 }
4832655 },
4936714 "required": [
503729 "recipeId",
513747 "subject",
523738 "eventType"
5336714 ],
543815 "type": "object"
5531274}
Referenced Components (2)6 of 6 keywords
TimelineEventImage3 of 3 keywords
111295{
211295 "enum": [
339n/a "has image",
473n/a "does not have image"
511295 ],
611394 "type": "string"
711295}
TimelineEventType3 of 3 keywords
13658{
23658 "enum": [
3151n/a "system",
4106n/a "info",
5108n/a "comment"
63658 ],
73685 "type": "string"
83658}
Responses
codedescriptionhitsavg
201Successful Response347ms
422Validation Error1154ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found30810ms
400Bad Request422ms
Examples
Body: application/json
"does not have image"RecipeTimelineEventIn.image
"2026-10-07T02:04:08.437651Z"RecipeTimelineEventIn.timestamp
Path Parameters
item_id1 / 2
#validinvalidschema
1380{
2380 "format": "uuid4",
338n/a "type": "string"
4380}
Headers
accept-language3 / 3
120n/a{
220n/a "anyOf": [
315n/a {
415n/a "type": "string"
515n/a },
6515 {
7515 "type": "null"
8515 }
920n/a ],
1020n/a}
Responses
codedescriptionhitsavg
200Successful Response3058ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found84ms
Path Parameters
item_id1 / 2
#validinvalidschema
12120{
22120 "format": "uuid4",
3212n/a "type": "string"
42120}
Headers
accept-language3 / 3
133n/a{
233n/a "anyOf": [
324n/a {
424n/a "type": "string"
524n/a },
6924 {
7924 "type": "null"
8924 }
933n/a ],
1033n/a}
Responses
codedescriptionhitsavg
200Successful Response1888ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found247ms
Path Parameters
item_id1 / 2
#validinvalidschema
11440{
21440 "format": "uuid4",
3144n/a "type": "string"
41440}
Headers
accept-language3 / 3
182n/a{
282n/a "anyOf": [
362n/a {
462n/a "type": "string"
562n/a },
62062 {
72062 "type": "null"
82062 }
982n/a ],
1082n/a}
Body
application/json12 / 12
RecipeTimelineEventUpdate
111622{
211714 "properties": {
3334 "eventMessage": {
4334 "anyOf": [
5532 {
6532 "type": "string"
7532 },
8289 {
9289 "type": "null"
10289 }
11334 ],
12334 },
13345 "image": {
14345 "anyOf": [
15831 {
17831 },
182613 {
192613 "type": "null"
202613 }
21345 ]
22345 },
231255 "subject": {
241255 "type": "string"
251255 }
2611714 },
271303 "required": [
281303 "subject"
291303 ],
301335 "type": "object"
3111622}
Referenced Components (1)3 of 3 keywords
TimelineEventImage3 of 3 keywords
1831{
2831 "enum": [
37n/a "has image",
41n/a "does not have image"
5831 ],
6930 "type": "string"
7831}
Responses
codedescriptionhitsavg
200Successful Response9533ms
422Validation Error275ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found216ms
400Bad Request11ms
Path Parameters
item_id1 / 2
#validinvalidschema
11140{
21140 "format": "uuid4",
3114n/a "type": "string"
41140}
Headers
accept-language3 / 3
153n/a{
253n/a "anyOf": [
334n/a {
434n/a "type": "string"
534n/a },
61934 {
71934 "type": "null"
81934 }
953n/a ],
1053n/a}
Body
multipart/form-data6 / 6
Body_update_event_image_api_recipes_timeline_events__item_id__image_put
1839{
292n/a "properties": {
391n/a "extension": {
491n/a "type": "string"
591n/a },
684n/a "image": {
784n/a "format": "binary",
884n/a "type": "string"
984n/a }
1092n/a },
11839 "required": [
12848 "image",
13911 "extension"
14839 ],
1592n/a "type": "object"
16839}
Responses
codedescriptionhitsavg
200Successful Response5316ms
422Validation Error127ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found158ms
400Bad Request11ms
500Internal Server Error3313ms
Recipes: Foods 6 operations 2 covered 4 partial 0 uncovered 0 not measured 93% #
Query Parameters
search3 / 3
#validinvalidschema
1158n/a{
2158n/a "anyOf": [
3144n/a {
4144n/a "type": "string"
5144n/a },
614144 {
714144 "type": "null"
814144 }
9158n/a ],
10158n/a}
orderBy3 / 3
1174n/a{
2174n/a "anyOf": [
3161n/a {
4161n/a "type": "string"
5161n/a },
613161 {
713161 "type": "null"
813161 }
9174n/a ],
10174n/a}
orderByNullPosition5 / 5
114136{
214136 "anyOf": [
312948 {
512948 },
612165 {
712165 "type": "null"
812165 }
914136 ],
1014136}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112948{
212948 "enum": [
394n/a "first",
435n/a "last"
512948 ],
6165n/a "type": "string"
712948}
orderDirection2 / 2
OrderDirection
124013{
224013 "enum": [
3144n/a "asc",
496n/a "desc"
524013 ],
6253n/a "type": "string"
724013}
queryFilter3 / 3
1172n/a{
2172n/a "anyOf": [
3157n/a {
4157n/a "type": "string"
5157n/a },
615157 {
715157 "type": "null"
815157 }
9172n/a ],
10172n/a}
paginationSeed3 / 3
1163n/a{
2163n/a "anyOf": [
3153n/a {
4153n/a "type": "string"
5153n/a },
610153 {
710153 "type": "null"
810153 }
9163n/a ],
10163n/a}
page1 / 1
120838{
220838 "type": "integer"
320838}
perPage1 / 1
122525{
222525 "type": "integer"
322525}
Headers
accept-language3 / 3
1376n/a{
2376n/a "anyOf": [
3268n/a {
4268n/a "type": "string"
5268n/a },
6108268 {
7108268 "type": "null"
8108268 }
9376n/a ],
10376n/a}
Responses
codedescriptionhitsavg
200Successful Response31114ms
422Validation Error735ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request7614ms
500Internal Server Error1512ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1199n/a{
2199n/a "anyOf": [
3149n/a {
4149n/a "type": "string"
5149n/a },
650149 {
750149 "type": "null"
850149 }
9199n/a ],
10199n/a}
Body
application/json26 / 28
CreateIngredientFood
117492{
218278 "properties": {
310723 "aliases": {
410718 "items": {
610718 },
71255 "type": "array"
810723 },
91035 "description": {
101035 "type": "string"
111035 },
12918 "extras": {
13918 "anyOf": [
147326 {
151n/a "additionalProperties": true,
167326 "type": "object"
177326 },
181881 {
191881 "type": "null"
201881 }
21918 ],
22918 },
2311510 "householdsWithIngredientFood": {
241155 "items": {
255355 "type": "string"
261155 },
271205 "type": "array"
2811510 },
29974 "id": {
30974 "anyOf": [
318714 {
32870 "format": "uuid4",
338714 "type": "string"
348714 },
351091 {
361091 "type": "null"
371091 }
38974 ],
39974 },
408119 "labelId": {
418119 "anyOf": [
427129 {
43710 "format": "uuid4",
447129 "type": "string"
457129 },
461090 {
471090 "type": "null"
481090 }
498119 ],
508119 },
512475 "name": {
522475 "type": "string"
532475 },
549910 "pluralName": {
559910 "anyOf": [
563079 {
573079 "type": "string"
583079 },
596940 {
606940 "type": "null"
616940 }
629910 ],
639910 }
6418278 },
652529 "required": [
662529 "name"
672529 ],
682615 "type": "object"
6917492}
Referenced Components (1)6 of 6 keywords
CreateIngredientFoodAlias6 of 6 keywords
14718{
2475 "properties": {
3475 "name": {
4475 "type": "string"
5475 }
6475 },
7528 "required": [
8528 "name"
9528 ],
10605 "type": "object"
114718}
Responses
codedescriptionhitsavg
201Successful Response6616ms
422Validation Error994ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request1206ms
500Internal Server Error28ms
Examples
Body: application/json
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
Headers
accept-language3 / 3
#validinvalidschema
158n/a{
258n/a "anyOf": [
346n/a {
446n/a "type": "string"
546n/a },
61246 {
71246 "type": "null"
81246 }
958n/a ],
1058n/a}
Body
application/json5 / 7
MergeFood
12346{
23826 "properties": {
32921 "fromFood": {
4290 "format": "uuid4",
52921 "type": "string"
62921 },
74914 "toFood": {
8490 "format": "uuid4",
94914 "type": "string"
104914 }
113826 },
124915 "required": [
135014 "fromFood",
14631 "toFood"
154915 ],
16645 "type": "object"
172346}
Responses
codedescriptionhitsavg
200Successful Response122ms
422Validation Error787ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error227ms
400Bad Request261ms
Path Parameters
item_id1 / 2
#validinvalidschema
1640{
2640 "format": "uuid4",
364n/a "type": "string"
4640}
Headers
accept-language3 / 3
136n/a{
236n/a "anyOf": [
327n/a {
427n/a "type": "string"
527n/a },
6927 {
7927 "type": "null"
8927 }
936n/a ],
1036n/a}
Responses
codedescriptionhitsavg
200Successful Response4519ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found197ms
Path Parameters
item_id2 / 2
#validinvalidschema
11154{
21154 "format": "uuid4",
3119n/a "type": "string"
41154}
Headers
accept-language3 / 3
192n/a{
292n/a "anyOf": [
363n/a {
463n/a "type": "string"
563n/a },
62963 {
72963 "type": "null"
82963 }
992n/a ],
1092n/a}
Responses
codedescriptionhitsavg
200Successful Response1039ms
422Validation Error47ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found125ms
Path Parameters
item_id2 / 2
#validinvalidschema
12101{
22101 "format": "uuid4",
3211n/a "type": "string"
42101}
Headers
accept-language3 / 3
1125n/a{
2125n/a "anyOf": [
3107n/a {
4107n/a "type": "string"
5107n/a },
618107 {
718107 "type": "null"
818107 }
9125n/a ],
10125n/a}
Body
application/json26 / 28
CreateIngredientFood
113860{
213953 "properties": {
313317 "aliases": {
413312 "items": {
613312 },
71455 "type": "array"
813317 },
91365 "description": {
101365 "type": "string"
111365 },
121464 "extras": {
131464 "anyOf": [
149258 {
151n/a "additionalProperties": true,
169258 "type": "object"
179258 },
185496 {
195496 "type": "null"
205496 }
211464 ],
221464 },
2313710 "householdsWithIngredientFood": {
241375 "items": {
251305 "type": "string"
261375 },
271425 "type": "array"
2813710 },
291424 "id": {
301424 "anyOf": [
311397 {
321390 "format": "uuid4",
331397 "type": "string"
341397 },
353143 {
363143 "type": "null"
373143 }
381424 ],
391424 },
401384 "labelId": {
411384 "anyOf": [
4211329 {
431130 "format": "uuid4",
4411329 "type": "string"
4511329 },
4625117 {
4725117 "type": "null"
4825117 }
491384 ],
501384 },
511865 "name": {
521865 "type": "string"
531865 },
541354 "pluralName": {
551354 "anyOf": [
566970 {
576970 "type": "string"
586970 },
596673 {
606673 "type": "null"
616673 }
621354 ],
631354 }
6413953 },
651912 "required": [
661912 "name"
671912 ],
681935 "type": "object"
6913860}
Referenced Components (1)6 of 6 keywords
CreateIngredientFoodAlias6 of 6 keywords
124112{
22415 "properties": {
32415 "name": {
42415 "type": "string"
52415 }
62415 },
72462 "required": [
82462 "name"
92462 ],
102485 "type": "object"
1124112}
Responses
codedescriptionhitsavg
200Successful Response433ms
422Validation Error653ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found656ms
500Internal Server Error24ms
400Bad Request7513ms
Examples
Body: application/json
[]CreateIngredientFood.aliases
""CreateIngredientFood.description
{}CreateIngredientFood.extras
[]CreateIngredientFood.householdsWithIngredientFood
Recipes: Units 6 operations 2 covered 4 partial 0 uncovered 0 not measured 95% #
Query Parameters
search3 / 3
#validinvalidschema
1130n/a{
2130n/a "anyOf": [
3124n/a {
4124n/a "type": "string"
5124n/a },
66124 {
76124 "type": "null"
86124 }
9130n/a ],
10130n/a}
orderBy3 / 3
1141n/a{
2141n/a "anyOf": [
3128n/a {
4128n/a "type": "string"
5128n/a },
613128 {
713128 "type": "null"
813128 }
9141n/a ],
10141n/a}
orderByNullPosition5 / 5
112826{
212826 "anyOf": [
312133 {
512133 },
67147 {
77147 "type": "null"
87147 }
912826 ],
1012826}
Referenced Components (1)3 of 3 keywords
OrderByNullPosition3 of 3 keywords
112133{
212133 "enum": [
376n/a "first",
445n/a "last"
512133 ],
6147n/a "type": "string"
712133}
orderDirection2 / 2
OrderDirection
117114{
217114 "enum": [
3109n/a "asc",
462n/a "desc"
517114 ],
6185n/a "type": "string"
717114}
queryFilter3 / 3
1125n/a{
2125n/a "anyOf": [
3116n/a {
4116n/a "type": "string"
5116n/a },
69116 {
79116 "type": "null"
89116 }
9125n/a ],
10125n/a}
paginationSeed3 / 3
1140n/a{
2140n/a "anyOf": [
3130n/a {
4130n/a "type": "string"
5130n/a },
610130 {
710130 "type": "null"
810130 }
9140n/a ],
10140n/a}
page1 / 1
115827{
215827 "type": "integer"
315827}
perPage1 / 1
115727{
215727 "type": "integer"
315727}
Headers
accept-language3 / 3
1336n/a{
2336n/a "anyOf": [
3244n/a {
4244n/a "type": "string"
5244n/a },
692244 {
792244 "type": "null"
892244 }
9336n/a ],
10336n/a}
Responses
codedescriptionhitsavg
200Successful Response25615ms
422Validation Error675ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request548ms
500Internal Server Error1710ms
Examples
Query
"desc"orderDirection
1page
50perPage
Headers
accept-language3 / 3
#validinvalidschema
1336n/a{
2336n/a "anyOf": [
3247n/a {
4247n/a "type": "string"
5247n/a },
689247 {
789247 "type": "null"
889247 }
9336n/a ],
10336n/a}
Body
application/json27 / 28
CreateIngredientUnit
135693{
235979 "properties": {
32445 "abbreviation": {
42445 "type": "string"
52445 },
620321 "aliases": {
720316 "items": {
920316 },
102195 "type": "array"
1120321 },
122396 "description": {
132396 "type": "string"
142396 },
1520714 "extras": {
1620714 "anyOf": [
1715269 {
181n/a "additionalProperties": true,
1915269 "type": "object"
2015269 },
2155166 {
2255166 "type": "null"
2355166 }
2420714 ],
2520714 },
262145 "fraction": {
272145 "type": "boolean"
282145 },
2920310 "id": {
3020310 "anyOf": [
3113281 {
321320 "format": "uuid4",
3313281 "type": "string"
3413281 },
3571142 {
3671142 "type": "null"
3771142 }
3820310 ],
3920310 },
404305 "name": {
414305 "type": "string"
424305 },
432095 "pluralAbbreviation": {
442095 "anyOf": [
4518727 {
4618727 "type": "string"
4718727 },
4822192 {
4922192 "type": "null"
5022192 }
512095 ],
522095 },
532239 "pluralName": {
542239 "anyOf": [
55124108 {
56124108 "type": "string"
57124108 },
5899133 {
5999133 "type": "null"
6099133 }
612239 ],
622239 },
632205 "useAbbreviation": {
642205 "type": "boolean"
652205 }
6635979 },
674358 "required": [
684358 "name"
694358 ],
704436 "type": "object"
7135693}
Referenced Components (1)6 of 6 keywords
CreateIngredientUnitAlias6 of 6 keywords
160916{
26095 "properties": {
36095 "name": {
46095 "type": "string"
56095 }
66095 },
76146 "required": [
86146 "name"
96146 ],
106205 "type": "object"
1160916}
Responses
codedescriptionhitsavg
201Successful Response17824ms
422Validation Error963ms
Undocumented - not in spec
codedescriptionhitsavg
400Bad Request2009ms
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
180n/a{
280n/a "anyOf": [
357n/a {
457n/a "type": "string"
557n/a },
62357 {
72357 "type": "null"
82357 }
980n/a ],
1080n/a}
Body
application/json5 / 7
MergeUnit
14026{
24417 "properties": {
3526 "fromUnit": {
4520 "format": "uuid4",
5526 "type": "string"
6526 },
74812 "toUnit": {
8480 "format": "uuid4",
94812 "type": "string"
104812 }
114417 },
12574 "required": [
13583 "fromUnit",
14601 "toUnit"
15574 ],
16615 "type": "object"
174026}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error553ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error408ms
400Bad Request321ms
Path Parameters
item_id1 / 2
#validinvalidschema
1520{
2520 "format": "uuid4",
352n/a "type": "string"
4520}
Headers
accept-language3 / 3
120n/a{
220n/a "anyOf": [
315n/a {
415n/a "type": "string"
515n/a },
6515 {
7515 "type": "null"
8515 }
920n/a ],
1020n/a}
Responses
codedescriptionhitsavg
200Successful Response4118ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found115ms
Path Parameters
item_id2 / 2
#validinvalidschema
12271{
22271 "format": "uuid4",
3228n/a "type": "string"
42271}
Headers
accept-language3 / 3
150n/a{
250n/a "anyOf": [
338n/a {
438n/a "type": "string"
538n/a },
61238 {
71238 "type": "null"
81238 }
950n/a ],
1050n/a}
Responses
codedescriptionhitsavg
200Successful Response20510ms
422Validation Error18ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found228ms
Path Parameters
item_id1 / 2
#validinvalidschema
12120{
22120 "format": "uuid4",
3212n/a "type": "string"
42120}
Headers
accept-language3 / 3
1144n/a{
2144n/a "anyOf": [
3121n/a {
4121n/a "type": "string"
5121n/a },
623121 {
723121 "type": "null"
823121 }
9144n/a ],
10144n/a}
Body
application/json28 / 28
CreateIngredientUnit
112771{
212860 "properties": {
31015 "abbreviation": {
41015 "type": "string"
51015 },
68016 "aliases": {
78011 "items": {
98011 },
10915 "type": "array"
118016 },
12895 "description": {
13895 "type": "string"
14895 },
15884 "extras": {
16884 "anyOf": [
178012 {
181n/a "additionalProperties": true,
198012 "type": "object"
208012 },
21884 {
22884 "type": "null"
23884 }
24884 ],
25884 },
26816 "fraction": {
27816 "type": "boolean"
28816 },
29987 "id": {
30987 "anyOf": [
319114 {
32913 "format": "uuid4",
339411 "type": "string"
349114 },
35798 {
36798 "type": "null"
37798 }
38987 ],
39987 },
401825 "name": {
411825 "type": "string"
421825 },
43834 "pluralAbbreviation": {
44834 "anyOf": [
45816 {
46816 "type": "string"
47816 },
48285 {
49285 "type": "null"
50285 }
51834 ],
52834 },
53906 "pluralName": {
54906 "anyOf": [
551185 {
561185 "type": "string"
571185 },
587917 {
597917 "type": "null"
607917 }
61906 ],
62906 },
63865 "useAbbreviation": {
64865 "type": "boolean"
65865 }
6612860 },
671873 "required": [
681873 "name"
691873 ],
701908 "type": "object"
7112771}
Referenced Components (1)6 of 6 keywords
CreateIngredientUnitAlias6 of 6 keywords
13011{
2305 "properties": {
3305 "name": {
4305 "type": "string"
5305 }
6305 },
7351 "required": [
8351 "name"
9351 ],
10365 "type": "object"
113011}
Responses
codedescriptionhitsavg
200Successful Response8812ms
422Validation Error763ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error24ms
400Bad Request3611ms
404Not Found107ms
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
151040{
251040 "anyOf": [
350941 {
450940 "format": "uuid4",
5549n/a "type": "string"
650941 },
71549 {
81549 "type": "null"
91549 }
1051040 ],
1151040}
Headers
accept-language3 / 3
1394n/a{
2394n/a "anyOf": [
3265n/a {
4265n/a "type": "string"
5265n/a },
6129265 {
7129265 "type": "null"
8129265 }
9394n/a ],
10394n/a}
Responses
codedescriptionhitsavg
200Successful Response5629ms
422Validation Error407ms
Headers
accept-language3 / 3
#validinvalidschema
1286n/a{
2286n/a "anyOf": [
3198n/a {
4198n/a "type": "string"
5198n/a },
688198 {
788198 "type": "null"
888198 }
9286n/a ],
10286n/a}
Body
application/json7 / 7
RecipeShareTokenCreate
137931{
238619 "properties": {
319910 "expiresAt": {
41994 "format": "date-time",
52036 "type": "string"
619910 },
738810 "recipeId": {
83884 "format": "uuid4",
93926 "type": "string"
1038810 }
1138619 },
123987 "required": [
133987 "recipeId"
143987 ],
154055 "type": "object"
1637931}
Responses
codedescriptionhitsavg
201Successful Response28029ms
422Validation Error394ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found1009ms
400Bad Request51ms
Path Parameters
item_id2 / 2
#validinvalidschema
129719{
229719 "format": "uuid4",
3316n/a "type": "string"
429719}
Headers
accept-language3 / 3
1222n/a{
2222n/a "anyOf": [
3133n/a {
4133n/a "type": "string"
5133n/a },
689133 {
789133 "type": "null"
889133 }
9222n/a ],
10222n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error198ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found2979ms
Path Parameters
item_id2 / 2
#validinvalidschema
134211{
234211 "format": "uuid4",
3353n/a "type": "string"
434211}
Headers
accept-language3 / 3
1129n/a{
2129n/a "anyOf": [
386n/a {
486n/a "type": "string"
586n/a },
64386 {
74386 "type": "null"
84386 }
9129n/a ],
10129n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error118ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3429ms
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 Error42ms
Responses
codedescriptionhitsavg
200Successful Response0never seen
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error42ms
Responses
codedescriptionhitsavg
200Successful Response34ms
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
1325n/a{
2325n/a "anyOf": [
3214n/a {
4214n/a "type": "string"
5214n/a },
6111214 {
7111214 "type": "null"
8111214 }
9325n/a ],
10325n/a}
Responses
codedescriptionhitsavg
200Successful Response4307ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1319n/a{
2319n/a "anyOf": [
3214n/a {
4214n/a "type": "string"
5214n/a },
6105214 {
7105214 "type": "null"
8105214 }
9319n/a ],
10319n/a}
Responses
codedescriptionhitsavg
200Successful Response3968ms
422Validation Error0never seen
Headers
accept-language3 / 3
#validinvalidschema
1367n/a{
2367n/a "anyOf": [
3244n/a {
4244n/a "type": "string"
5244n/a },
6123244 {
7123244 "type": "null"
8123244 }
9367n/a ],
10367n/a}
Responses
codedescriptionhitsavg
200Successful Response4268ms
422Validation Error0never seen
Path Parameters
recipe_id2 / 2
#validinvalidschema
13152{
23152 "format": "uuid4",
3317n/a "type": "string"
43152}
Headers
accept-language3 / 3
1115n/a{
2115n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
63580 {
73580 "type": "null"
83580 }
9115n/a ],
10115n/a}
Responses
codedescriptionhitsavg
200Successful Response58ms
422Validation Error29ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found3108ms
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 0 covered 1 partial 0 uncovered 0 not measured 90% #
Path Parameters
id1 / 2
#validinvalidschema
12000{
22000 "format": "uuid4",
3200n/a "type": "string"
42000}
Headers
accept-language3 / 3
172n/a{
272n/a "anyOf": [
353n/a {
453n/a "type": "string"
553n/a },
61953 {
71953 "type": "null"
81953 }
972n/a ],
1072n/a}
Body
multipart/form-data5 / 5
Body_update_user_image_api_users__id__image_post
110812{
2108n/a "properties": {
3108n/a "profile": {
4108n/a "format": "binary",
5108n/a "type": "string"
6108n/a }
7108n/a },
810812 "required": [
910812 "profile"
1010812 ],
11120n/a "type": "object"
1210812}
Responses
codedescriptionhitsavg
200Successful Response2655ms
422Validation Error248ms
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden1028ms
400Bad Request31ms
500Internal Server Error4512ms
Users: Passwords 2 operations 1 covered 0 partial 1 uncovered 0 not measured 50% #
Headers
accept-language3 / 3
#validinvalidschema
1150n/a{
2150n/a "anyOf": [
3107n/a {
4107n/a "type": "string"
5107n/a },
643107 {
743107 "type": "null"
843107 }
9150n/a ],
10150n/a}
Body
application/json4 / 4
ForgotPassword
18445{
28414 "properties": {
38414 "email": {
48414 "type": "string"
58414 }
68414 },
7988 "required": [
8988 "email"
9988 ],
1010623 "type": "object"
118445}
Responses
codedescriptionhitsavg
200Successful Response8412ms
422Validation Error581ms
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 0 covered 5 partial 0 uncovered 0 not measured 86% #
Path Parameters
id1 / 2
#validinvalidschema
13310{
23310 "format": "uuid4",
3331n/a "type": "string"
43310}
Headers
accept-language3 / 3
1143n/a{
2143n/a "anyOf": [
396n/a {
496n/a "type": "string"
596n/a },
64796 {
74796 "type": "null"
84796 }
9143n/a ],
10143n/a}
Responses
codedescriptionhitsavg
200Successful Response3317ms
422Validation Error0never seen
Path Parameters
id1 / 2
#validinvalidschema
13260{
23260 "format": "uuid4",
3326n/a "type": "string"
43260}
slug1 / 1
1326n/a{
2326n/a "type": "string"
3326n/a}
Headers
accept-language3 / 3
1125n/a{
2125n/a "anyOf": [
380n/a {
480n/a "type": "string"
580n/a },
64580 {
74580 "type": "null"
84580 }
9125n/a ],
10125n/a}
Responses
codedescriptionhitsavg
200Successful Response2925ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found358ms
403Forbidden2627ms
Path Parameters
id1 / 2
#validinvalidschema
14530{
24530 "format": "uuid4",
3453n/a "type": "string"
44530}
slug1 / 1
1453n/a{
2453n/a "type": "string"
3453n/a}
Headers
accept-language3 / 3
1270n/a{
2270n/a "anyOf": [
3182n/a {
4182n/a "type": "string"
5182n/a },
688182 {
788182 "type": "null"
888182 }
9270n/a ],
10270n/a}
Responses
codedescriptionhitsavg
200Successful Response4021ms
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
404Not Found368ms
403Forbidden3779ms
Path Parameters
id1 / 2
#validinvalidschema
12930{
22930 "format": "uuid4",
3293n/a "type": "string"
42930}
Headers
accept-language3 / 3
1104n/a{
2104n/a "anyOf": [
374n/a {
474n/a "type": "string"
574n/a },
63074 {
73074 "type": "null"
83074 }
9104n/a ],
10104n/a}
Responses
codedescriptionhitsavg
200Successful Response2937ms
422Validation Error0never seen
Path Parameters
id1 / 2
#validinvalidschema
12180{
22180 "format": "uuid4",
3218n/a "type": "string"
42180}
slug1 / 1
1218n/a{
2218n/a "type": "string"
3218n/a}
Headers
accept-language3 / 3
1111n/a{
2111n/a "anyOf": [
375n/a {
475n/a "type": "string"
575n/a },
63675 {
73675 "type": "null"
83675 }
9111n/a ],
10111n/a}
Body
application/json8 / 8
UserRatingUpdate
119315{
2869 "properties": {
3775 "isFavorite": {
4775 "anyOf": [
53151 {
63151 "type": "boolean"
73151 },
84636 {
94636 "type": "null"
104636 }
11775 ],
12775 },
13715 "rating": {
14715 "anyOf": [
152749 {
162749 "type": "number"
172749 },
184432 {
194432 "type": "null"
204432 }
21715 ],
22715 }
23869 },
242026 "type": "object"
2519315}
Responses
codedescriptionhitsavg
200Successful Response4122ms
422Validation Error203ms
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden1246ms
400Bad Request31ms
404Not Found309ms
Users: Registration 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Headers
accept-language3 / 3
#validinvalidschema
1385n/a{
2385n/a "anyOf": [
3325n/a {
4325n/a "type": "string"
5325n/a },
660325 {
760325 "type": "null"
860325 }
9385n/a ],
10385n/a}
Body
application/json21 / 21
CreateUserRegistration
1312160{
2330132 "properties": {
328514 "advanced": {
428514 "type": "boolean"
528514 },
644111 "email": {
744111 "type": "string"
844111 },
945010 "fullName": {
1045010 "type": "string"
1145010 },
122778 "group": {
132778 "anyOf": [
14112173 {
15112173 "type": "string"
16112173 },
17165120 {
18165120 "type": "null"
19165120 }
202778 ],
212778 },
222789 "groupToken": {
232789 "anyOf": [
2471216 {
2571216 "type": "string"
2671216 },
2720780 {
2820780 "type": "null"
2920780 }
302789 ],
312789 },
322708 "household": {
332708 "anyOf": [
3499179 {
3599179 "type": "string"
3699179 },
37171107 {
38171107 "type": "null"
39171107 }
402708 ],
412708 },
4228211 "locale": {
4328211 "type": "string"
4428211 },
4545010 "password": {
4645010 "type": "string"
4745010 },
4845010 "passwordConfirm": {
4945010 "type": "string"
5045010 },
5127714 "private": {
5227714 "type": "boolean"
5327714 },
5425121 "seedData": {
5525121 "type": "boolean"
5625121 },
5745010 "username": {
5845010 "type": "string"
5945010 }
60330132 },
6144418 "required": [
6245210 "email",
634602 "username",
644602 "fullName",
654602 "password",
664602 "passwordConfirm"
6744418 ],
6846210 "type": "object"
69312160}
Responses
codedescriptionhitsavg
201Successful Response0never seen
422Validation Error4942ms
Undocumented - not in spec
codedescriptionhitsavg
500Internal Server Error82ms
400Bad Request411ms
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
194n/a{
294n/a "anyOf": [
361n/a {
461n/a "type": "string"
561n/a },
63361 {
73361 "type": "null"
83361 }
994n/a ],
1094n/a}
Body
application/json5 / 5
LongLiveTokenIn
110417{
210510 "properties": {
31025 "integrationId": {
41025 "type": "string"
51025 },
61095 "name": {
71095 "type": "string"
81095 }
910510 },
101142 "required": [
111142 "name"
121142 ],
131165 "type": "object"
1410417}
Responses
codedescriptionhitsavg
201Successful Response10417ms
422Validation Error232ms
Examples
Body: application/json
"generic"LongLiveTokenIn.integrationId
Path Parameters
token_id1 / 1
#validinvalidschema
1225{
2225 "type": "integer"
3225}
Headers
accept-language3 / 3
120n/a{
220n/a "anyOf": [
317n/a {
417n/a "type": "string"
517n/a },
6317 {
7317 "type": "null"
8317 }
920n/a ],
1020n/a}
Responses
codedescriptionhitsavg
200Successful Response722ms
422Validation Error53ms
Undocumented - not in spec
codedescriptionhitsavg
404Not Found156ms
Utils 1 operation 1 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
token3 / 3
#validinvalidschema
1126n/a{
2126n/a "anyOf": [
3124n/a {
4124n/a "type": "string"
5124n/a },
62124 {
72124 "type": "null"
82124 }
9126n/a ],
10126n/a}
Responses
codedescriptionhitsavg
200Successful Response0never seen
422Validation Error0never seen
Undocumented - not in spec
codedescriptionhitsavg
401Unauthorized1001ms
400Bad Request371ms
500Internal Server Error192ms
728 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
PUT0.0.0.0:32895/api/users/forgot-passwordmethod not documented2
PUT0.0.0.0:32895/api/users/registermethod not documented2
DELETE0.0.0.0:32895/api/admin/aboutmethod not documented1
DELETE0.0.0.0:32895/api/admin/about/checkmethod not documented1
DELETE0.0.0.0:32895/api/admin/about/statisticsmethod not documented1
DELETE0.0.0.0:32895/api/admin/backupsmethod not documented1
DELETE0.0.0.0:32895/api/admin/backups/uploadmethod not documented1
DELETE0.0.0.0:32895/api/admin/debug/openaimethod not documented1
DELETE0.0.0.0:32895/api/admin/emailmethod not documented1
DELETE0.0.0.0:32895/api/admin/groupsmethod not documented1

... and 716 more groups