cogsmith.bainer.ca

{
  "type": "object",
  "properties": {
    "units": {
      "type": "string",
      "enum": [
        "metric",
        "imperial"
      ],
      "description": "Unit used by wheelDiameter, chainstayLength, and dropoutTravel. Metric values are millimetres; imperial values are inches."
    },
    "chainrings": {
      "type": "array",
      "description": "Chainring tooth counts to compare.",
      "items": {
        "type": "integer",
        "minimum": 20,
        "maximum": 60
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "rearCogs": {
      "type": "array",
      "description": "Rear cog tooth counts to compare.",
      "items": {
        "type": "integer",
        "minimum": 7,
        "maximum": 52
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "wheelDiameter": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "Outer diameter of the inflated tire, in the selected measurement units. Accepted range: 100–2000 mm or 4–80 in."
    },
    "chainstayLength": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "Distance from the bottom-bracket centre to the rear-axle centre, in the selected measurement units. Accepted range: 50–1000 mm or 2–40 in."
    },
    "dropoutTravel": {
      "type": "number",
      "minimum": 0,
      "description": "Available axle movement in either direction from the measured chainstay length, in the selected measurement units. Accepted range: 0–250 mm or 0–10 in."
    },
    "targetGearInches": {
      "type": "number",
      "minimum": 1,
      "maximum": 500,
      "description": "Desired pedalling difficulty expressed in gear inches."
    },
    "gearTolerance": {
      "type": "number",
      "minimum": 0,
      "maximum": 500,
      "description": "Allowed difference above or below targetGearInches."
    },
    "includeHalfLink": {
      "type": "boolean",
      "default": false,
      "description": "Whether to include the extra chain positions made possible by a half-link."
    },
    "maxResults": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 20,
      "description": "Maximum number of ranked combinations to return. The response still reports the total number calculated."
    }
  },
  "required": [
    "units",
    "chainrings",
    "rearCogs",
    "wheelDiameter",
    "chainstayLength",
    "dropoutTravel",
    "targetGearInches",
    "gearTolerance"
  ],
  "additionalProperties": false
}