From 9799404cc6f58dc9cfdd5654982e52c54588101f Mon Sep 17 00:00:00 2001 From: Ole-Morten Dale Date: Mon, 2 Mar 2026 15:48:32 +0100 Subject: [PATCH] docs: warn against writing directly to datasets via API in production The dataset API endpoint for posting entities is not intended for production use. Add a warning in api.rst directing users to use an HTTP endpoint source or the JSON Push Protocol instead. Also adds a top-level RST label to json-push.rst so it can be referenced via :ref: consistently with the rest of the docs. --- hub/api.rst | 5 +++++ hub/json-push.rst | 2 ++ 2 files changed, 7 insertions(+) diff --git a/hub/api.rst b/hub/api.rst index 4b884c48ca..52e9719639 100644 --- a/hub/api.rst +++ b/hub/api.rst @@ -150,6 +150,11 @@ With curl: Get a list of all the datasets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. warning:: + + Do not use the dataset API to write data in production. To push data into Sesam, use either an + :ref:`HTTP endpoint source ` or the :ref:`JSON Push Protocol `. + With curl: :: diff --git a/hub/json-push.rst b/hub/json-push.rst index dd4e2f9593..68ab0e3abb 100644 --- a/hub/json-push.rst +++ b/hub/json-push.rst @@ -1,3 +1,5 @@ +.. _json_push_protocol: + ================== JSON Push Protocol ==================