diff mbox series

doc: Improve POST /upload request documentation

Message ID 20240126161100.101078-1-dit.kozmaj@kynetics.it
State Accepted
Headers show
Series doc: Improve POST /upload request documentation | expand

Commit Message

dit.kozmaj@kynetics.it Jan. 26, 2024, 4:11 p.m. UTC 
From: Dit Kozmaj <dit.kozmaj@kynetics.it>

Signed-off-by: Dit Kozmaj <dit.kozmaj@kynetics.it>
---
 doc/source/swupdate-ipc-interface.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
diff mbox series

Patch

diff --git a/doc/source/swupdate-ipc-interface.rst b/doc/source/swupdate-ipc-interface.rst
index d96bc7f..016ee2f 100644
--- a/doc/source/swupdate-ipc-interface.rst
+++ b/doc/source/swupdate-ipc-interface.rst
@@ -286,6 +286,18 @@  Install API
 
 This initiates an update: the initiator sends the request and start to stream the SWU in the same
 way as described in :ref:`install_api`.
+The ``POST /upload`` request contains:
+
+- the SWU file in its body
+- the following header field
+
+    ``Content-Type: multipart/form-data; boundary...``
+
+For example to stream the SWU file and start the update procedure using ``curl``:
+
+::
+
+        curl -F file=@update_file.swu http://host:8080/upload
 
 Restart API
 -----------