io.kich.recipe.defs

kich.io

Documentation

Shared definitions for recipe-related lexicons

main object

Shared definitions for recipe-related lexicons

This object has no properties defined.

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

A collection this recipe belongs to, by id and display name.

Properties

id string Required

No description available.

name string Required

No description available.

View raw schema 
{
  "description": "A collection this recipe belongs to, by id and display name.",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
recipeView object

A recipe as a list reader sees it: enough to choose one, not enough to cook it. Ingredients and instructions are deliberately absent — a caller that wants to cook follows `url`.

Properties

collections array of ref#collectionRef Optional

No description available.

completenessPercent integer Required

How much of this recipe the pantry already covers, 0–100. A whole number rather than the stored 0–1 fraction, because lexicons have no float type and no reader needs the precision.

minimum: 0maximum: 100
cookTimeMinutes integer Optional

No description available.

minimum: 0
createdAt string datetime Optional

When the recipe was saved to this kitchen. Distinct from `updatedAt`, which moves every time somebody edits it — a reader sorting a cookbook by what is new wants the first, not the second.

description string Optional

No description available.

id string Required

Stable identifier for this recipe

imageUrl string uri Optional

An absolute URL to a photograph, already resolved — whether the recipe is private (object storage) or published (a PDS blob on a CDN). Absent when the recipe has no image.

missingCount integer Optional

How many ingredients are not in the house. 0 means everything is in.

minimum: 0
name string Required

No description available.

prepTimeMinutes integer Optional

No description available.

minimum: 0
servings unknown Required

How many the recipe makes. A number; halves are real, so not an integer.

tags array of ref#tagRef Optional

No description available.

updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

url string uri Required

Where to open this recipe in kich

View raw schema 
{
  "description": "A recipe as a list reader sees it: enough to choose one, not enough to cook it. Ingredients and instructions are deliberately absent — a caller that wants to cook follows `url`.",
  "properties": {
    "collections": {
      "items": {
        "ref": "#collectionRef",
        "type": "ref"
      },
      "type": "array"
    },
    "completenessPercent": {
      "description": "How much of this recipe the pantry already covers, 0–100. A whole number rather than the stored 0–1 fraction, because lexicons have no float type and no reader needs the precision.",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "cookTimeMinutes": {
      "minimum": 0,
      "type": "integer"
    },
    "createdAt": {
      "description": "When the recipe was saved to this kitchen. Distinct from `updatedAt`, which moves every time somebody edits it — a reader sorting a cookbook by what is new wants the first, not the second.",
      "format": "datetime",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "description": "Stable identifier for this recipe",
      "type": "string"
    },
    "imageUrl": {
      "description": "An absolute URL to a photograph, already resolved — whether the recipe is private (object storage) or published (a PDS blob on a CDN). Absent when the recipe has no image.",
      "format": "uri",
      "type": "string"
    },
    "missingCount": {
      "description": "How many ingredients are not in the house. 0 means everything is in.",
      "minimum": 0,
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "prepTimeMinutes": {
      "minimum": 0,
      "type": "integer"
    },
    "servings": {
      "description": "How many the recipe makes. A number; halves are real, so not an integer.",
      "type": "unknown"
    },
    "tags": {
      "items": {
        "ref": "#tagRef",
        "type": "ref"
      },
      "type": "array"
    },
    "updatedAt": {
      "format": "datetime",
      "type": "string"
    },
    "url": {
      "description": "Where to open this recipe in kich",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "servings",
    "completenessPercent",
    "url"
  ],
  "type": "object"
}
tagRef object

A tag, by id and display name.

Properties

id string Required

No description available.

name string Required

No description available.

View raw schema 
{
  "description": "A tag, by id and display name.",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}

Lexicon Garden

@