Ingredient Schema

Schema definition for the Ingredient object in product data

Ingredient Schema

This is a data schema, not an API endpoint. The Ingredient object describes the shape of data returned inside product records by the Product Opener API.

{
  "type": "object",
  "title": "ingredient",
  "properties": {
    "id": {
      "type": "string"
    },
    "ingredients": {
      "type": "array",
      "description": "This structure gives the different ingredients and some information about them,\nlike estimate on their quantity.\n",
      "items": {
        "$ref": "#/components/schemas/Ingredient"
      }
    },
    "percent": {
      "type": "integer",
      "description": "The percentage of the ingredient."
    },
    "percent_estimate": {
      "type": "number",
      "description": "Estimated percentage of the ingredient."
    },
    "percent_max": {
      "type": [
        "string",
        "number"
      ],
      "description": "Maximum percentage of the ingredient."
    },
    "percent_min": {
      "type": "integer",
      "description": "Minimum percentage of the ingredient."
    },
    "text": {
      "type": "string",
      "description": "Text description of the ingredient."
    },
    "vegan": {
      "type": "string",
      "description": "Indicates if the ingredient is vegan."
    },
    "vegetarian": {
      "type": "string",
      "description": "Indicates if the ingredient is vegetarian."
    }
  }
}