Skip to content

Commit

Permalink
Docs: move warning from embed API to the top (#11053)
Browse files Browse the repository at this point in the history
  • Loading branch information
stsewd authored Jan 23, 2024
1 parent 8658522 commit b212a4d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/user/api/v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1894,6 +1894,11 @@ Embed
Retrieve HTML-formatted content from documentation page or section.
Read :doc:`/guides/embedding-content` to know more about how to use this endpoint.

.. warning::

The content will be returned as is, without any sanitization or escaping.
You should not include content from arbitrary projects, or projects you do not trust.

**Example request**:

.. prompt:: bash $
Expand Down Expand Up @@ -1925,11 +1930,6 @@ Embed
Passing ``?doctool=`` and ``?doctoolversion=`` may improve the response,
since the endpoint will know more about the exact structure of the HTML and can make better decisions.

.. warning::

The content will be returned as is, without any sanitization or escaping.
You should not include content from arbitrary projects, or projects you do not trust.

Additional APIs
---------------

Expand Down

0 comments on commit b212a4d

Please sign in to comment.