{
  "openapi": "3.1.1",
  "info": {
    "title": "Battery Power Budget Planner API",
    "version": "1.0.0",
    "summary": "Estimate average current and battery runtime from duty cycles.",
    "description": "Every endpoint performs the same calculation as the human page and returns inputs, result, units, assumptions, sources, warnings and computedAt. MCP endpoint: /mcp."
  },
  "servers": [
    {
      "url": "https://ohmforgepowerbudget.usefulweb.app"
    }
  ],
  "paths": {
    "/api/v1/calculate": {
      "post": {
        "operationId": "calculate",
        "summary": "Estimate average current and battery runtime from duty cycles.",
        "description": "List active and sleep currents with duty cycles to estimate average draw and battery runtime.\n\nMethodology:\n- Average each load as active current times duty fraction plus sleep current times remaining fraction. Sum the averages.\n- Divide usable battery capacity by total average battery current; zero current has no finite runtime estimate.\n\nA planning estimate only. Capacity depends on discharge rate, temperature, aging and cutoff voltage. Account for converter losses and all loads in battery-side currents.",
        "tags": [
          "apps"
        ],
        "x-mcp-tool": "ohmforge_power_budget",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OhmforgePowerBudgetInput"
              },
              "examples": {
                "example1": {
                  "summary": "Intermittent sensor",
                  "value": {
                    "loads": "Controller,20,0.1,10\nSensor,5,0.01,5",
                    "capacity": 2000,
                    "usablePercent": 80
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Calculation result envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OhmforgePowerBudgetResult"
                }
              }
            }
          },
          "400": {
            "description": "Malformed JSON body.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "422": {
            "description": "Invalid input (see errors[]).",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit exceeded (see Retry-After).",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/tool": {
      "get": {
        "operationId": "getToolDefinition",
        "summary": "Inputs, output schema and examples for this tool",
        "responses": {
          "200": {
            "description": "Tool definition.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Problem": {
        "type": "object",
        "description": "RFC 9457 problem details. 422 responses include per-field `errors`.",
        "required": [
          "type",
          "title",
          "status",
          "detail"
        ],
        "properties": {
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "integer"
          },
          "detail": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "field",
                "message"
              ],
              "properties": {
                "field": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "OhmforgePowerBudgetInput": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "loads": {
            "title": "Loads: name, active current (mA), sleep current (mA), duty (%)",
            "description": "One load per row. Currents must be drawn from the battery itself.",
            "type": "string",
            "maxLength": 20000,
            "default": "Controller,20,0.1,10\nSensor,5,0.01,5"
          },
          "capacity": {
            "title": "Battery capacity (mAh)",
            "type": "number",
            "minimum": 0.001,
            "maximum": 10000000,
            "default": 2000,
            "x-unit": "mAh"
          },
          "usablePercent": {
            "title": "Usable capacity (%)",
            "type": "number",
            "minimum": 0.001,
            "maximum": 100,
            "default": 80,
            "x-unit": "%"
          }
        },
        "required": []
      },
      "OhmforgePowerBudgetResult": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "schemaVersion",
          "tool",
          "computedAt",
          "inputs",
          "summary",
          "result",
          "units",
          "assumptions",
          "sources",
          "warnings",
          "presentation",
          "links"
        ],
        "properties": {
          "schemaVersion": {
            "type": "string",
            "const": "1.0"
          },
          "tool": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "name",
              "version"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "version": {
                "type": "string"
              }
            }
          },
          "computedAt": {
            "type": "string",
            "format": "date-time"
          },
          "inputs": {
            "type": "object",
            "description": "Normalised inputs actually used, including applied defaults."
          },
          "summary": {
            "type": "string"
          },
          "result": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "loads",
              "average",
              "usableCapacity",
              "runtimeHours"
            ],
            "properties": {
              "loads": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "active",
                    "sleep",
                    "duty",
                    "average"
                  ],
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "active": {
                      "type": "number"
                    },
                    "sleep": {
                      "type": "number"
                    },
                    "duty": {
                      "type": "number"
                    },
                    "average": {
                      "type": "number"
                    }
                  }
                }
              },
              "average": {
                "type": "number"
              },
              "usableCapacity": {
                "type": "number"
              },
              "runtimeHours": {
                "type": [
                  "number",
                  "null"
                ]
              }
            }
          },
          "units": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "assumptions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "sources": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "required": [
                "title"
              ],
              "properties": {
                "title": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                },
                "publisher": {
                  "type": "string"
                },
                "retrievedAt": {
                  "type": "string"
                },
                "note": {
                  "type": "string"
                }
              }
            }
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "presentation": {
            "type": "array",
            "items": {
              "type": "object"
            },
            "description": "Display blocks used by the human page (same data)."
          },
          "links": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "human",
              "api",
              "openapi",
              "methodology"
            ],
            "properties": {
              "human": {
                "type": "string",
                "format": "uri"
              },
              "api": {
                "type": "string",
                "format": "uri"
              },
              "openapi": {
                "type": "string",
                "format": "uri"
              },
              "methodology": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        }
      }
    }
  }
}