{
  "openapi": "3.0.3",
  "info": {
    "title": "StateV vAPI",
    "version": "v1",
    "description": "Nur Routen, die im Frontend dokumentiert und im Backend implementiert sind. Auth: `Authorization: Bearer <API-Key>`. Base URL: `https://api.statev.de/req`."
  },
  "servers": [
    {
      "url": "https://api.statev.de/req"
    }
  ],
  "tags": [
    { "name": "factory", "description": "Firmen und firmennahe Daten" },
    { "name": "market", "description": "Import- und Exportauktionen" },
    { "name": "options", "description": "Freitext-Optionen fuer Firmen" }
  ],
  "paths": {
    "/factory/list/": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryList",
        "summary": "Eigene Firmen auflisten",
        "description": "Liefert alle Firmen des aktuellen Charakters. Ohne `factory.details` fehlen `isOpen`, `address` und `type`.",
        "x-required-scopes": ["factory"],
        "x-optional-scopes": ["factory.details"],
        "security": [{ "bearerAuth": [] }],
        "responses": {
          "200": {
            "description": "Liste eigener Firmen",
            "content": {
              "application/json": {
                "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FactorySummary" } }
              }
            }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/inventory/{firmenId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryInventory",
        "summary": "Firmenlager lesen",
        "description": "Normales Lager der Firma, ohne Maschinenlager und Theke.",
        "x-required-scopes": ["factory", "factory.inventory"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/firmenId" }],
        "responses": {
          "200": {
            "description": "Lagerbestand",
            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryResponse" } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" },
          "404": { "$ref": "#/components/responses/NotFound" }
        }
      }
    },
    "/factory/machine/{firmenId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryMachineInventory",
        "summary": "Maschinenlager lesen",
        "x-required-scopes": ["factory", "factory.inventory"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/firmenId" }],
        "responses": {
          "200": {
            "description": "Maschinenlager",
            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryResponse" } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" },
          "404": { "$ref": "#/components/responses/NotFound" }
        }
      }
    },
    "/factory/counter/{firmenId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryCounter",
        "summary": "Theke lesen",
        "description": "Items inklusive Preis aus der Theke. Relevant fuer Endverbraucherlaeden.",
        "x-required-scopes": ["factory", "factory.counter"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/firmenId" }],
        "responses": {
          "200": {
            "description": "Thekenbestand",
            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterResponse" } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" },
          "404": { "$ref": "#/components/responses/NotFound" }
        }
      }
    },
    "/factory/productions/{firmenId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryProductions",
        "summary": "Verfuegbare Produktionen lesen",
        "x-required-scopes": ["factory", "factory.productions"],
        "x-access-tier": "patron",
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/firmenId" }],
        "responses": {
          "200": {
            "description": "Produktionen",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Production" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/bankaccounts/{firmenId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryBankAccounts",
        "summary": "Bankkonten der Firma lesen",
        "x-required-scopes": ["factory", "factory.bankaccount"],
        "x-access-tier": "patron",
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/firmenId" }],
        "responses": {
          "200": {
            "description": "Bankkonten",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/transactions/{bankId}/{limit}/{offset}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryBankTransactions",
        "summary": "Banktransaktionen lesen",
        "description": "Frontend nennt den dritten Parameter `offset`; im Backend wird derselbe Wert als `skip` behandelt. `limit` ist maximal 25, `offset` maximal 200.",
        "x-required-scopes": ["factory", "factory.bankaccount"],
        "x-access-tier": "patron",
        "security": [{ "bearerAuth": [] }],
        "parameters": [
          { "$ref": "#/components/parameters/bankId" },
          { "$ref": "#/components/parameters/limit25" },
          { "$ref": "#/components/parameters/offset200" }
        ],
        "responses": {
          "200": {
            "description": "Transaktionen",
            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionsResponse" } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/marketoffers/sell/{factoryId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactorySellOffers",
        "summary": "Marktangebote zum Verkauf lesen",
        "x-required-scopes": ["factory", "market"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/factoryId" }],
        "responses": {
          "200": {
            "description": "Verkaufsangebote",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketOfferSell" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/marketoffers/buy/{factoryId}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryBuyOffers",
        "summary": "Marktangebote zum Ankauf lesen",
        "x-required-scopes": ["factory", "market"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [{ "$ref": "#/components/parameters/factoryId" }],
        "responses": {
          "200": {
            "description": "Ankaufangebote",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketOfferBuy" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/buyLog/{factoryId}/{limit}/{skip}": {
      "get": {
        "tags": ["factory"],
        "operationId": "getFactoryBuyLog",
        "summary": "Verkaufslog lesen",
        "description": "Das Frontend nennt den Scope `buylog`, das Backend prueft aktuell `factory.buylog`.",
        "x-required-scopes": ["factory", "factory.buylog"],
        "x-frontend-documented-scopes": ["factory", "buylog"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [
          { "$ref": "#/components/parameters/factoryId" },
          { "$ref": "#/components/parameters/limit50" },
          { "$ref": "#/components/parameters/skip1000" }
        ],
        "responses": {
          "200": {
            "description": "Verkaufslog",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BuyLogEntry" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/market/my/auctions/import": {
      "get": {
        "tags": ["market"],
        "operationId": "getMyImportAuctions",
        "summary": "Eigene Importauktionen lesen",
        "x-required-scopes": ["factory", "market"],
        "security": [{ "bearerAuth": [] }],
        "responses": {
          "200": {
            "description": "Eigene Importauktionen",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyImportAuction" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/market/my/auctions/export": {
      "get": {
        "tags": ["market"],
        "operationId": "getMyExportAuctions",
        "summary": "Eigene Exportauktionen lesen",
        "x-required-scopes": ["factory", "market"],
        "security": [{ "bearerAuth": [] }],
        "responses": {
          "200": {
            "description": "Eigene Exportauktionen",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MyExportAuction" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/market/import": {
      "get": {
        "tags": ["market"],
        "operationId": "getImportAuctions",
        "summary": "Verfuegbare Importauktionen lesen",
        "x-required-scopes": ["market"],
        "x-access-tier": "patron",
        "security": [{ "bearerAuth": [] }],
        "responses": {
          "200": {
            "description": "Importauktionen",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImportAuction" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/market/export": {
      "get": {
        "tags": ["market"],
        "operationId": "getExportAuctions",
        "summary": "Verfuegbare Exportauktionen lesen",
        "x-required-scopes": ["market"],
        "x-access-tier": "patron",
        "security": [{ "bearerAuth": [] }],
        "responses": {
          "200": {
            "description": "Exportauktionen",
            "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExportAuction" } } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/options/{firmenId}/{option}": {
      "get": {
        "tags": ["options"],
        "operationId": "getFactoryOption",
        "summary": "Firmenoption lesen",
        "x-required-scopes": ["factory", "factory.options"],
        "security": [{ "bearerAuth": [] }],
        "parameters": [
          { "$ref": "#/components/parameters/firmenId" },
          { "$ref": "#/components/parameters/optionSlot" }
        ],
        "responses": {
          "200": {
            "description": "Option-Slot",
            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoryOption" } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    },
    "/factory/options": {
      "post": {
        "tags": ["options"],
        "operationId": "updateFactoryOption",
        "summary": "Firmenoption bearbeiten",
        "description": "Aktualisiert einen Option-Slot 1 bis 10. `apiSecret` wird im Request-Body uebergeben.",
        "x-required-scopes": ["factory", "factory.options.edit"],
        "security": [{ "bearerAuth": [] }],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": { "$ref": "#/components/schemas/FactoryOptionEditRequest" }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Option aktualisiert",
            "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoryOptionEditResponse" } } }
          },
          "400": { "$ref": "#/components/responses/BadRequest" },
          "401": { "$ref": "#/components/responses/Unauthorized" }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API-Key" }
    },
    "responses": {
      "BadRequest": {
        "description": "Fehlerhafte Anfrage oder fehlender Scope",
        "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
      },
      "Unauthorized": {
        "description": "Kein Zugriff auf diese Ressource",
        "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
      },
      "NotFound": {
        "description": "Ressource nicht gefunden",
        "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }
      }
    },
    "parameters": {
      "firmenId": { "name": "firmenId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "MongoDB-ID der Firma" },
      "factoryId": { "name": "factoryId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "MongoDB-ID der Firma" },
      "bankId": { "name": "bankId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "MongoDB-ID des Bankkontos" },
      "limit25": { "name": "limit", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 25 } },
      "offset200": { "name": "offset", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 200 }, "description": "Frontend-Bezeichnung fuer Backend-`skip`" },
      "limit50": { "name": "limit", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 50 } },
      "skip1000": { "name": "skip", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0, "maximum": 1000 } },
      "optionSlot": { "name": "option", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 10 } }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "statusCode": { "type": "integer", "example": 400 },
          "message": {
            "oneOf": [
              { "type": "string" },
              { "type": "array", "items": { "type": "string" } }
            ]
          },
          "error": { "type": "string", "example": "Bad Request" }
        }
      },
      "FactorySummary": {
        "type": "object",
        "properties": {
          "id": { "type": "string", "example": "65f3d08bb8b4c4287c4189d2" },
          "name": { "type": "string", "example": "ACME GmbH" },
          "adLine": { "type": "string", "nullable": true },
          "isOpen": { "type": "boolean", "nullable": true },
          "type": { "type": "string", "nullable": true },
          "address": { "type": "string", "nullable": true }
        },
        "required": ["id", "name"]
      },
      "InventoryItem": {
        "type": "object",
        "properties": {
          "item": { "type": "string" },
          "amount": { "type": "number" },
          "singleWeight": { "type": "number" },
          "totalWeight": { "type": "number" },
          "icon": { "type": "string", "nullable": true }
        },
        "required": ["item", "amount", "singleWeight", "totalWeight", "icon"]
      },
      "InventoryResponse": {
        "type": "object",
        "properties": {
          "totalWeight": { "type": "number" },
          "items": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryItem" } }
        },
        "required": ["totalWeight", "items"]
      },
      "CounterItem": {
        "type": "object",
        "properties": {
          "item": { "type": "string" },
          "price": { "type": "number" },
          "amount": { "type": "number" },
          "singleWeight": { "type": "number" },
          "totalWeight": { "type": "number" },
          "icon": { "type": "string", "nullable": true }
        },
        "required": ["item", "price", "amount", "singleWeight", "totalWeight", "icon"]
      },
      "CounterResponse": {
        "type": "object",
        "properties": {
          "totalWeight": { "type": "number" },
          "items": { "type": "array", "items": { "$ref": "#/components/schemas/CounterItem" } }
        },
        "required": ["totalWeight", "items"]
      },
      "Production": {
        "type": "object",
        "properties": {
          "itemName": { "type": "string" },
          "icon": { "type": "string" },
          "neededItems": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": { "type": "string" },
                "amount": { "type": "number" }
              },
              "required": ["name", "amount"]
            }
          }
        },
        "required": ["itemName", "icon", "neededItems"]
      },
      "BankAccount": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "vban": { "type": "string" },
          "balance": { "type": "number" },
          "note": { "type": "string", "nullable": true }
        },
        "required": ["id", "vban", "balance", "note"]
      },
      "BankTransaction": {
        "type": "object",
        "properties": {
          "senderVban": { "type": "string", "nullable": true },
          "receiverVban": { "type": "string", "nullable": true },
          "reference": { "type": "string", "nullable": true },
          "amount": { "type": "number" },
          "timestamp": { "type": "string", "format": "date-time" }
        },
        "required": ["senderVban", "receiverVban", "reference", "amount", "timestamp"]
      },
      "TransactionsResponse": {
        "type": "object",
        "properties": {
          "totalTransactions": { "type": "number" },
          "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/BankTransaction" } }
        },
        "required": ["totalTransactions", "transactions"]
      },
      "MarketOfferSell": {
        "type": "object",
        "properties": {
          "item": { "type": "string" },
          "pricePerUnit": { "type": "number" },
          "totalPrice": { "type": "number" },
          "availableAmount": { "type": "number" },
          "createdAt": { "type": "string", "format": "date-time" },
          "icon": { "type": "string", "nullable": true }
        },
        "required": ["item", "pricePerUnit", "totalPrice", "availableAmount", "createdAt", "icon"]
      },
      "MarketOfferBuy": {
        "type": "object",
        "properties": {
          "item": { "type": "string" },
          "listPrice": { "type": "number" },
          "pricePerUnit": { "type": "number" },
          "totalPrice": { "type": "number" },
          "availableAmount": { "type": "number" },
          "createdAt": { "type": "string", "format": "date-time" },
          "icon": { "type": "string", "nullable": true }
        },
        "required": ["item", "listPrice", "pricePerUnit", "totalPrice", "availableAmount", "createdAt", "icon"]
      },
      "BuyLogEntry": {
        "type": "object",
        "properties": {
          "seller": { "type": "string" },
          "buyer": { "type": "string" },
          "price": { "type": "number" },
          "discount": { "type": "number", "nullable": true },
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": { "type": "string" },
                "amount": { "type": "number" }
              },
              "required": ["name", "amount"]
            }
          },
          "createdAt": { "type": "string", "format": "date-time" }
        },
        "required": ["seller", "buyer", "price", "discount", "items", "createdAt"]
      },
      "MyImportAuction": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "item": { "type": "string" },
          "bidAmount": { "type": "number" },
          "isLastBidderMe": { "type": "boolean" },
          "auctionEnd": { "type": "string", "format": "date-time" },
          "icon": { "type": "string", "nullable": true }
        },
        "required": ["id", "item", "bidAmount", "isLastBidderMe", "auctionEnd", "icon"]
      },
      "MyExportAuction": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "item": { "type": "string" },
          "bidAmount": { "type": "number" },
          "isLastBidderMe": { "type": "boolean" },
          "auctionEnd": { "type": "string", "format": "date-time" },
          "amount": { "type": "number" },
          "singleWeight": { "type": "number" },
          "totalWeight": { "type": "number" },
          "icon": { "type": "string", "nullable": true },
          "duration": { "type": "number", "nullable": true }
        },
        "required": ["id", "item", "bidAmount", "isLastBidderMe", "auctionEnd", "amount", "singleWeight", "totalWeight", "icon", "duration"]
      },
      "ImportAuction": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "item": { "type": "string" },
          "bidAmount": { "type": "number" },
          "auctionEnd": { "type": "string", "format": "date-time" },
          "icon": { "type": "string", "nullable": true }
        },
        "required": ["id", "item", "bidAmount", "auctionEnd", "icon"]
      },
      "ExportAuction": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "item": { "type": "string" },
          "bidAmount": { "type": "number" },
          "auctionEnd": { "type": "string", "format": "date-time" },
          "amount": { "type": "number" },
          "weight": { "type": "number" },
          "icon": { "type": "string", "nullable": true },
          "duration": { "type": "number" }
        },
        "required": ["id", "item", "bidAmount", "auctionEnd", "amount", "weight", "icon", "duration"]
      },
      "FactoryOption": {
        "type": "object",
        "properties": {
          "title": { "type": "string" },
          "data": { "type": "string" },
          "lastUpdated": { "type": "string", "format": "date-time", "description": "Backend-Feldname; Frontend nennt es `lastUpdate`." }
        },
        "required": ["title", "data", "lastUpdated"]
      },
      "FactoryOptionEditRequest": {
        "type": "object",
        "properties": {
          "apiSecret": { "type": "string" },
          "factoryId": { "type": "string" },
          "option": { "type": "integer", "minimum": 1, "maximum": 10 },
          "title": { "type": "string", "maxLength": 64 },
          "data": { "type": "string", "maxLength": 2400 }
        },
        "required": ["apiSecret", "factoryId", "option", "title", "data"]
      },
      "FactoryOptionEditResponse": {
        "type": "string",
        "example": "option was updated"
      }
    }
  },
  "security": [{ "bearerAuth": [] }]
}