Home

Welcome to the OpenBrews wiki!

Here is the format for a recipe object:

      {
        name: "Citra Pale Ale",
        style: "American Pale Ale",
        boilSize: 5,
        boilSizeUnits: "Gal",
        boilTime: 60,
        estFermentationDays: 7,
        secondaryTimeDays: 7,
        mashEfficiency: 68,
        fermentables: [
          {
            name: "Pale Liquid Extract",
            method: "Extract",
            weight: 9.00,
            weightUnits: "Lbs",
            addTime: 15,
            ppg: 1.036,
            srm: 8.0
          }
        ],
        hops: [
          {
            name: "Citra",
            type: "Pellet",
            weight: 1,
            weightUnits: "oz",
            aa: 0.125,
            stage: "Boil",
            addTime: 60
          },
          {
            name: "Citra",
            type: "Pellet",
            weight: 1,
            weightUnits: "oz",
            aa: 0.125,
            stage: "Secondary"
          }
        ],
        yeasts: [
          {
            name: "WY1056 American Ale",
            attenuation: 0.75,
            flocculation: "Medium-Low",
            amount: "13.5",
            amountUnits: "G"
          }
        ],
        others: [
          {
            name: "Orange Peel",
            amount: 5.0,
            amountUnits: "oz",
            stage: "Boil",
            addTime: "60"
          },
          {
            name: "Orange Peel",
            amount: 5.0,
            amountUnits: "oz",
            stage: "Secondary"
          }
        ],
        notes: [
          "Don't boil over!"
        ]
      };

Here is an object modified to have every field name from a Recipe object, but instead of a value it just has a string explaining validation rules for that field.

      {
        name: "string",
        style: "string",
        boilSize: "int, default: 5, range: >=0",
        boilSizeUnits: "Gal|L",
        boilTime: "int, default: 60, range: >=0",
        estFermentationDays: "int, default: 7, range: >=0",
        secondaryTimeDays: "int, default: 0, range: >=0",
        mashEfficiency: "int, default: 68, range: [100,0]",
        fermentables: [
          {
            name: "string",
            method: "Mash|Partial Mash|Extract",
            weight: "float, range: >= 0",
            weightUnits: "Lbs|Kg",
            addTime: "int, default: 0, range: [boilTime,0]",
            ppg: "float, default: 0, range: >= 0",
            srm: "float, default: 0, range: >= 0"
          }
        ],
        hops: [
          {
            name: "string",
            type: "Leaf|Pellet|Plug",
            weight: "float, default: 0, range: >=0",
            weightUnits: "oz|G",
            aa: "float, default: 0, range: >=0",
            stage: "Boil|Secondary",
            addTime: "int, default: 0, range: [boilTime,0]"
          }
        ],
        yeasts: [
          {
            name: "string",
            attenuation: "float: default: 0, range: [1,0]",
            flocculation: "Low to Medium|Medium|Medium-Low|Medium to High|High|Very High",
            amount: "float: default: 0, range: >= 0",
            amountUnits: "G|mL|fl oz|oz"
          }
        ],
        others: [
          {
            name: "string",
            amount: "int: default: 0, range: >=0,
            amountUnits: "oz|fl oz|G|mL",
            stage: "Boil|Secondary",
            addTime: "int, default: 0, range: >= 0"
          }
        ],
        notes: [
          "string"
        ]
      };