io.kich.pantry.defs Documentation (EN)

main object

Shared definitions for pantry-related lexicons

This object has no properties defined.

View raw schema

{
  "description": "Shared definitions for pantry-related lexicons",
  "properties": {},
  "type": "object"
}

pantryItemView object

One thing in the house, as a reader sees it.

Properties

category string Optional

The product catalogue's category, where the item is matched to one

expirationDate string datetime Optional

When this turns. Absent for things that do not.

id string Required

Stable identifier for this pantry item

name string Required

What the thing is called

notes string Optional

Whatever somebody wrote on it

purchasedAt string datetime Optional

When it came into the house

quantity unknown Required

How much there is. A number, and deliberately not an integer: half a bag is a real quantity.

status string Required

Whether the item is in stock, running low, or used up. `finished` items are never returned.

Known values: in_stock, low, depleted

unit string Required

The unit the quantity is counted in (pieces, g, ml, bunch)

View raw schema

{
  "description": "One thing in the house, as a reader sees it.",
  "properties": {
    "category": {
      "description": "The product catalogue's category, where the item is matched to one",
      "type": "string"
    },
    "expirationDate": {
      "description": "When this turns. Absent for things that do not.",
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "Stable identifier for this pantry item",
      "type": "string"
    },
    "name": {
      "description": "What the thing is called",
      "type": "string"
    },
    "notes": {
      "description": "Whatever somebody wrote on it",
      "type": "string"
    },
    "purchasedAt": {
      "description": "When it came into the house",
      "format": "datetime",
      "type": "string"
    },
    "quantity": {
      "description": "How much there is. A number, and deliberately not an integer: half a bag is a real quantity.",
      "type": "unknown"
    },
    "status": {
      "description": "Whether the item is in stock, running low, or used up. `finished` items are never returned.",
      "knownValues": [
        "in_stock",
        "low",
        "depleted"
      ],
      "type": "string"
    },
    "unit": {
      "description": "The unit the quantity is counted in (pieces, g, ml, bunch)",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "quantity",
    "unit",
    "status"
  ],
  "type": "object"
}