HOC SiteDocumentation

get_design_warnings

Dry-run design validation (no save). Pass content to validate a draft, or omit content and set target+ids to validate the saved document. Warns on unknown block types, unknown button actions, misplaced/unparseable dataRequests/inputSchema, missing requestName/variables/resultWrites, routePageId issues, form field mapping, translation gaps, a prop that belongs to another block type (design.warning.prop_not_supported_by_block), and a FlexListBlock left at the implicit row default (design.warning.flex_list_implicit_row). DOM/overflow detectors are not included; screen_capture_page returns layout.issues for the rendered page.

get_design_warnings · Group: design

Dry-run design validation (no save). Pass content to validate a draft, or omit content and set target+ids to validate the saved document. Warns on unknown block types, unknown button actions, misplaced/unparseable dataRequests/inputSchema, missing requestName/variables/resultWrites, routePageId issues, form field mapping, translation gaps, a prop that belongs to another block type (design.warning.prop_not_supported_by_block), and a FlexListBlock left at the implicit row default (design.warning.flex_list_implicit_row). DOM/overflow detectors are not included; screen_capture_page returns layout.issues for the rendered page.

Inputs

FieldRequiredNotes
websiteIdrequired
targetrequiredpage | chrome | chrome-header | chrome-footer | page-component. chrome-header and chrome-footer select the chrome surface; target chrome plus kind still works.
pageIdoptional
kindoptionalheader|footer when target=chrome. header is chrome-header; footer is chrome-footer.
componentIdoptional
contentoptionalOptional draft editor document to validate
contentLocaleoptional
codesoptional
excludeCodesoptional
localesoptional
groupByoptionalcode (default, counts only, truncated) | none (full rows)

Maps to

  • POST /api/v1/{locale}/{websiteId}/design-warnings → API