Design-Widget ändern

{
  "operationId": "put_v2_widget",
  "summary": "Design-Widget ändern",
  "description": "Ändert Reihenfolge oder config eines bestehenden Widgets. design, template, key und html_id bleiben unveränderlich. Der Handler validiert Einstellungen anhand der aktuellen Widget-LUT und berechnet bei Layoutänderungen das Design-CSS neu. Ein nicht leeres data mit mindestens einem unterstützten Änderungsfeld ist erforderlich.",
  "tags": [
    "widget"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "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": "widget_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": "^widget_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
                    "examples": [
                      "widget_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,
                "design": false,
                "template": false,
                "key": false,
                "order": {
                  "x-edoobox-canonicalType": "integer",
                  "description": "PHP int cast; integers are canonical. No rejecting wire type/range is checked; other JSON values also coerce.\n\nCast to int, reorder siblings, store returned position. No min/max input validation.\n\nRuntime preconditions / rejection: Missing widget -> callback false -> ED90100.\n\nScope / limitations: Do not claim minimum=1 or fixed maximum from normal output numbering.",
                  "x-edoobox-schemaStatus": "source-reviewed",
                  "examples": [
                    2
                  ],
                  "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": false,
                "config": {
                  "type": [
                    "object",
                    "array"
                  ],
                  "properties": {
                    "name": {
                      "x-edoobox-canonicalType": "string",
                      "description": "aP(...,true,150), truncates rather than rejecting length."
                    },
                    "width": {
                      "type": "object",
                      "properties": {
                        "setpc": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        },
                        "settab": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        },
                        "setpho": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        },
                        "min": {
                          "x-edoobox-canonicalType": "number",
                          "description": "Caller-supplied comparison minimum; not a fixed server validator."
                        }
                      },
                      "additionalProperties": true
                    },
                    "height": {
                      "type": "object",
                      "properties": {
                        "setpc": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        },
                        "settab": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        },
                        "setpho": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        },
                        "min": {
                          "x-edoobox-canonicalType": "number",
                          "description": "Caller-supplied comparison minimum."
                        },
                        "auto": {
                          "x-edoobox-canonicalType": "integer",
                          "x-edoobox-recognizedValues": [
                            1,
                            2,
                            3
                          ],
                          "description": "Only cast values1/2/3 copied; other values ignored."
                        }
                      },
                      "additionalProperties": true
                    },
                    "margin": {
                      "type": "object",
                      "properties": {
                        "left": {
                          "type": "object",
                          "properties": {
                            "setpc": {
                              "x-edoobox-canonicalType": "integer",
                              "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                            },
                            "settab": {
                              "x-edoobox-canonicalType": "integer",
                              "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                            },
                            "setpho": {
                              "x-edoobox-canonicalType": "integer",
                              "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                            }
                          },
                          "additionalProperties": true
                        },
                        "top": {
                          "type": "object",
                          "properties": {
                            "setpc": {
                              "x-edoobox-canonicalType": "integer",
                              "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                            },
                            "settab": {
                              "x-edoobox-canonicalType": "integer",
                              "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                            },
                            "setpho": {
                              "x-edoobox-canonicalType": "integer",
                              "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "additionalProperties": true
                    },
                    "visible": {
                      "type": "object",
                      "properties": {
                        "showpho": {
                          "x-edoobox-canonicalType": "boolean",
                          "description": "Only stricttrue enables; everything else becomes false."
                        },
                        "type": {
                          "x-edoobox-canonicalType": "integer",
                          "description": "PHP int normalization, not strict rejecting wire numeric restriction."
                        }
                      },
                      "additionalProperties": true
                    },
                    "data": {
                      "type": "object",
                      "additionalProperties": {},
                      "description": "Widget-definition-specific keys and value forms. Select/checkbox/datastructure/default checks reject; input/integer/join/json/base64 forms normalize. Allowed keys depend on template/key/account languages/features/style.",
                      "x-edoobox-schemaStatus": "reviewed-dynamic-widget-map"
                    }
                  },
                  "additionalProperties": true,
                  "description": "Common widget layout/config envelope for POST/PUT. Unknown top-level config keys ignored; unknown data keys rejected. Nested numeric bounds mostly control copying, not rejection. The object is canonical; no explicit top-level is_array rejection is implemented. PHP JSON object/array values both decode to arrays; empty/non-keyed config arrays leave default/stored config unchanged.\n\nPOST get is placeholdertrue; before-insert calls validWidgetConfig. PUT calls same validator using existing stored config. Layout numbers cast/ignore invalid entries; names/inputs truncate. GET replaces empty Structure setter and converts per-field types after decode.\n\nRuntime preconditions / rejection: Missing template/key definition -> missing_lut_widget. Unknown data property or invalid key spelling -> config_data_field_not_exist. Select/checkbox/datastructure value not in dynamic definition -> config_data_field_value_invalid. Duplicate bformular participant-field binding -> config_data_field_already_linked. Invalid join default -> config_data_field_default_value_not_exist, except promo sale selection fallback. Promo-sale prices must normalize to at least one positive finite decimal, otherwise config_data_field_value_invalid.\n\nScope / limitations: Common envelope is resolved; full per-widget/LUT/account schema union is intentionally not enumerated. Dynamic data map remains permissive with explicit validation description. visibility_tags_include/exclude accepts arrays: documented form is {tag: publicv2ID}. Legacy scalar fallback casts internal IDs, which must never be used in external examples. bformular country/language defaults can transform public country IDs/language keys in their applicable branch. Runtime account languages, membership/Bootstrap filters and definition methods determine exact data keys; no single closed data object is proven.",
                  "x-edoobox-schemaStatus": "source-reviewed-dynamic-envelope",
                  "examples": [
                    {
                      "name": "Renamed synthetic widget"
                    }
                  ],
                  "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,
              "description": "Source-declared fields; action-specific and account validation still apply.",
              "minProperties": 1,
              "x-edoobox-readOnlyFields": [
                "design",
                "template",
                "key",
                "html_id"
              ],
              "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": "^widget_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
              "examples": [
                "widget_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data",
            "id"
          ]
        },
        "examples": {
          "request": {
            "summary": "Design-Widget ändern",
            "value": {
              "data": {
                "order": 2
              },
              "id": "widget_012345abcdef_123456"
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/07-layout-files.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Widget.php",
    "method": "updateWidget",
    "line": 156
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "widget",
    "short": "wigt",
    "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."
  }
}