# PUT /v2/bootstrap/{id} Bootstrap-Konfiguration ändern Ändert Name, Variablen und Darstellungsoptionen einer Bootstrap-Konfiguration. version und file bleiben unveränderlich. Variablenänderungen benötigen anschließend eine separate SCSS-Kompilierung. Ein nicht leeres data mit mindestens einem unterstützten Änderungsfeld ist erforderlich. - Operation-ID: put_v2_bootstrap_id - Dokumentation: /docs/api/v2/operations/put-v2-bootstrap-id-fe697f659f86/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: ja - Für Automation freigegeben: nein ## Server Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden. ```json [ { "url": "https://app2.edoobox.com", "description": "edoobox API" } ] ``` ## Authentifizierung Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND). 1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. 2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account. ### Wirksame Security Requirements und vollständige Verfahren ```json { "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Existing edoobox v2 access token. Never substitute API key/secret headers." }, "accountContext": { "type": "apiKey", "in": "header", "name": "edid", "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account." }, "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "_edlogin", "description": "Existing browser login session, with the same permission checks as Bearer authentication." } } } ``` ## Parameter | Name | Ort | Pflicht | Beschreibung | | --- | --- | --- | --- | | id | path | ja | v2 object identifier in the selected account. | | X-Edoobox-If-Revision | header | nein | Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review. | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "id", "in": "path", "required": true, "description": "v2 object identifier in the selected account.", "schema": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "bootstrap_012345abcdef_123456" ] } }, { "name": "X-Edoobox-If-Revision", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "examples": [ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review." } ] ``` ## Anfrage ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": false, "file": false, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 50, "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.", "examples": [ "Example" ], "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 46 }, "version": false, "bs_variables": { "description": "Any JSON value is json_encode stored and json_decode returned; no shape or entry validator.\n\nEncode whole supplied JSON value; database null becomes [] on output, otherwise decode stored JSON to original JSON type.\n\nScope / limitations: Source proves JSON storage, not map or allowed-SCSS-variable restrictions. Compile action has separate consumption.", "x-edoobox-schemaStatus": "reviewed-any-json", "x-edoobox-supportedWireShapes": [ "object", "array", "string", "number", "boolean", "null" ], "examples": [ { "primary": "#336699" }, [] ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 87, "lineStart": 87, "lineEnd": 102, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "1701d9b7a44e1107fcd288291af07144836a46ca9a6e65b32b9c09b6889a8a29", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "bs_variables_dark": { "description": "Any JSON value is json_encode stored and json_decode returned; no shape or entry validator.\n\nEncode whole supplied JSON value; database null becomes [] on output, otherwise decode stored JSON to original JSON type.\n\nScope / limitations: Source proves JSON storage, not map or allowed-SCSS-variable restrictions. Compile action has separate consumption.", "x-edoobox-schemaStatus": "reviewed-any-json", "x-edoobox-supportedWireShapes": [ "object", "array", "string", "number", "boolean", "null" ], "examples": [ { "primary": "#336699" }, [] ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 103, "lineStart": 103, "lineEnd": 118, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "e6aea7d29666887d9d089544e15d24124bfbbaaa555c90e2951c01ee2410d5d0", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "bs_compile": { "not": {}, "description": "No supplied value is accepted here: getter returns strict false and generic API_DATA rejects ED80100. Omit server-maintained field.\n\nGetter always returns strict false, regardless of supplied value.\n\nRuntime preconditions / rejection: Every supplied value on generic POST (and generic PUT when update is allowed) causes ED80100 through API_DATA strict-false check.\n\nScope / limitations: Recommend response-only/readOnly, remove from generic write properties; separate actions can manage it through their own payload logic.", "x-edoobox-schemaStatus": "source-reviewed", "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 119, "lineStart": 119, "lineEnd": 127, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "29d6f03b0256fe79df9446b112cb13febeb1ff6dfdd215d71564e60fc975e614", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "bs_use_wp": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 128, "x-edoobox-canonicalType": "boolean", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ false ] }, "bs_compile_recommended": false, "bs_compile_running": false, "last_change": { "readOnly": true, "description": "Getter returns time() without reading client input. No insert_default/update_default is declared, so omission does not invoke it. Output uses date(c,strtotime(storedValue)), not dQ. ", "x-edoobox-schemaStatus": "source-reviewed-not-writable", "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.", "x-edoobox-ignoredInput": true, "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 166, "lineStart": 166, "lineEnd": 174, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "75e61eb9912d5e5d807513162f5e8e7b913bfb7df0117fd8e9c0d22918378357", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "theme_mode": { "x-edoobox-canonicalType": "string", "description": "Truthy input stored without enum check; falsy input defaults to light. Output recognizes only listed values, falling back to light.\n\nInput value ?: light; output in_array recognized mode else light.\n\nScope / limitations: Do not impose request enum based on recognized output values.", "x-edoobox-recognizedValues": [ "light", "dark" ], "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "dark" ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 175, "lineStart": 175, "lineEnd": 187, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "c26a3640873dbb970a86a34dc377ab7668c89352d62fb19268c48bea544cc1fb", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "expert_mode": { "x-edoobox-canonicalType": "string", "description": "Truthy input stored without enum check; falsy input defaults to simple. Output recognizes only listed values, falling back to simple.\n\nInput value ?: simple; output in_array recognized mode else simple.\n\nScope / limitations: Do not impose request enum based on recognized output values.", "x-edoobox-recognizedValues": [ "simple", "expert" ], "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "expert" ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 188, "lineStart": 188, "lineEnd": 200, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "9c8f7963bf068fc25e03b471f35dcb5075b192a8e185d64afa27239e49cbf6a1", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "minProperties": 1, "x-edoobox-readOnlyFields": [ "file", "version", "bs_compile_recommended", "bs_compile_running" ], "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns." }, "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "bootstrap_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "request": { "summary": "Bootstrap-Konfiguration ändern", "value": { "data": { "name": "Sommerdesign" } } } } } } } ``` ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "data.id bezeichnet das Objekt, data.update zeigt an, ob sich ein Feld geändert hat.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "bootstrap_012345abcdef_123456", "update": true } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^bootstrap_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "bootstrap_012345abcdef_123456" ] }, "update": { "type": "boolean" } }, "additionalProperties": true, "required": [ "id", "update" ] }, "type": { "type": "string" } }, "additionalProperties": true } } }, "headers": { "X-Edoobox-Revision": { "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "description": "Rotated account revision supplied for the next action in one reviewed sequence." } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "409": { "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED40901", "error_code": "mutation_revision_conflict" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } }, "503": { "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.", "headers": { "Retry-After": { "schema": { "type": "integer", "const": 1 } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED50301", "error_code": "mutation_revision_busy" } } } } } ``` ## Aufrufbeispiele Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder. ### cURL ```sh # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. # cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${PATH_ID:?PATH_ID setzen}" cat > payload.json <<'EDOOBOX_JSON_EXAMPLE' { "data": { "name": "Sommerdesign" } } EDOOBOX_JSON_EXAMPLE curl --request 'PUT' \ --url "${API_ORIGIN%/}"'/v2/bootstrap/'"${PATH_ID}"'' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \ --header 'Content-Type: application/json' \ --data-binary '@payload.json' ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. // Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/bootstrap/{id}"; path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID"))); const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); const headers = {}; headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH"); headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT"); headers['Content-Type'] = "application/json"; const body = JSON.stringify({ "data": { "name": "Sommerdesign" } }); const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' }); const text = await response.text(); console.log(response.status, text); // HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ### Python ```python # Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. # Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen. import os import urllib.parse import urllib.request import urllib.error path = "/v2/bootstrap/{id}" path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe="")) url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] headers["Content-Type"] = "application/json" body = "{\"data\":{\"name\":\"Sommerdesign\"}}".encode("utf-8") # Redirects nicht automatisch verfolgen. class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None request = urllib.request.Request(url, headers=headers, method="PUT", data=body) try: response = urllib.request.build_opener(NoRedirect).open(request, timeout=30) except urllib.error.HTTPError as error: response = error print(response.status, response.read().decode("utf-8", errors="replace")) # HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen. ``` ## Vollständige Operationsdefinition und edoobox-Hinweise Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag. ```json { "operationId": "put_v2_bootstrap_id", "summary": "Bootstrap-Konfiguration ändern", "description": "Ändert Name, Variablen und Darstellungsoptionen einer Bootstrap-Konfiguration. version und file bleiben unveränderlich. Variablenänderungen benötigen anschließend eine separate SCSS-Kompilierung. Ein nicht leeres data mit mindestens einem unterstützten Änderungsfeld ist erforderlich.", "tags": [ "bootstrap" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "v2 object identifier in the selected account.", "schema": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "bootstrap_012345abcdef_123456" ] } }, { "name": "X-Edoobox-If-Revision", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$", "examples": [ "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review." } ], "responses": { "200": { "description": "data.id bezeichnet das Objekt, data.update zeigt an, ob sich ein Feld geändert hat.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "id": "bootstrap_012345abcdef_123456", "update": true } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^bootstrap_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.", "examples": [ "bootstrap_012345abcdef_123456" ] }, "update": { "type": "boolean" } }, "additionalProperties": true, "required": [ "id", "update" ] }, "type": { "type": "string" } }, "additionalProperties": true } } }, "headers": { "X-Edoobox-Revision": { "schema": { "type": "string", "pattern": "^[a-f0-9]{32}$" }, "description": "Rotated account revision supplied for the next action in one reviewed sequence." } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "example": { "success": false, "error": "ED40006" } } } }, "401": { "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.", "content": { "application/json": { "example": { "success": false, "error": "ED40103" } } } }, "402": { "description": "Missing/invalid action data or subscription/operation restriction.", "content": { "application/json": { "example": { "success": false, "error": "ED80100" } } } }, "403": { "description": "Permission denied. Browser CORS rejection may have an empty body.", "content": { "application/json": { "example": { "success": false, "error": "ED40340" } } } }, "404": { "description": "Unknown resource/action or unsupported method.", "content": { "application/json": { "example": { "success": false, "error": "ED80019" } } } }, "409": { "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED40901", "error_code": "mutation_revision_conflict" } } } }, "422": { "description": "Validation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED80020" } } } }, "429": { "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.", "content": { "application/json": { "example": { "success": false, "error": "ED42902" } } }, "headers": { "Retry-After": { "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.", "schema": { "type": "string", "examples": [ "30" ] } } } }, "502": { "description": "Server-side operation failed.", "content": { "application/json": { "example": { "success": false, "error": "ED50201" } } } }, "503": { "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.", "headers": { "Retry-After": { "schema": { "type": "integer", "const": 1 } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "error": "ED50301", "error_code": "mutation_revision_busy" } } } } }, "x-edoobox-mutates-state": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": false, "file": false, "name": { "x-edoobox-canonicalType": "string", "x-edoobox-maxStoredLength": 50, "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.", "examples": [ "Example" ], "x-edoobox-requiredOnCreate": true, "x-edoobox-sourceLine": 46 }, "version": false, "bs_variables": { "description": "Any JSON value is json_encode stored and json_decode returned; no shape or entry validator.\n\nEncode whole supplied JSON value; database null becomes [] on output, otherwise decode stored JSON to original JSON type.\n\nScope / limitations: Source proves JSON storage, not map or allowed-SCSS-variable restrictions. Compile action has separate consumption.", "x-edoobox-schemaStatus": "reviewed-any-json", "x-edoobox-supportedWireShapes": [ "object", "array", "string", "number", "boolean", "null" ], "examples": [ { "primary": "#336699" }, [] ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 87, "lineStart": 87, "lineEnd": 102, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "1701d9b7a44e1107fcd288291af07144836a46ca9a6e65b32b9c09b6889a8a29", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "bs_variables_dark": { "description": "Any JSON value is json_encode stored and json_decode returned; no shape or entry validator.\n\nEncode whole supplied JSON value; database null becomes [] on output, otherwise decode stored JSON to original JSON type.\n\nScope / limitations: Source proves JSON storage, not map or allowed-SCSS-variable restrictions. Compile action has separate consumption.", "x-edoobox-schemaStatus": "reviewed-any-json", "x-edoobox-supportedWireShapes": [ "object", "array", "string", "number", "boolean", "null" ], "examples": [ { "primary": "#336699" }, [] ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 103, "lineStart": 103, "lineEnd": 118, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "e6aea7d29666887d9d089544e15d24124bfbbaaa555c90e2951c01ee2410d5d0", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "bs_compile": { "not": {}, "description": "No supplied value is accepted here: getter returns strict false and generic API_DATA rejects ED80100. Omit server-maintained field.\n\nGetter always returns strict false, regardless of supplied value.\n\nRuntime preconditions / rejection: Every supplied value on generic POST (and generic PUT when update is allowed) causes ED80100 through API_DATA strict-false check.\n\nScope / limitations: Recommend response-only/readOnly, remove from generic write properties; separate actions can manage it through their own payload logic.", "x-edoobox-schemaStatus": "source-reviewed", "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 119, "lineStart": 119, "lineEnd": 127, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "29d6f03b0256fe79df9446b112cb13febeb1ff6dfdd215d71564e60fc975e614", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "bs_use_wp": { "x-edoobox-schemaStatus": "source-inferred", "x-edoobox-sourceLine": 128, "x-edoobox-canonicalType": "boolean", "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.", "examples": [ false ] }, "bs_compile_recommended": false, "bs_compile_running": false, "last_change": { "readOnly": true, "description": "Getter returns time() without reading client input. No insert_default/update_default is declared, so omission does not invoke it. Output uses date(c,strtotime(storedValue)), not dQ. ", "x-edoobox-schemaStatus": "source-reviewed-not-writable", "x-edoobox-clientRestriction": "Omit server-generated or unsupported input fields; runtime behavior is described separately.", "x-edoobox-ignoredInput": true, "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 166, "lineStart": 166, "lineEnd": 174, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "75e61eb9912d5e5d807513162f5e8e7b913bfb7df0117fd8e9c0d22918378357", "reason": "Structure getter, output setter and field flags." }, { "file": "application/helpers/edooboxhelp_helper.php", "line": 11629, "lineStart": 11629, "lineEnd": 11639, "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e", "spanSha256": "a6fb9b218b0bdd5d6bc05d62034b2a1096d3279599319f181e03bc4a6fe7d83a", "reason": "dQ returns ISO date-time or false from stored time." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "theme_mode": { "x-edoobox-canonicalType": "string", "description": "Truthy input stored without enum check; falsy input defaults to light. Output recognizes only listed values, falling back to light.\n\nInput value ?: light; output in_array recognized mode else light.\n\nScope / limitations: Do not impose request enum based on recognized output values.", "x-edoobox-recognizedValues": [ "light", "dark" ], "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "dark" ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 175, "lineStart": 175, "lineEnd": 187, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "c26a3640873dbb970a86a34dc377ab7668c89352d62fb19268c48bea544cc1fb", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] }, "expert_mode": { "x-edoobox-canonicalType": "string", "description": "Truthy input stored without enum check; falsy input defaults to simple. Output recognizes only listed values, falling back to simple.\n\nInput value ?: simple; output in_array recognized mode else simple.\n\nScope / limitations: Do not impose request enum based on recognized output values.", "x-edoobox-recognizedValues": [ "simple", "expert" ], "x-edoobox-schemaStatus": "source-reviewed", "examples": [ "expert" ], "x-edoobox-contractSource": [ { "file": "application/models/v2/Bootstrap.php", "line": 188, "lineStart": 188, "lineEnd": 200, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "9c8f7963bf068fc25e03b471f35dcb5075b192a8e185d64afa27239e49cbf6a1", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Bootstrap.php", "line": 213, "lineStart": 213, "lineEnd": 244, "sha256": "336883443f0523fd196dc70b746a5323dbc9b48c5f0f7e4b13feb68b32a1930d", "spanSha256": "f4438476c2439b12f496bf485284ce3f980679fa045059af724d73f10ffa52c5", "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct." }, { "file": "docs/openapi/reviews/domain-fields.json", "line": 1, "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.", "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667" } ] } }, "additionalProperties": true, "description": "Source-declared fields; action-specific and account validation still apply.", "minProperties": 1, "x-edoobox-readOnlyFields": [ "file", "version", "bs_compile_recommended", "bs_compile_running" ], "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns." }, "id": { "type": "string", "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$", "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.", "examples": [ "bootstrap_012345abcdef_123456" ] } }, "additionalProperties": true, "required": [ "data" ] }, "examples": { "request": { "summary": "Bootstrap-Konfiguration ändern", "value": { "data": { "name": "Sommerdesign" } } } } } } }, "x-edoobox-runtimeMutationGuard": true, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/07-layout-files.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Bootstrap.php", "method": "updateBootstrap", "line": 230 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": false, "x-edoobox-safeForAutomation": false, "x-edoobox-permission": { "resource": "bootstrap", "short": "boot", "checkedByDispatcher": true, "levels": [ 3, 4 ], "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope." } } ```