# GET /v2/widget Design-Widget auflisten Liest konfigurierte Widgets einer Designvorlage samt Reihenfolge, HTML-ID und aufbereiteter config. config.data enthält die für den Widgettyp und das Konto gültigen Einstellungen. Ohne ID wird eine gefilterte und paginierte Sammlung zurückgegeben. fields, filter, order und limit steuern die Auswahl; data ist standardmäßig nach v2-ID indiziert oder mit response_type=array eine Liste. Zusätzlich ist ein filter-Eintrag mit property=template erforderlich, auch bei einer Pfad-ID; der separate template-Querywert wird nur von /list/LUT gelesen. - Operation-ID: get_v2_widget - Dokumentation: /docs/api/v2/operations/get-v2-widget-3e68627caf54/ - OpenAPI-Version: 3.2.1 - Vollständige Spezifikation: /docs/api/v2/openapi.json - Dokumentationsstatus: reviewed - Ändert Zustand: nein, gemäss Annotation - Für Automation freigegeben: ja, siehe Voraussetzungen ## 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 | | --- | --- | --- | --- | | fields | query | nein | JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | filter | query | ja | Erforderlich: ein template-Filter mit einem gültigen Vorlagenschlüssel a bis s; design kann die Sammlung auf ein Buchungsdesign begrenzen. | | limit | query | nein | JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | order | query | nein | JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it. | | response_type | query | nein | Controls generic collection representation; default is an ID-keyed object. | | language | header | nein | Account language code, where the resource supports setLanguage(). | ### Vollständige wirksame Parameterdefinitionen ```json [ { "name": "fields", "in": "query", "required": false, "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "examples": [ [ "id" ] ] }, "example": [ "id" ] } } }, { "name": "filter", "in": "query", "required": true, "description": "Erforderlich: ein template-Filter mit einem gültigen Vorlagenschlüssel a bis s; design kann die Sammlung auf ein Buchungsdesign begrenzen.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": {} }, "additionalProperties": true, "required": [ "property", "value" ] } }, "example": [ { "property": "template", "value": "a" }, { "property": "design", "value": "design_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "maximum": 2000, "default": 100 } }, "examples": [ { "start": 0, "reply": 25 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "order", "in": "query", "required": false, "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "type": "string", "enum": [ "ASC", "DESC" ] } }, "additionalProperties": true }, "examples": [ [ { "property": "id", "value": "ASC" } ] ] }, "example": [ { "property": "id", "value": "ASC" } ] } } }, { "name": "response_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "array", "object" ], "examples": [ "array" ] }, "description": "Controls generic collection representation; default is an ID-keyed object." }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ] ``` ## Anfrage Kein Request Body deklariert. ## Antworten HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei. ```json { "200": { "description": "Sammlung ausgewählter Felder in data; zusätzlich limit mit start, reply und total.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "widget_012345abcdef_123456": { "id": "widget_012345abcdef_123456" } }, "limit": { "start": 0, "reply": 100, "total": 1 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^widget_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "widget_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID." }, "design": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 38, "anyOf": [ { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "template": { "type": "string", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 52, "lineStart": 52, "lineEnd": 69, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "d125dfff1f7e616ba3a9089e77e4c41634b8a344f49db1807d72c020939f7e01", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "Before-insert validates selected template/key config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing and capability/Bootstrap filters." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "key": { "type": "string", "description": "Native Structure setter returns aQ(widget_nr).", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 70, "lineEnd": 82, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "Key getter exists, but POST acceptance additionally validates the original untruncated key against the exact runtime LUT; generic PUT marks key immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "order": { "type": "integer", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 84, "lineStart": 84, "lineEnd": 93, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "f6b8175dcaf1a404ef565db2fbe94467caba18bc5841242e61f417f1e096675d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 115, "lineStart": 115, "lineEnd": 136, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "523f2f60112cff2fd4e258096578e34669b9d5639e75fad58fe989b6b5b63425", "reason": "func delegates to _putWidgetOrder" }, { "file": "application/models/v2/Widgetfunc.php", "line": 766, "lineStart": 766, "lineEnd": 823, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "9adbee2fe3af3980de9e2c50bc82e91aaae3d60fbdfcfcc8499d64f9197e28dc", "reason": "Actual reorder; no input range rejection." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "html_id": { "type": "string", "description": "Native Structure setter returns aQ(widget_id), including the generated id.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 94, "lineEnd": 102, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "The input getter is superseded by before-insert generation; response setter uses aQ and generic PUT is immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "config": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "maxItems": 0 } ] }, "width": { "type": "object", "additionalProperties": {} }, "height": { "type": "object", "additionalProperties": {} }, "margin": { "type": "object", "additionalProperties": {} }, "visible": { "type": "object", "properties": { "type": { "type": "integer" }, "showpho": { "x-edoobox-canonicalType": "boolean", "description": "Returned from persisted widget showpho directly; current writes normalize bool but legacy stored types are not recast here." } }, "required": [ "type", "showpho" ], "additionalProperties": false } }, "required": [ "name", "data", "width", "height", "margin", "visible" ], "additionalProperties": false, "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 104, "lineStart": 104, "lineEnd": 116, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "8c74e6f4c65610843796bd8bb20351c22fab3f754a8c80b28294eab9bd1b6fa9", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 151, "lineStart": 151, "lineEnd": 196, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "284bae8394c5dfde4b955795281105d8eb14e50ca5b9eb0a858250050ae921f5", "reason": "func delegates to _putWidgetConfig" }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "POST before-insert delegates to config validator." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineStart": 210, "lineEnd": 578, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "4256de6c9e572438e9ee93564e1c0fd3e3de8130a46717bbdbd9d5bbc6dd2954", "reason": "Complete config validator: envelope copying, dynamic data dispatch, rejection, normalization and persistence." }, { "file": "application/models/v2/Widgetfunc.php", "line": 13, "lineStart": 13, "lineEnd": 38, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "cc205b761bed5fe381e50ce4ea4852f48d4c71fab9b9024aa5d694c05727ecbc", "reason": "Visibility-tag public-ID objects and legacy raw-ID fallback; publish only public IDs." }, { "file": "application/models/v2/Widgetfunc.php", "line": 580, "lineStart": 580, "lineEnd": 603, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "c1ece99a73d47b79be3af4614b18c25a2a6da2b8c906819f48112a38ad1b9db2", "reason": "Promo price normalization to positive finite decimals." }, { "file": "application/models/v2/Widget.php", "line": 213, "lineStart": 213, "lineEnd": 329, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "9fdfd0cde04c0a48fa910b0451939838cce8d6946711064e013fc4f8588389ce", "reason": "Actual GET replaces empty declared setter and returns normalized config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing, capabilities and Bootstrap filtering determine dynamic definitions." }, { "file": "application/models/Widgetmanager.php", "line": 7282, "lineStart": 7282, "lineEnd": 7380, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "6c1613bbc268dca6e138f967dcefca91af35b6f5400bfdaa2c5f9ff7d19379f7", "reason": "Concrete textb definition proves example keys and language-dependent inputs." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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, "required": [ "id" ] } }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^widget_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "widget_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID." }, "design": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 38, "anyOf": [ { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "template": { "type": "string", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 52, "lineStart": 52, "lineEnd": 69, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "d125dfff1f7e616ba3a9089e77e4c41634b8a344f49db1807d72c020939f7e01", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "Before-insert validates selected template/key config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing and capability/Bootstrap filters." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "key": { "type": "string", "description": "Native Structure setter returns aQ(widget_nr).", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 70, "lineEnd": 82, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "Key getter exists, but POST acceptance additionally validates the original untruncated key against the exact runtime LUT; generic PUT marks key immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "order": { "type": "integer", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 84, "lineStart": 84, "lineEnd": 93, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "f6b8175dcaf1a404ef565db2fbe94467caba18bc5841242e61f417f1e096675d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 115, "lineStart": 115, "lineEnd": 136, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "523f2f60112cff2fd4e258096578e34669b9d5639e75fad58fe989b6b5b63425", "reason": "func delegates to _putWidgetOrder" }, { "file": "application/models/v2/Widgetfunc.php", "line": 766, "lineStart": 766, "lineEnd": 823, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "9adbee2fe3af3980de9e2c50bc82e91aaae3d60fbdfcfcc8499d64f9197e28dc", "reason": "Actual reorder; no input range rejection." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "html_id": { "type": "string", "description": "Native Structure setter returns aQ(widget_id), including the generated id.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 94, "lineEnd": 102, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "The input getter is superseded by before-insert generation; response setter uses aQ and generic PUT is immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "config": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "maxItems": 0 } ] }, "width": { "type": "object", "additionalProperties": {} }, "height": { "type": "object", "additionalProperties": {} }, "margin": { "type": "object", "additionalProperties": {} }, "visible": { "type": "object", "properties": { "type": { "type": "integer" }, "showpho": { "x-edoobox-canonicalType": "boolean", "description": "Returned from persisted widget showpho directly; current writes normalize bool but legacy stored types are not recast here." } }, "required": [ "type", "showpho" ], "additionalProperties": false } }, "required": [ "name", "data", "width", "height", "margin", "visible" ], "additionalProperties": false, "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 104, "lineStart": 104, "lineEnd": 116, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "8c74e6f4c65610843796bd8bb20351c22fab3f754a8c80b28294eab9bd1b6fa9", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 151, "lineStart": 151, "lineEnd": 196, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "284bae8394c5dfde4b955795281105d8eb14e50ca5b9eb0a858250050ae921f5", "reason": "func delegates to _putWidgetConfig" }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "POST before-insert delegates to config validator." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineStart": 210, "lineEnd": 578, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "4256de6c9e572438e9ee93564e1c0fd3e3de8130a46717bbdbd9d5bbc6dd2954", "reason": "Complete config validator: envelope copying, dynamic data dispatch, rejection, normalization and persistence." }, { "file": "application/models/v2/Widgetfunc.php", "line": 13, "lineStart": 13, "lineEnd": 38, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "cc205b761bed5fe381e50ce4ea4852f48d4c71fab9b9024aa5d694c05727ecbc", "reason": "Visibility-tag public-ID objects and legacy raw-ID fallback; publish only public IDs." }, { "file": "application/models/v2/Widgetfunc.php", "line": 580, "lineStart": 580, "lineEnd": 603, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "c1ece99a73d47b79be3af4614b18c25a2a6da2b8c906819f48112a38ad1b9db2", "reason": "Promo price normalization to positive finite decimals." }, { "file": "application/models/v2/Widget.php", "line": 213, "lineStart": 213, "lineEnd": 329, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "9fdfd0cde04c0a48fa910b0451939838cce8d6946711064e013fc4f8588389ce", "reason": "Actual GET replaces empty declared setter and returns normalized config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing, capabilities and Bootstrap filtering determine dynamic definitions." }, { "file": "application/models/Widgetmanager.php", "line": 7282, "lineStart": 7282, "lineEnd": 7380, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "6c1613bbc268dca6e138f967dcefca91af35b6f5400bfdaa2c5f9ff7d19379f7", "reason": "Concrete textb definition proves example keys and language-dependent inputs." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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, "required": [ "id" ] } } ], "description": "data ist standardmäßig nach öffentlicher ID indiziert; response_type=array liefert eine Liste. Eine leere Sammlung kann [] sein." }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "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" } } } }, "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" } } } } } ``` ## 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. # filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${QUERY_FILTER:?QUERY_FILTER setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/widget' \ --url-query 'filter='"${QUERY_FILTER}" \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" ``` ### JavaScript (Node.js) ```javascript // Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich. // filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert. const required = (name) => { const value = process.env[name]; if (!value) throw new Error(`Set ${name}`); return value; }; let path = "/v2/widget"; const origin = required('API_ORIGIN'); const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path); url.searchParams.append("filter", required("QUERY_FILTER")); const headers = {}; headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH"); headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT"); const response = await fetch(url, { method: "GET", headers, 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. # filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert. import os import urllib.parse import urllib.request import urllib.error path = "/v2/widget" url = os.environ["API_ORIGIN"].rstrip("/") + path url += "?" + urllib.parse.urlencode([("filter", os.environ["QUERY_FILTER"])]) headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] # 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="GET") 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": "get_v2_widget", "summary": "Design-Widget auflisten", "description": "Liest konfigurierte Widgets einer Designvorlage samt Reihenfolge, HTML-ID und aufbereiteter config. config.data enthält die für den Widgettyp und das Konto gültigen Einstellungen. Ohne ID wird eine gefilterte und paginierte Sammlung zurückgegeben. fields, filter, order und limit steuern die Auswahl; data ist standardmäßig nach v2-ID indiziert oder mit response_type=array eine Liste. Zusätzlich ist ein filter-Eintrag mit property=template erforderlich, auch bei einer Pfad-ID; der separate template-Querywert wird nur von /list/LUT gelesen.", "tags": [ "widget" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "fields", "in": "query", "required": false, "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "examples": [ [ "id" ] ] }, "example": [ "id" ] } } }, { "name": "filter", "in": "query", "required": true, "description": "Erforderlich: ein template-Filter mit einem gültigen Vorlagenschlüssel a bis s; design kann die Sammlung auf ein Buchungsdesign begrenzen.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": {} }, "additionalProperties": true, "required": [ "property", "value" ] } }, "example": [ { "property": "template", "value": "a" }, { "property": "design", "value": "design_012345abcdef_123456" } ] } } }, { "name": "limit", "in": "query", "required": false, "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "default": 0 }, "reply": { "type": "integer", "maximum": 2000, "default": 100 } }, "examples": [ { "start": 0, "reply": 25 } ] }, "example": { "start": 0, "reply": 25 } } } }, { "name": "order", "in": "query", "required": false, "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string" }, "value": { "type": "string", "enum": [ "ASC", "DESC" ] } }, "additionalProperties": true }, "examples": [ [ { "property": "id", "value": "ASC" } ] ] }, "example": [ { "property": "id", "value": "ASC" } ] } } }, { "name": "response_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "array", "object" ], "examples": [ "array" ] }, "description": "Controls generic collection representation; default is an ID-keyed object." }, { "name": "language", "in": "header", "required": false, "description": "Account language code, where the resource supports setLanguage().", "schema": { "type": "string", "examples": [ "de" ] } } ], "responses": { "200": { "description": "Sammlung ausgewählter Felder in data; zusätzlich limit mit start, reply und total.", "content": { "application/json": { "example": { "success": true, "error": false, "data": { "widget_012345abcdef_123456": { "id": "widget_012345abcdef_123456" } }, "limit": { "start": 0, "reply": 100, "total": 1 } }, "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "error_code": { "type": "string" }, "data": { "oneOf": [ { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^widget_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "widget_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID." }, "design": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 38, "anyOf": [ { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "template": { "type": "string", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 52, "lineStart": 52, "lineEnd": 69, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "d125dfff1f7e616ba3a9089e77e4c41634b8a344f49db1807d72c020939f7e01", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "Before-insert validates selected template/key config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing and capability/Bootstrap filters." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "key": { "type": "string", "description": "Native Structure setter returns aQ(widget_nr).", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 70, "lineEnd": 82, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "Key getter exists, but POST acceptance additionally validates the original untruncated key against the exact runtime LUT; generic PUT marks key immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "order": { "type": "integer", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 84, "lineStart": 84, "lineEnd": 93, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "f6b8175dcaf1a404ef565db2fbe94467caba18bc5841242e61f417f1e096675d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 115, "lineStart": 115, "lineEnd": 136, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "523f2f60112cff2fd4e258096578e34669b9d5639e75fad58fe989b6b5b63425", "reason": "func delegates to _putWidgetOrder" }, { "file": "application/models/v2/Widgetfunc.php", "line": 766, "lineStart": 766, "lineEnd": 823, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "9adbee2fe3af3980de9e2c50bc82e91aaae3d60fbdfcfcc8499d64f9197e28dc", "reason": "Actual reorder; no input range rejection." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "html_id": { "type": "string", "description": "Native Structure setter returns aQ(widget_id), including the generated id.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 94, "lineEnd": 102, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "The input getter is superseded by before-insert generation; response setter uses aQ and generic PUT is immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "config": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "maxItems": 0 } ] }, "width": { "type": "object", "additionalProperties": {} }, "height": { "type": "object", "additionalProperties": {} }, "margin": { "type": "object", "additionalProperties": {} }, "visible": { "type": "object", "properties": { "type": { "type": "integer" }, "showpho": { "x-edoobox-canonicalType": "boolean", "description": "Returned from persisted widget showpho directly; current writes normalize bool but legacy stored types are not recast here." } }, "required": [ "type", "showpho" ], "additionalProperties": false } }, "required": [ "name", "data", "width", "height", "margin", "visible" ], "additionalProperties": false, "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 104, "lineStart": 104, "lineEnd": 116, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "8c74e6f4c65610843796bd8bb20351c22fab3f754a8c80b28294eab9bd1b6fa9", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 151, "lineStart": 151, "lineEnd": 196, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "284bae8394c5dfde4b955795281105d8eb14e50ca5b9eb0a858250050ae921f5", "reason": "func delegates to _putWidgetConfig" }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "POST before-insert delegates to config validator." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineStart": 210, "lineEnd": 578, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "4256de6c9e572438e9ee93564e1c0fd3e3de8130a46717bbdbd9d5bbc6dd2954", "reason": "Complete config validator: envelope copying, dynamic data dispatch, rejection, normalization and persistence." }, { "file": "application/models/v2/Widgetfunc.php", "line": 13, "lineStart": 13, "lineEnd": 38, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "cc205b761bed5fe381e50ce4ea4852f48d4c71fab9b9024aa5d694c05727ecbc", "reason": "Visibility-tag public-ID objects and legacy raw-ID fallback; publish only public IDs." }, { "file": "application/models/v2/Widgetfunc.php", "line": 580, "lineStart": 580, "lineEnd": 603, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "c1ece99a73d47b79be3af4614b18c25a2a6da2b8c906819f48112a38ad1b9db2", "reason": "Promo price normalization to positive finite decimals." }, { "file": "application/models/v2/Widget.php", "line": 213, "lineStart": 213, "lineEnd": 329, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "9fdfd0cde04c0a48fa910b0451939838cce8d6946711064e013fc4f8588389ce", "reason": "Actual GET replaces empty declared setter and returns normalized config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing, capabilities and Bootstrap filtering determine dynamic definitions." }, { "file": "application/models/Widgetmanager.php", "line": 7282, "lineStart": 7282, "lineEnd": 7380, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "6c1613bbc268dca6e138f967dcefca91af35b6f5400bfdaa2c5f9ff7d19379f7", "reason": "Concrete textb definition proves example keys and language-dependent inputs." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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, "required": [ "id" ] } }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^widget_[a-f0-9]{12}_-?[0-9]+$", "examples": [ "widget_012345abcdef_123456" ], "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID." }, "design": { "description": "Response field from the resource Structure; dynamic values remain unconstrained.", "x-edoobox-sourceLine": 38, "anyOf": [ { "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": [ "design_012345abcdef_123456" ] }, { "const": false }, { "type": "null" } ] }, "template": { "type": "string", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 52, "lineStart": 52, "lineEnd": 69, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "d125dfff1f7e616ba3a9089e77e4c41634b8a344f49db1807d72c020939f7e01", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "Before-insert validates selected template/key config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing and capability/Bootstrap filters." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "key": { "type": "string", "description": "Native Structure setter returns aQ(widget_nr).", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 70, "lineEnd": 82, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "Key getter exists, but POST acceptance additionally validates the original untruncated key against the exact runtime LUT; generic PUT marks key immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "order": { "type": "integer", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 84, "lineStart": 84, "lineEnd": 93, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "f6b8175dcaf1a404ef565db2fbe94467caba18bc5841242e61f417f1e096675d", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 115, "lineStart": 115, "lineEnd": 136, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "523f2f60112cff2fd4e258096578e34669b9d5639e75fad58fe989b6b5b63425", "reason": "func delegates to _putWidgetOrder" }, { "file": "application/models/v2/Widgetfunc.php", "line": 766, "lineStart": 766, "lineEnd": 823, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "9adbee2fe3af3980de9e2c50bc82e91aaae3d60fbdfcfcc8499d64f9197e28dc", "reason": "Actual reorder; no input range rejection." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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" } ] }, "html_id": { "type": "string", "description": "Native Structure setter returns aQ(widget_id), including the generated id.", "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 94, "lineEnd": 102, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "The input getter is superseded by before-insert generation; response setter uses aQ and generic PUT is immutable." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineEnd": 145, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "reason": "POST uses the generic insert pipeline with the actual Widget before-insert hook." }, { "file": "application/models/v2/API_DATA.php", "line": 1341, "lineEnd": 1352, "sha256": "c0e15d26a7a4f3fb3c25e35557d4420ad395b2af3925caec292de08e32ebf44c", "reason": "Single insert runs the concrete insert_func_before result immediately before the query-builder insert." }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineEnd": 113, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "Always generates widget_id as wdg + original key + uniqid, then validates the original key and config." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineEnd": 230, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "reason": "The actual key must exist in the account/template/style-specific Widgetmanager result; missing LUT key throws ED80100." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineEnd": 689, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "reason": "Builds template-specific and common widget LUTs and applies account membership and Bootstrap53/style filters. Allowed keys are runtime-dependent, not arbitrary length-limited text." }, { "file": "docs/openapi/reviews/widget-insert-fields.json", "line": 1, "sha256": "4bc713549d08e5eb8c5a027face2bb80313a1a8ec470dcb2bb0d957d8d061215", "reason": "Independent supplemental field review; excluded from the historical184-field baseline count." } ] }, "config": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "maxItems": 0 } ] }, "width": { "type": "object", "additionalProperties": {} }, "height": { "type": "object", "additionalProperties": {} }, "margin": { "type": "object", "additionalProperties": {} }, "visible": { "type": "object", "properties": { "type": { "type": "integer" }, "showpho": { "x-edoobox-canonicalType": "boolean", "description": "Returned from persisted widget showpho directly; current writes normalize bool but legacy stored types are not recast here." } }, "required": [ "type", "showpho" ], "additionalProperties": false } }, "required": [ "name", "data", "width", "height", "margin", "visible" ], "additionalProperties": false, "x-edoobox-contractSource": [ { "file": "application/models/v2/Widget.php", "line": 104, "lineStart": 104, "lineEnd": 116, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "8c74e6f4c65610843796bd8bb20351c22fab3f754a8c80b28294eab9bd1b6fa9", "reason": "Structure getter, output setter and field flags." }, { "file": "application/models/v2/Widgetfunc.php", "line": 151, "lineStart": 151, "lineEnd": 196, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "284bae8394c5dfde4b955795281105d8eb14e50ca5b9eb0a858250050ae921f5", "reason": "func delegates to _putWidgetConfig" }, { "file": "application/models/v2/Widgetfunc.php", "line": 107, "lineStart": 107, "lineEnd": 112, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "f4e1a72ce7b8315585fac1f8865c7c8e095d07a2bf68913cd6871947bc4fed3e", "reason": "POST before-insert delegates to config validator." }, { "file": "application/models/v2/Widgetfunc.php", "line": 210, "lineStart": 210, "lineEnd": 578, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "4256de6c9e572438e9ee93564e1c0fd3e3de8130a46717bbdbd9d5bbc6dd2954", "reason": "Complete config validator: envelope copying, dynamic data dispatch, rejection, normalization and persistence." }, { "file": "application/models/v2/Widgetfunc.php", "line": 13, "lineStart": 13, "lineEnd": 38, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "cc205b761bed5fe381e50ce4ea4852f48d4c71fab9b9024aa5d694c05727ecbc", "reason": "Visibility-tag public-ID objects and legacy raw-ID fallback; publish only public IDs." }, { "file": "application/models/v2/Widgetfunc.php", "line": 580, "lineStart": 580, "lineEnd": 603, "sha256": "93543ac4d3f60d425ce4e63837a1ca1dc9ed57baad776ccb7b76d448d475837a", "spanSha256": "c1ece99a73d47b79be3af4614b18c25a2a6da2b8c906819f48112a38ad1b9db2", "reason": "Promo price normalization to positive finite decimals." }, { "file": "application/models/v2/Widget.php", "line": 213, "lineStart": 213, "lineEnd": 329, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "9fdfd0cde04c0a48fa910b0451939838cce8d6946711064e013fc4f8588389ce", "reason": "Actual GET replaces empty declared setter and returns normalized config." }, { "file": "application/models/Widgetmanager.php", "line": 543, "lineStart": 543, "lineEnd": 694, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "1fec1424aa25e05a811140d656c1955b890bbb6db6b23ffcb7e318c394fc402c", "reason": "Template routing, capabilities and Bootstrap filtering determine dynamic definitions." }, { "file": "application/models/Widgetmanager.php", "line": 7282, "lineStart": 7282, "lineEnd": 7380, "sha256": "f1350720149701f6749556a0af52a5979d371c0a845df25a76852343a0f95c48", "spanSha256": "6c1613bbc268dca6e138f967dcefca91af35b6f5400bfdaa2c5f9ff7d19379f7", "reason": "Concrete textb definition proves example keys and language-dependent inputs." }, { "file": "application/models/v2/Widget.php", "line": 139, "lineStart": 139, "lineEnd": 162, "sha256": "425ea689bf11c52a3ab73e5f4c44acf48b4b6d860a7b88193e3d24b891273cde", "spanSha256": "c2cae8eb38a7f944da1d9568bbcb3ed1f5e39fdc42507ec188464bb4bd5ab5b5", "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, "required": [ "id" ] } } ], "description": "data ist standardmäßig nach öffentlicher ID indiziert; response_type=array liefert eine Liste. Eine leere Sammlung kann [] sein." }, "type": { "type": "string" } }, "additionalProperties": true } } } }, "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" } } } }, "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" } } } } }, "x-edoobox-mutates-state": false, "x-edoobox-runtimeMutationGuard": false, "x-edoobox-get-effect": "read", "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/07-layout-files.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Widget.php", "method": "getWidget", "line": 213 }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": true, "x-edoobox-permission": { "resource": "widget", "short": "wigt", "checkedByDispatcher": true, "levels": [ 1, 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." } } ```