Sign in
recipes

Add an ingredient the import missed

Recorded as an ingredient_added correction, which together with a rejected line is the only measure of whether extraction missed or invented ingredients.

post/chefs/recipes/{recipe_id}/review

Path parameters

recipe_idinteger required

Request body

food_namestring nullable

Required when rxfood_id is omitted.

group_idinteger nullable

Add the line into this existing ingredient group on the recipe.

group_namestring nullable

Add the line into a group with this name, creating it on the recipe if needed. Takes precedence over group_id.

notestring nullable
rxfood_idstring nullable
serving_unit_labelstring nullable
servingsnumber nullable

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.6

  • a61b77b30e631See the full diff
    • ○

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

      response-optional-property-added

  • 2991fb51502d4See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      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