Sign in
recipes

Every ingredient on a recipe, with what still needs a decision

Keyed on the ingredient rather than the scan line, so a CSV import, a photo scan, a URL import and a hand-entered recipe all review the same way. Unresolved lines are returned first. Where a line came from a scan its original text and the parser's reading are included as provenance; their absence simply means there is no extra context. Publishing is blocked while any line is unresolved, counted from the same ingredients this returns.

get/chefs/recipes/{recipe_id}/review

Path parameters

recipe_idinteger required

Response

successful operation

child_recipe_idinteger nullable
descriptionstring nullable
extracted_namestring nullable

What the parser read the ingredient as.

food_namestring nullable
group_idinteger nullable

Ingredient group this line belongs to, or null when ungrouped.

group_namestring nullable

Display name of the line's ingredient group, for showing headings without a second lookup.

ingredient_idinteger nullable

Null for a rejected line, which no longer has an ingredient but stays visible so the curator can see what was discarded.

mapping_confidencenumber nullable
mapping_status'unmatched' | 'auto' | 'confirmed' | 'rejected' nullable

A rejected line is returned with resolved=true and no ingredient_id: it needs no further decision but is shown so the discard is visible.

original_textstring nullable

What the source said, for a scanned or imported line.

resolvedboolean
rxfood_idstring nullable
serving_unit_labelstring nullable
servingsnumber nullable
sort_orderinteger

Changes

Changed in 3 of the 15 revisions of this API.4

  • a61b77b30e631See the full diff
    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

  • 2991fb51502d2See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 8d4f658e79b11See the full diff
    • ○

      endpoint added

      endpoint-added