From d326c652d4f4eef10e6666dfafc5b7a78c588a7e Mon Sep 17 00:00:00 2001 From: William Durand Date: Tue, 13 Oct 2020 15:53:19 +0200 Subject: [PATCH] Add-on summary/description might contain HTML tags (#15713) --- docs/topics/api/addons.rst | 4 ++-- docs/topics/api/overview.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/topics/api/addons.rst b/docs/topics/api/addons.rst index d0822ee912..84e34edadd 100644 --- a/docs/topics/api/addons.rst +++ b/docs/topics/api/addons.rst @@ -151,7 +151,7 @@ This endpoint allows you to fetch a specific add-on by id, slug or guid. :>json string created: The date the add-on was created. :>json object current_version: Object holding the current :ref:`version ` of the add-on. For performance reasons the ``license`` field omits the ``text`` property from both the search and detail endpoints. :>json string default_locale: The add-on default locale for translations. - :>json string|object|null description: The add-on description (See :ref:`translated fields `). + :>json string|object|null description: The add-on description (See :ref:`translated fields `). This field might contain some HTML tags. :>json string|object|null developer comments: Additional information about the add-on provided by the developer. (See :ref:`translated fields `). :>json string edit_url: The URL to the developer edit page for the add-on. :>json string guid: The add-on `extension identifier `_. @@ -186,7 +186,7 @@ This endpoint allows you to fetch a specific add-on by id, slug or guid. :>json string review_url: The URL to the reviewer review page for the add-on. :>json string slug: The add-on slug. :>json string status: The :ref:`add-on status `. - :>json string|object|null summary: The add-on summary (See :ref:`translated fields `). + :>json string|object|null summary: The add-on summary (See :ref:`translated fields `). This field supports "linkification" and therefore might contain HTML hyperlinks. :>json string|object|null support_email: The add-on support email (See :ref:`translated fields `). :>json string|object|null support_url: The add-on support URL (See :ref:`translated fields `). :>json array tags: List containing the text of the tags set on the add-on. diff --git a/docs/topics/api/overview.rst b/docs/topics/api/overview.rst index 65b6b90e98..42eda3c3ba 100644 --- a/docs/topics/api/overview.rst +++ b/docs/topics/api/overview.rst @@ -233,8 +233,8 @@ Outgoing Links If the ``wrap_outgoing_links`` query parameter is present, any external links returned for properties such as ``support_url`` or ``homepage`` will be wrapped through ``outgoing.prod.mozaws.net``. Fields supporting some HTML, such as -add-on ``description``, always do this regardless of whether or not the query -parameter is present. +add-on ``description`` or ``summary``, always do this regardless of whether or +not the query parameter is present. ~~~~~~~~~~~~ Cross Origin