{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:bigoven/collection-get-collection":{"get":{"operationId":"open_data_bigoven_collection_get_collection","summary":"Gets a recipe collection. A recipe collection is a curated set of recipes.","description":"GET /collection/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"the collection identifier","schema":{"type":"integer","description":"the collection identifier"}},{"name":"rpp","in":"query","required":false,"description":"results per page","schema":{"type":"integer","description":"results per page"}},{"name":"pg","in":"query","required":false,"description":"page number (starting with 1)","schema":{"type":"integer","description":"page number (starting with 1)"}},{"name":"test","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"sessionForLogging","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/collection-get-collection-meta":{"get":{"operationId":"open_data_bigoven_collection_get_collection_meta","summary":"Gets a recipe collection metadata. A recipe collection is a curated set of recipes.","description":"GET /collection/{id}/meta","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"the collection identifier","schema":{"type":"integer","description":"the collection identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/collection-collections":{"get":{"operationId":"open_data_bigoven_collection_collections","summary":"Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint…","description":"GET /collections","tags":["open-data"],"parameters":[{"name":"test","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-get":{"get":{"operationId":"open_data_bigoven_grocery_list_get","summary":"Get the user's grocery list. User is determined by Basic Authentication.","description":"GET /grocerylist","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-delete":{"post":{"operationId":"open_data_bigoven_grocery_list_delete","summary":"Delete all the items on a grocery list; faster operation than a sync with deleted items.","description":"DELETE /grocerylist","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-grocery-list-remove-marked-items":{"post":{"operationId":"open_data_bigoven_grocery_list_grocery_list_remove_marked_items","summary":"Clears the checked lines.","description":"POST /grocerylist/clearcheckedlines","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-department":{"post":{"operationId":"open_data_bigoven_grocery_list_department","summary":"Departmentalize a list of strings -- used for ad-hoc grocery list item addition","description":"POST /grocerylist/department","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/post-grocerylist-item":{"post":{"operationId":"open_data_bigoven_post_grocerylist_item","summary":"Add a single line item to the grocery list","description":"POST /grocerylist/item","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-grocery-list-item-guid":{"post":{"operationId":"open_data_bigoven_grocery_list_grocery_list_item_guid","summary":"Update a grocery item by GUID","description":"PUT /grocerylist/item/{guid}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["guid","body"],"properties":{"guid":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-delete-item-by-guid":{"post":{"operationId":"open_data_bigoven_grocery_list_delete_item_by_guid","summary":"/grocerylist/item/{guid} DELETE will delete this item assuming you own it.","description":"DELETE /grocerylist/item/{guid}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["guid"],"properties":{"guid":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-post":{"post":{"operationId":"open_data_bigoven_grocery_list_post","summary":"Add a single line item to the grocery list","description":"POST /grocerylist/line","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-add-recipe":{"post":{"operationId":"open_data_bigoven_grocery_list_add_recipe","summary":"Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the…","description":"POST /grocerylist/recipe","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/grocery-list-post-grocery-list-sync":{"post":{"operationId":"open_data_bigoven_grocery_list_post_grocery_list_sync","summary":"Synchronize the grocery list. Call this with a POST to /grocerylist/sync","description":"POST /grocerylist/sync","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/images-upload-user-avatar":{"post":{"operationId":"open_data_bigoven_images_upload_user_avatar","summary":"POST: /image/avatar Testing with Postman (validated 11/20/2015): 1) Remove the Content-Type header; add…","description":"POST /image/avatar","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/me-index":{"get":{"operationId":"open_data_bigoven_me_index","summary":"Indexes this instance.","description":"GET /me","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/me-put-me":{"post":{"operationId":"open_data_bigoven_me_put_me","summary":"Puts me.","description":"PUT /me","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/me-put-me-personal":{"post":{"operationId":"open_data_bigoven_me_put_me_personal","summary":"Puts me personal.","description":"PUT /me/personal","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/me-put-me-preferences":{"post":{"operationId":"open_data_bigoven_me_put_me_preferences","summary":"Puts me preferences.","description":"PUT /me/preferences","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/me-get-options":{"get":{"operationId":"open_data_bigoven_me_get_options","summary":"Gets the options.","description":"GET /me/preferences/options","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/put-me-profile":{"post":{"operationId":"open_data_bigoven_put_me_profile","summary":"Puts me.","description":"PUT /me/profile","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/me-skinny":{"get":{"operationId":"open_data_bigoven_me_skinny","summary":"Skinnies this instance.","description":"GET /me/skinny","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-post":{"post":{"operationId":"open_data_bigoven_recipe_post","summary":"Add a new recipe","description":"POST /recipe","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-put":{"post":{"operationId":"open_data_bigoven_recipe_put","summary":"Update a recipe","description":"PUT /recipe","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-auto-complete":{"get":{"operationId":"open_data_bigoven_recipe_auto_complete","summary":"Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.","description":"GET /recipe/autocomplete","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-auto-complete-all-recipes":{"get":{"operationId":"open_data_bigoven_recipe_auto_complete_all_recipes","summary":"Automatics the complete all recipes.","description":"GET /recipe/autocomplete/all","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":true,"description":"The query.","schema":{"type":"string","description":"The query."}},{"name":"limit","in":"query","required":true,"description":"The limit.","schema":{"type":"integer","description":"The limit."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-auto-complete-my-recipes":{"get":{"operationId":"open_data_bigoven_recipe_auto_complete_my_recipes","summary":"Automatics the complete my recipes.","description":"GET /recipe/autocomplete/mine","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":true,"description":"The query.","schema":{"type":"string","description":"The query."}},{"name":"limit","in":"query","required":true,"description":"The limit.","schema":{"type":"integer","description":"The limit."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-categories":{"get":{"operationId":"open_data_bigoven_recipe_categories","summary":"Get a list of recipe categories (the ID field can be used for include_cat in search parameters)","description":"GET /recipe/categories","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-active-recipe":{"get":{"operationId":"open_data_bigoven_recipe_get_active_recipe","summary":"Returns last active recipe for the user","description":"GET /recipe/get/active/recipe","tags":["open-data"],"parameters":[{"name":"userName","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-step":{"post":{"operationId":"open_data_bigoven_recipe_get_step","summary":"Gets recipe single step as text","description":"POST /recipe/get/saved/step","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userName","recipeId","stepId"],"properties":{"userName":{"type":"string"},"recipeId":{"type":"integer"},"stepId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-step-number":{"post":{"operationId":"open_data_bigoven_recipe_get_step_number","summary":"Returns stored step number and number of steps in recipe","description":"POST /recipe/get/step/number","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userName","recipeId"],"properties":{"userName":{"type":"string"},"recipeId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/images-get-pending-by-user":{"get":{"operationId":"open_data_bigoven_images_get_pending_by_user","summary":"Gets the pending by user.","description":"GET /recipe/photos/pending","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-steps":{"post":{"operationId":"open_data_bigoven_recipe_get_steps","summary":"Stores recipe step number and returns saved step data","description":"POST /recipe/post/step","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["userName","recipeId","stepId"],"properties":{"userName":{"type":"string"},"recipeId":{"type":"integer"},"stepId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-put-reply":{"post":{"operationId":"open_data_bigoven_review_put_reply","summary":"Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply.","description":"PUT /recipe/review/replies/{replyId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["replyId","body"],"properties":{"replyId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-delete-reply":{"post":{"operationId":"open_data_bigoven_review_delete_reply","summary":"DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply.","description":"DELETE /recipe/review/replies/{replyId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["replyId"],"properties":{"replyId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/get-recipe-review-review-id":{"get":{"operationId":"open_data_bigoven_get_recipe_review_review_id","summary":"Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount.…","description":"GET /recipe/review/{reviewId}","tags":["open-data"],"parameters":[{"name":"reviewId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-put":{"post":{"operationId":"open_data_bigoven_review_put","summary":"Update a given top-level review.","description":"PUT /recipe/review/{reviewId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reviewId","body"],"properties":{"reviewId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-get-replies":{"get":{"operationId":"open_data_bigoven_review_get_replies","summary":"Get a paged list of replies for a given review.","description":"GET /recipe/review/{reviewId}/replies","tags":["open-data"],"parameters":[{"name":"reviewId","in":"query","required":true,"schema":{"type":"string"}},{"name":"pg","in":"query","required":false,"description":"the page (int), starting with 1","schema":{"type":"integer","description":"the page (int), starting with 1"}},{"name":"rpp","in":"query","required":false,"description":"results per page (int)","schema":{"type":"integer","description":"results per page (int)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-post-reply":{"post":{"operationId":"open_data_bigoven_review_post_reply","summary":"POST a reply to a given review. The date will be set by server. Note that replies no longer have star…","description":"POST /recipe/review/{reviewId}/replies","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reviewId","body"],"properties":{"reviewId":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-scan":{"post":{"operationId":"open_data_bigoven_recipe_scan","summary":"POST an image as a new RecipeScan request 1) Fetch the filename -- DONE 2) Copy it to the pics/scan folder -…","description":"POST /recipe/scan","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"test":{"type":"boolean"},"devicetype":{"type":"string"},"lat":{"type":"number"},"lng":{"type":"number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-recipe-with-steps":{"get":{"operationId":"open_data_bigoven_recipe_get_recipe_with_steps","summary":"Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.","description":"GET /recipe/steps/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"the Recipe ID to retrieve","schema":{"type":"integer","description":"the Recipe ID to retrieve"}},{"name":"prefetch","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get":{"get":{"operationId":"open_data_bigoven_recipe_get","summary":"Return full Recipe detail. Returns 403 if the recipe is owned by someone else.","description":"GET /recipe/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Recipe ID to retrieve","schema":{"type":"integer","description":"The Recipe ID to retrieve"}},{"name":"prefetch","in":"query","required":false,"description":"The prefetch.","schema":{"type":"boolean","description":"The prefetch."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-delete":{"post":{"operationId":"open_data_bigoven_recipe_delete","summary":"Delete a Recipe (you must be authenticated as an owner of the recipe)","description":"DELETE /recipe/{id}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-zap-recipe":{"get":{"operationId":"open_data_bigoven_recipe_zap_recipe","summary":"Zaps the recipe.","description":"GET /recipe/{id}/zap","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The identifier.","schema":{"type":"integer","description":"The identifier."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-feedback":{"post":{"operationId":"open_data_bigoven_recipe_feedback","summary":"Feedback on a Recipe -- for internal BigOven editors","description":"POST /recipe/{recipeId}/feedback","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId","body"],"properties":{"recipeId":{"type":"integer"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/images-upload-recipe-image":{"post":{"operationId":"open_data_bigoven_images_upload_recipe_image","summary":"POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption Note that caption, lng…","description":"POST /recipe/{recipeId}/image","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId"],"properties":{"recipeId":{"type":"string"},"caption":{"type":"string"},"lat":{"type":"number"},"lng":{"type":"number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/images-get":{"get":{"operationId":"open_data_bigoven_images_get","summary":"Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos.","description":"GET /recipe/{recipeId}/images","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"Recipe ID (required)","schema":{"type":"integer","description":"Recipe ID (required)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/note-post":{"post":{"operationId":"open_data_bigoven_note_post","summary":"HTTP POST a new note into the system.","description":"POST /recipe/{recipeId}/note","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId","body"],"properties":{"recipeId":{"type":"integer","description":"recipeId (int)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/note-get":{"get":{"operationId":"open_data_bigoven_note_get","summary":"Get a given note. Make sure you're passing authentication information in the header for the user who owns…","description":"GET /recipe/{recipeId}/note/{noteId}","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"recipe identifier (integer)","schema":{"type":"integer","description":"recipe identifier (integer)"}},{"name":"noteId","in":"query","required":true,"description":"The note ID (note -- it's not the RecipeID)","schema":{"type":"integer","description":"The note ID (note -- it's not the RecipeID)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/note-put":{"post":{"operationId":"open_data_bigoven_note_put","summary":"HTTP PUT (update) a Recipe note (RecipeNote).","description":"PUT /recipe/{recipeId}/note/{noteId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId","noteId","body"],"properties":{"recipeId":{"type":"integer"},"noteId":{"type":"integer"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/note-delete":{"post":{"operationId":"open_data_bigoven_note_delete","summary":"Delete a review do a DELETE Http request of /note/{ID}","description":"DELETE /recipe/{recipeId}/note/{noteId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId","noteId"],"properties":{"recipeId":{"type":"integer","description":"recipeId (int)"},"noteId":{"type":"integer","description":"noteId (int)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/note-get-notes":{"get":{"operationId":"open_data_bigoven_note_get_notes","summary":"recipe/100/notes","description":"GET /recipe/{recipeId}/notes","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"recipeId (int)","schema":{"type":"integer","description":"recipeId (int)"}},{"name":"pg","in":"query","required":false,"description":"page (int, starting from 1)","schema":{"type":"integer","description":"page (int, starting from 1)"}},{"name":"rpp","in":"query","required":false,"description":"recipeId","schema":{"type":"integer","description":"recipeId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/images-get-recipe-photos":{"get":{"operationId":"open_data_bigoven_images_get_recipe_photos","summary":"Get all the photos for a recipe","description":"GET /recipe/{recipeId}/photos","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"Recipe ID (required)","schema":{"type":"integer","description":"Recipe ID (required)"}},{"name":"pg","in":"query","required":false,"schema":{"type":"integer"}},{"name":"rpp","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-related":{"get":{"operationId":"open_data_bigoven_recipe_related","summary":"Get recipes related to the given recipeId","description":"GET /recipe/{recipeId}/related","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"The recipe id","schema":{"type":"integer","description":"The recipe id"}},{"name":"pg","in":"query","required":false,"description":"The page","schema":{"type":"integer","description":"The page"}},{"name":"rpp","in":"query","required":false,"description":"The results per page","schema":{"type":"integer","description":"The results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/get-recipe-recipe-id-review":{"get":{"operationId":"open_data_bigoven_get_recipe_recipe_id_review","summary":"Get *my* review for the recipe {recipeId}, where \"me\" is determined by standard authentication headers","description":"GET /recipe/{recipeId}/review","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-post":{"post":{"operationId":"open_data_bigoven_review_post","summary":"Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be…","description":"POST /recipe/{recipeId}/review","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId","body"],"properties":{"recipeId":{"type":"integer"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-get":{"get":{"operationId":"open_data_bigoven_review_get","summary":"Get a given review - DEPRECATED. See recipe/review/{reviewId} for the current usage. Beginning in January…","description":"GET /recipe/{recipeId}/review/{reviewId}","tags":["open-data"],"parameters":[{"name":"reviewId","in":"query","required":true,"description":"int","schema":{"type":"integer","description":"int"}},{"name":"recipeId","in":"query","required":true,"description":"int","schema":{"type":"integer","description":"int"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-put-legacy":{"post":{"operationId":"open_data_bigoven_review_put_legacy","summary":"HTTP PUT (update) a recipe review. DEPRECATED. Please see recipe/review/{reviewId} PUT for the new endpoint.…","description":"PUT /recipe/{recipeId}/review/{reviewId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reviewId","recipeId","body"],"properties":{"reviewId":{"type":"integer","description":"reviewId (int)"},"recipeId":{"type":"integer","description":"recipeId (int)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-delete":{"post":{"operationId":"open_data_bigoven_review_delete","summary":"DEPRECATED! - Deletes a review by recipeId and reviewId. Please use recipe/review/{reviewId} instead.","description":"DELETE /recipe/{recipeId}/review/{reviewId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["recipeId","reviewId"],"properties":{"recipeId":{"type":"integer"},"reviewId":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/review-get-reviews":{"get":{"operationId":"open_data_bigoven_review_get_reviews","summary":"Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a…","description":"GET /recipe/{recipeId}/reviews","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"recipe id (int)","schema":{"type":"integer","description":"recipe id (int)"}},{"name":"pg","in":"query","required":false,"description":"the page (int), starting with 1","schema":{"type":"integer","description":"the page (int), starting with 1"}},{"name":"rpp","in":"query","required":false,"description":"results per page (int)","schema":{"type":"integer","description":"results per page (int)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/images-get-scan-images":{"get":{"operationId":"open_data_bigoven_images_get_scan_images","summary":"Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.","description":"GET /recipe/{recipeId}/scans","tags":["open-data"],"parameters":[{"name":"recipeId","in":"query","required":true,"description":"the recipe identifier (int)","schema":{"type":"integer","description":"the recipe identifier (int)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-recipe-search":{"get":{"operationId":"open_data_bigoven_recipe_recipe_search","summary":"Search for recipes. There are many parameters that you can apply. Starting with the most common, use…","description":"GET /recipes","tags":["open-data"],"parameters":[{"name":"any_kw","in":"query","required":false,"description":"Search anywhere in the recipe for the keyword","schema":{"type":"string","description":"Search anywhere in the recipe for the keyword"}},{"name":"folder","in":"query","required":false,"description":"Search in a specific folder name for the authenticated user","schema":{"type":"string","description":"Search in a specific folder name for the authenticated user"}},{"name":"coll","in":"query","required":false,"description":"Limit to a collection ID number","schema":{"type":"integer","description":"Limit to a collection ID number"}},{"name":"filter","in":"query","required":false,"description":"optionally set to either \"myrecipes\", \"try\", \"favorites\",\"added\" to filter to just the authenticated user's recipe set","schema":{"type":"string","description":"optionally set to either \"myrecipes\", \"try\", \"favorites\",\"added\" to filter to just the authenticated user's recipe set"}},{"name":"title_kw","in":"query","required":false,"description":"Search just in the recipe title for the keyword","schema":{"type":"string","description":"Search just in the recipe title for the keyword"}},{"name":"userId","in":"query","required":false,"description":"Set the target userid to search their public recipes","schema":{"type":"integer","description":"Set the target userid to search their public recipes"}},{"name":"username","in":"query","required":false,"description":"Set the target username to search their public recipes","schema":{"type":"string","description":"Set the target username to search their public recipes"}},{"name":"token","in":"query","required":false,"schema":{"type":"string"}},{"name":"photos","in":"query","required":false,"description":"if set to true, limit search results to photos only","schema":{"type":"boolean","description":"if set to true, limit search results to photos only"}},{"name":"boostmine","in":"query","required":false,"description":"if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)","schema":{"type":"boolean","description":"if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)"}},{"name":"include_cat","in":"query","required":false,"description":"integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance,…","schema":{"type":"string","description":"integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance,…"}},{"name":"exclude_cat","in":"query","required":false,"description":"like include_cat, set this to an integer to exclude a specific category","schema":{"type":"string","description":"like include_cat, set this to an integer to exclude a specific category"}},{"name":"include_primarycat","in":"query","required":false,"description":"csv indicating up to three top-level categories -- valid values are…","schema":{"type":"string","description":"csv indicating up to three top-level categories -- valid values are…"}},{"name":"exclude_primarycat","in":"query","required":false,"description":"csv indicating integer values for up to 3 top-level categories -- valid values are 1...11…","schema":{"type":"string","description":"csv indicating integer values for up to 3 top-level categories -- valid values are 1...11…"}},{"name":"include_ing","in":"query","required":false,"description":"A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken","schema":{"type":"string","description":"A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken"}},{"name":"exclude_ing","in":"query","required":false,"description":"A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)","schema":{"type":"string","description":"A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)"}},{"name":"cuisine","in":"query","required":false,"description":"Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are…","schema":{"type":"string","description":"Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are…"}},{"name":"db","in":"query","required":false,"schema":{"type":"string"}},{"name":"userset","in":"query","required":false,"description":"If set to a given username, it'll force the search to filter to just that username","schema":{"type":"string","description":"If set to a given username, it'll force the search to filter to just that username"}},{"name":"servingsMin","in":"query","required":false,"description":"Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by…","schema":{"type":"number","description":"Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by…"}},{"name":"totalMins","in":"query","required":false,"description":"Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert \"1 hour, 15 minutes\" to 75…","schema":{"type":"integer","description":"Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert \"1 hour, 15 minutes\" to 75…"}},{"name":"maxIngredients","in":"query","required":false,"description":"Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less","schema":{"type":"integer","description":"Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less"}},{"name":"minIngredients","in":"query","required":false,"description":"Optional. If supplied, will restrict results to recipes that have at least {minIngredients}","schema":{"type":"integer","description":"Optional. If supplied, will restrict results to recipes that have at least {minIngredients}"}},{"name":"rpp","in":"query","required":false,"description":"integer; results per page","schema":{"type":"integer","description":"integer; results per page"}},{"name":"pg","in":"query","required":false,"description":"integer: the page number","schema":{"type":"integer","description":"integer: the page number"}},{"name":"vtn","in":"query","required":false,"description":"when set to 1, limit to vegetarian (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to vegetarian (Powersearch-capable plan required)"}},{"name":"vgn","in":"query","required":false,"description":"when set to 1, limit to vegan (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to vegan (Powersearch-capable plan required)"}},{"name":"chs","in":"query","required":false,"description":"when set to 1, limit to contains-cheese (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to contains-cheese (Powersearch-capable plan required)"}},{"name":"glf","in":"query","required":false,"description":"when set to 1, limit to gluten-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to gluten-free (Powersearch-capable plan required)"}},{"name":"ntf","in":"query","required":false,"description":"when set to 1, limit to nut-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to nut-free (Powersearch-capable plan required)"}},{"name":"dyf","in":"query","required":false,"description":"when set to 1, limit to dairy-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to dairy-free (Powersearch-capable plan required)"}},{"name":"sff","in":"query","required":false,"description":"when set to 1, limit to seafood-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to seafood-free (Powersearch-capable plan required)"}},{"name":"slf","in":"query","required":false,"description":"when set to 1, limit to shellfish-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to shellfish-free (Powersearch-capable plan required)"}},{"name":"tnf","in":"query","required":false,"description":"when set to 1, limit to tree-nut free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to tree-nut free (Powersearch-capable plan required)"}},{"name":"wmf","in":"query","required":false,"description":"when set to 1, limit to white-meat free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to white-meat free (Powersearch-capable plan required)"}},{"name":"rmf","in":"query","required":false,"description":"when set to 1, limit to red-meat free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to red-meat free (Powersearch-capable plan required)"}},{"name":"cps","in":"query","required":false,"description":"when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)"}},{"name":"champion","in":"query","required":false,"description":"optional. When set to 1, this will limit search results to \"best of\" recipes as determined by various internal editorial and programmatic…","schema":{"type":"integer","description":"optional. When set to 1, this will limit search results to \"best of\" recipes as determined by various internal editorial and programmatic…"}},{"name":"synonyms","in":"query","required":false,"description":"optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude…","schema":{"type":"boolean","description":"optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-random-recipe":{"get":{"operationId":"open_data_bigoven_recipe_get_random_recipe","summary":"Get a random, home-page-quality Recipe.","description":"GET /recipes/random","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-raves":{"get":{"operationId":"open_data_bigoven_recipe_raves","summary":"Get the recipe/comment tuples for those recipes with 4 or 5 star ratings","description":"GET /recipes/raves","tags":["open-data"],"parameters":[{"name":"pg","in":"query","required":false,"description":"page, starting with 1","schema":{"type":"integer","description":"page, starting with 1"}},{"name":"rpp","in":"query","required":false,"description":"results per page","schema":{"type":"integer","description":"results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-recent-views":{"get":{"operationId":"open_data_bigoven_recipe_recent_views","summary":"Get a list of recipes that the authenticated user has most recently viewed","description":"GET /recipes/recentviews","tags":["open-data"],"parameters":[{"name":"pg","in":"query","required":false,"description":"Page number starting with 1","schema":{"type":"integer","description":"Page number starting with 1"}},{"name":"rpp","in":"query","required":false,"description":"results per page","schema":{"type":"integer","description":"results per page"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-recipe-search-random":{"get":{"operationId":"open_data_bigoven_recipe_recipe_search_random","summary":"Search for recipes. There are many parameters that you can apply. Starting with the most common, use…","description":"GET /recipes/top25random","tags":["open-data"],"parameters":[{"name":"any_kw","in":"query","required":false,"description":"Search anywhere in the recipe for the keyword","schema":{"type":"string","description":"Search anywhere in the recipe for the keyword"}},{"name":"folder","in":"query","required":false,"description":"Search in a specific folder name for the authenticated user","schema":{"type":"string","description":"Search in a specific folder name for the authenticated user"}},{"name":"coll","in":"query","required":false,"description":"Limit to a collection ID number","schema":{"type":"integer","description":"Limit to a collection ID number"}},{"name":"filter","in":"query","required":false,"description":"optionally set to either \"myrecipes\", \"try\", \"favorites\",\"added\" to filter to just the authenticated user's recipe set","schema":{"type":"string","description":"optionally set to either \"myrecipes\", \"try\", \"favorites\",\"added\" to filter to just the authenticated user's recipe set"}},{"name":"title_kw","in":"query","required":false,"description":"Search just in the recipe title for the keyword","schema":{"type":"string","description":"Search just in the recipe title for the keyword"}},{"name":"userId","in":"query","required":false,"description":"Set the target userid to search their public recipes","schema":{"type":"integer","description":"Set the target userid to search their public recipes"}},{"name":"username","in":"query","required":false,"description":"Set the target username to search their public recipes","schema":{"type":"string","description":"Set the target username to search their public recipes"}},{"name":"token","in":"query","required":false,"schema":{"type":"string"}},{"name":"photos","in":"query","required":false,"description":"if set to true, limit search results to photos only","schema":{"type":"boolean","description":"if set to true, limit search results to photos only"}},{"name":"boostmine","in":"query","required":false,"description":"if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)","schema":{"type":"boolean","description":"if set to true, boost my own recipes in my folders so they show up high in the list (at the expense of other sort orders)"}},{"name":"include_cat","in":"query","required":false,"description":"integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance,…","schema":{"type":"string","description":"integer of the subcategory you'd like to limit searches to (see the /recipe/categories endpoint for available id numbers). For instance,…"}},{"name":"exclude_cat","in":"query","required":false,"description":"like include_cat, set this to an integer to exclude a specific category","schema":{"type":"string","description":"like include_cat, set this to an integer to exclude a specific category"}},{"name":"include_primarycat","in":"query","required":false,"description":"csv indicating up to three top-level categories -- valid values are…","schema":{"type":"string","description":"csv indicating up to three top-level categories -- valid values are…"}},{"name":"exclude_primarycat","in":"query","required":false,"description":"csv indicating integer values for up to 3 top-level categories -- valid values are 1...11…","schema":{"type":"string","description":"csv indicating integer values for up to 3 top-level categories -- valid values are 1...11…"}},{"name":"include_ing","in":"query","required":false,"description":"A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken","schema":{"type":"string","description":"A CSV representing up to 3 ingredients to include, e.g., tomatoes,corn%20%starch,chicken"}},{"name":"exclude_ing","in":"query","required":false,"description":"A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)","schema":{"type":"string","description":"A CSV representing up to 3 ingredients to exclude (Powersearch-capable plan required)"}},{"name":"cuisine","in":"query","required":false,"description":"Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are…","schema":{"type":"string","description":"Limit to a specific cuisine. Cooks can enter anything free-form, but the few dozen preconfigured values are…"}},{"name":"db","in":"query","required":false,"schema":{"type":"string"}},{"name":"userset","in":"query","required":false,"description":"If set to a given username, it'll force the search to filter to just that username","schema":{"type":"string","description":"If set to a given username, it'll force the search to filter to just that username"}},{"name":"servingsMin","in":"query","required":false,"description":"Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by…","schema":{"type":"number","description":"Limit to yield of a given number size or greater. Note that cooks usually enter recipes by Servings, but sometimes they are posted by…"}},{"name":"totalMins","in":"query","required":false,"description":"Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert \"1 hour, 15 minutes\" to 75…","schema":{"type":"integer","description":"Optional. If supplied, will restrict results to recipes that can be made in {totalMins} or less. (Convert \"1 hour, 15 minutes\" to 75…"}},{"name":"maxIngredients","in":"query","required":false,"description":"Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less","schema":{"type":"integer","description":"Optional. If supplied, will restrict results to recipes that can be made with {maxIngredients} ingredients or less"}},{"name":"minIngredients","in":"query","required":false,"description":"Optional. If supplied, will restrict results to recipes that have at least {minIngredients}","schema":{"type":"integer","description":"Optional. If supplied, will restrict results to recipes that have at least {minIngredients}"}},{"name":"vtn","in":"query","required":false,"description":"when set to 1, limit to vegetarian (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to vegetarian (Powersearch-capable plan required)"}},{"name":"vgn","in":"query","required":false,"description":"when set to 1, limit to vegan (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to vegan (Powersearch-capable plan required)"}},{"name":"chs","in":"query","required":false,"description":"when set to 1, limit to contains-cheese (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to contains-cheese (Powersearch-capable plan required)"}},{"name":"glf","in":"query","required":false,"description":"when set to 1, limit to gluten-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to gluten-free (Powersearch-capable plan required)"}},{"name":"ntf","in":"query","required":false,"description":"when set to 1, limit to nut-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to nut-free (Powersearch-capable plan required)"}},{"name":"dyf","in":"query","required":false,"description":"when set to 1, limit to dairy-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to dairy-free (Powersearch-capable plan required)"}},{"name":"sff","in":"query","required":false,"description":"when set to 1, limit to seafood-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to seafood-free (Powersearch-capable plan required)"}},{"name":"slf","in":"query","required":false,"description":"when set to 1, limit to shellfish-free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to shellfish-free (Powersearch-capable plan required)"}},{"name":"tnf","in":"query","required":false,"description":"when set to 1, limit to tree-nut free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to tree-nut free (Powersearch-capable plan required)"}},{"name":"wmf","in":"query","required":false,"description":"when set to 1, limit to white-meat free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to white-meat free (Powersearch-capable plan required)"}},{"name":"rmf","in":"query","required":false,"description":"when set to 1, limit to red-meat free (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, limit to red-meat free (Powersearch-capable plan required)"}},{"name":"cps","in":"query","required":false,"description":"when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)","schema":{"type":"integer","description":"when set to 1, recipe contains pasta, set to 0 means contains no pasta (Powersearch-capable plan required)"}},{"name":"champion","in":"query","required":false,"description":"optional. When set to 1, this will limit search results to \"best of\" recipes as determined by various internal editorial and programmatic…","schema":{"type":"integer","description":"optional. When set to 1, this will limit search results to \"best of\" recipes as determined by various internal editorial and programmatic…"}},{"name":"synonyms","in":"query","required":false,"description":"optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude…","schema":{"type":"boolean","description":"optional, default is false. When set to true, BigOven will attempt to apply synonyms in search (e.g., excluding pork will also exclude…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:bigoven/recipe-get-v2":{"get":{"operationId":"open_data_bigoven_recipe_get_v2","summary":"Same as GET recipe but also includes the recipe videos (if any)","description":"GET /recipes/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"The Recipe ID to retrieve","schema":{"type":"integer","description":"The Recipe ID to retrieve"}},{"name":"prefetch","in":"query","required":false,"description":"The prefetch.","schema":{"type":"boolean","description":"The prefetch."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}