io.kich.grocery.defs

kich.io

Documentation

Shared definitions for grocery-related lexicons

main object

Shared definitions for grocery-related lexicons

This object has no properties defined.

View raw schema 
{
  "description": "Shared definitions for grocery-related lexicons",
  "properties": {},
  "type": "object"
}
groceryListView object

A shopping list, without its items. `toBuy` is the count a reader actually wants; the items themselves are a shopping surface, not a planning one.

Properties

completedAt string datetime Optional

An RFC 3339 formatted timestamp.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

id string Required

No description available.

name string Required

No description available.

status string Required

No description available.

Known values: draft, active, completed, archived
toBuy integer Required

How many items on the list are still unchecked

minimum: 0
View raw schema 
{
  "description": "A shopping list, without its items. `toBuy` is the count a reader actually wants; the items themselves are a shopping surface, not a planning one.",
  "properties": {
    "completedAt": {
      "format": "datetime",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "knownValues": [
        "draft",
        "active",
        "completed",
        "archived"
      ],
      "type": "string"
    },
    "toBuy": {
      "description": "How many items on the list are still unchecked",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "toBuy"
  ],
  "type": "object"
}
plannedRecipe object

A recipe somebody attached to a shopping list — which is what a planned meal is in this product. There is no separate meal-plan record, and this view does not pretend there is one.

Properties

plannedDate string datetime Optional

The night it is meant for, when somebody set one. Usually absent — most lists are ordered, not dated.

servings unknown Required

How many this is being cooked for, which may differ from the recipe's own

View raw schema 
{
  "description": "A recipe somebody attached to a shopping list — which is what a planned meal is in this product. There is no separate meal-plan record, and this view does not pretend there is one.",
  "properties": {
    "plannedDate": {
      "description": "The night it is meant for, when somebody set one. Usually absent — most lists are ordered, not dated.",
      "format": "datetime",
      "type": "string"
    },
    "recipe": {
      "ref": "io.kich.recipe.defs#recipeView",
      "type": "ref"
    },
    "servings": {
      "description": "How many this is being cooked for, which may differ from the recipe's own",
      "type": "unknown"
    }
  },
  "required": [
    "recipe",
    "servings"
  ],
  "type": "object"
}

Lexicon Garden

@