diff --git a/hub/changelog.rst b/hub/changelog.rst index 1aef44db2e0..ed513798263 100644 --- a/hub/changelog.rst +++ b/hub/changelog.rst @@ -8,6 +8,12 @@ Changelog * Extended Integrated Search to allow using a well-defined :ref:`query syntax `. Improvements have been made to the search results for namespaced identifiers that have been merged. They now have the same query result page. * Added the ``trigger_on`` property to the :ref:`http transform `. +.. _changelog_2024_09_17: + +2024-09-17 +---------- +* Added support for the ``parse_response_as`` property to the :ref:`operation properties `. It can be specified in the ``operations`` property of both the :ref:`REST systems ` and the :ref:`REST transform `. It is not supported by the :ref:`REST source ` or :ref:`REST sink `. + .. _changelog_2024_05_21: 2024-05-21 diff --git a/hub/documentation/service-configuration/systems/configuration-systems-rest.rst b/hub/documentation/service-configuration/systems/configuration-systems-rest.rst index 314ddb7105e..7b479598aec 100644 --- a/hub/documentation/service-configuration/systems/configuration-systems-rest.rst +++ b/hub/documentation/service-configuration/systems/configuration-systems-rest.rst @@ -259,6 +259,18 @@ A operation configuration looks like: - - + * - ``parse_response_as`` + - Enum + - This property controls how the response body is parsed on the client-side. Allowed values are ``entities``, ``json``, ``text`` and ``bytes``. + + - ``entities`` is the default and parses the response body as a stream of entities, i.e. JSON objects and arrays of JSON objects. + - ``json`` parses the response body as any JSON object including primitive types like numbers and strings. + - ``text`` parses the response body as a UTF-8 encoded string. + - ``bytes`` parses the response body as bytes. + + - ``entities`` + - + * - ``response_property`` - String - The name of the property to put the response in when emitting entities. Note that this property can be defined