RenderedIssue

RenderedIssue

An issue affecting specific business or their product.

Fields
title

string

Title of the issue.

impact

Impact

Clarifies the severity of the issue.

The summarizing message , if present, should be shown right under the title for each issue. It helps business to quickly understand the impact of the issue.

The detailed breakdown helps the business to fully understand the impact of the issue. It can be rendered as dialog that opens when the business mouse over the summarized impact statement.

Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between ERROR , WARNING and INFO .

actions[]

Action

A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue.

Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue.

Union field content . Detailed content of the issue. Should be shown to the business when they expand the issue. The form in which is the content returned is specified with the content option request field. content can be only one of the following:
prerendered_content

string

Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content.

Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: div , span , p , a , ul , li , table , tr , td . For example, you can use DOMPurify .

CSS classes:

  • issue-detail - top level container for the detail of the issue
  • callout-banners - section of the issue-detail with callout banners
  • callout-banner - single callout banner, inside callout-banners
  • callout-banner-info - callout with important information (default)
  • callout-banner-warning - callout with a warning
  • callout-banner-error - callout informing about an error (most severe)
  • issue-content - section of the issue-detail , contains multiple content-element
  • content-element - content element such as a list, link or paragraph, inside issue-content
  • root-causes - unordered list with items describing root causes of the issue, inside issue-content
  • root-causes-intro - intro text before the root-causes list, inside issue-content
  • segment - section of the text, span inside paragraph
  • segment-attribute - section of the text that represents a product attribute, for example 'image_link'
  • segment-literal - section of the text that contains a special value, for example '0-1000 kg'
  • segment-bold - section of the text that should be rendered as bold
  • segment-italic - section of the text that should be rendered as italic
  • tooltip - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class tooltip-text and is intended to be shown in a mouse over dialog. If the style is not used, the tooltip-text section would be shown on a new line, after the main part of the text.
  • tooltip-text - marks a section of the text within a tooltip , that is intended to be shown in a mouse over dialog.
  • tooltip-icon - marks a section of the text within a tooltip , that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a br tag, that is separating the main text and the tooltip text when the style is not used.
  • tooltip-style-question - the tooltip shows helpful information, can use the '?' as an icon.
  • tooltip-style-info - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.
  • content-moderation - marks the paragraph that explains how the issue was identified.
  • asset-value - marks the paragraph that contains the asset information.
  • asset-label - marks the section of the text that contains the label of the asset.
  • asset-link - marks the section of the text that contains a link to the asset.
  • asset-provided-value - marks the section of the text that contains the value of the asset.
  • new-element - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.

Union field out_of_court_dispute_settlement . Out-of-court dispute settlement (ODS) contains a link to a page where the business can bring their appeal to an external body . It may contains a detailed instructions and any values needed for the business to proceed with their request.

The ODS is a part of the EU's Digital Service ACT (DSA). If present, it should be shown to the business.

The ODS may differ for individual issues and thus it should be by default shown in the detail of the issue. It could be shown next to actions for the issue.

In some cases the ODS could be the same for all issues in the list. If the values for individual issues do not differ, then the ODS could be shown only once. For example under the list with issues. This is an optional UX improvement. If values differ, then ODS needs to be shown in details of individual issues. out_of_court_dispute_settlement can be only one of the following:

prerendered_out_of_court_dispute_settlement

string

Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet.

Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: div , span , p , a , ul , li , table , tr , td . For example, you can use DOMPurify .

CSS classes:

  • ods-section * - wrapper around the out-of-court dispute resolution section
  • ods-description * - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link.
  • ods-param * - wrapper around the header-value pair for parameters that the business may need to provide during the ODS process.
  • ods-routing-id * - ods param for the Routing ID.
  • ods-reference-id * - ods param for the Routing ID.
  • ods-param-header * - header for the ODS parameter
  • ods-param-value * - value of the ODS parameter. This value should be rendered in a way that it is easy for the user to identify and copy.
  • segment - section of the text, span inside paragraph
  • segment-attribute - section of the text that represents a product attribute, for example 'image_link'
  • segment-literal - section of the text that contains a special value, for example '0-1000 kg'
  • segment-bold - section of the text that should be rendered as bold
  • segment-italic - section of the text that should be rendered as italic
  • tooltip - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class tooltip-text and is intended to be shown in a mouse over dialog. If the style is not used, the tooltip-text section would be shown on a new line, after the main part of the text.
  • tooltip-text - marks a section of the text within a tooltip , that is intended to be shown in a mouse over dialog.
  • tooltip-icon - marks a section of the text within a tooltip , that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a br tag, that is separating the main text and the tooltip text when the style is not used.
  • tooltip-style-question - the tooltip shows helpful information, can use the '?' as an icon.
  • tooltip-style-info - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.