Message ID | 20240126161100.101078-1-dit.kozmaj@kynetics.it |
---|---|
State | Accepted |
Headers | show
Return-Path: <swupdate+bncBDXJB3WMY4ARBGVTZ6WQMGQEG2ZJHLA@googlegroups.com> X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20230601 header.b=MIxVh8JE; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=googlegroups.com (client-ip=2a00:1450:4864:20::138; helo=mail-lf1-x138.google.com; envelope-from=swupdate+bncbdxjb3wmy4arbgvtz6wqmgqeg2zjhla@googlegroups.com; receiver=patchwork.ozlabs.org) Received: from mail-lf1-x138.google.com (mail-lf1-x138.google.com [IPv6:2a00:1450:4864:20::138]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4TM2kC0Tm9z23gB for <incoming@patchwork.ozlabs.org>; Sat, 27 Jan 2024 03:11:13 +1100 (AEDT) Received: by mail-lf1-x138.google.com with SMTP id 2adb3069b0e04-5100a0f0c55sf482227e87.1 for <incoming@patchwork.ozlabs.org>; Fri, 26 Jan 2024 08:11:13 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706285467; cv=pass; d=google.com; s=arc-20160816; b=t522yca6mh9YZnXPy4f08FHUiM8yJ0NTovUh7i19JWOWq+jYDEuBwEEuz3ZnBZzH4v NPz5dsvMvLSbXaGjdbe/F9p/v1iZjkA2e4I5BSiZB+pWNshc0ULk56bduffDbdIuOc+S 9hpB50anfJT+Fe7Q1yAAAKeO5r186TwRa8t5iJWNMxbHk05M4Qe0gpHgni9NzHeuxIAR pCPGbH9Q29oJe/riFNzmXhegcXRXfd3+wO11axu7ppj8zU3pBa4Ux77e0h2aCrp/xzek dxyuv1sA+Kt92hqIBDpWhzwLLNqlWv8NNZctBMK8icRwWcJtfUbzhDyYkgEK81eufHQS GSdQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:mime-version:message-id:date :subject:cc:to:from:sender:dkim-signature; bh=Sf9cLlkKBGl/Ib33ekaqp1hucNbtGETServz49KegtU=; fh=mV3Eo16r1xLOrpT3Gt0Kk4skjzApTPKHvBsUNF+naWM=; b=YpbWByrrPyKO/lSAo329lmt5SXYfcsilSWynTHwFtsnO+AroEW1afl29+x0q2cGdLW rprICYPahDL2CrVmsinHbHiElaq2hhNAU6QYdWDg2AH1tUlzjv/P9qWp/usvn1UkVOnj IHMIv6IAa8OKhQNZUgWFbcTe9wMtM6m+do7QmYSYHywgCJyy/iC//SG8YP6+z1H3vBVe mhVB6RCz0gd3N2Hp8sPDxLexs3I8c6jpQl/ublsTcAD1kzmISIno1j6f2cOU87uEKp2g so3/d4FsmNTU+b2bfRQBlIN1WEnLkmEXcCRELzKKAF2WoTRmFzOlo3TZkiKKVs4ulABK KyYQ== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@kynetics-it.20230601.gappssmtp.com header.s=20230601 header.b=R9o2Y1Sa; spf=pass (google.com: domain of dit.kozmaj@kynetics.it designates 2a00:1450:4864:20::52b as permitted sender) smtp.mailfrom=dit.kozmaj@kynetics.it DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20230601; t=1706285467; x=1706890267; darn=patchwork.ozlabs.org; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:x-original-authentication-results :x-original-sender:mime-version:message-id:date:subject:cc:to:from :sender:from:to:cc:subject:date:message-id:reply-to; bh=Sf9cLlkKBGl/Ib33ekaqp1hucNbtGETServz49KegtU=; b=MIxVh8JEyH1ad0v0Jb3HO8XKqd7XARX+1pjA4ccHfu1kC2UePMUtqEXjzv4srDgo44 Ym/HWwSkRBJ8XykA6cd0QuE49/NZo/TrRFFgXMNjdvSyedaRcZCNkb7D/gBMJrhAVPL2 UQ7AwElNZ+t5rCynnJEvXNXZfypp2ZI7qCNf9TZsqk3zu5IshIdpZxcUYi1v0aq+0szH wdI4vpgUlUnz/4jvXOSxZDWMLIFsL+NE+PsYin+e6xQGi3nW6uITuR8piFY2i0HdidDy x30WTPOroncLEbNtkMGB1FTkhY44qYHjWw+tOKDXXxUrlQvap3UZqum6LCQqwZorOvvW fowA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706285467; x=1706890267; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :x-spam-checked-in-group:list-id:mailing-list:precedence :x-original-authentication-results:x-original-sender:mime-version :message-id:date:subject:cc:to:from:x-beenthere:x-gm-message-state :sender:from:to:cc:subject:date:message-id:reply-to; bh=Sf9cLlkKBGl/Ib33ekaqp1hucNbtGETServz49KegtU=; b=mrQBXBMnFI8ZRRQbAweGW744iUQEW6bXJJ5h5CAfmNkA/vycopblgWw3v6BNvjh3Fu ue0Nb63WZWDfL0Bm2E4hjaJBNkpYGx6dHhygUN5RYmx2UacplYYiEoBRRkVN21OIRy6k cHVy6cDVbCMTNt1GWZc6xiwcX//7wHeL/nnGfpQZYQQRf3hD+e4rXSxC7+SBVunqKhky XaqMMAZ3B1wDFqt8e0bFXiJ7c/0Geunf3C/o5mhHZouIvJfI0IEXcSqEuEY3jfB375f9 SoDS4g3RHqYPYT7PmMaHqo1bCpGBoQ3ZiHDndNC0JWCqXRqBhRO0kDSG+0Liyx0YD72p uIGg== Sender: swupdate@googlegroups.com X-Gm-Message-State: AOJu0Yw5HaR+zJFJELjdK88wtSdKx2vf2k3bA+jcyCGdoT6TE3TJX7qJ CUvUgbRUDtxK9ifPt7Ilz/ZMrAgxUbarKJMnUrRW8r+Veycc4cj4 X-Google-Smtp-Source: AGHT+IFqm9bp+LsBEuS/sQOQSbBtFaYaZ5fiyGP5uZ4eTucRuDBm9TEcug1Al4NPF4mWekJSbIlLTg== X-Received: by 2002:ac2:5e9e:0:b0:50e:8c2e:b0fa with SMTP id b30-20020ac25e9e000000b0050e8c2eb0famr745787lfq.77.1706285466876; Fri, 26 Jan 2024 08:11:06 -0800 (PST) X-BeenThere: swupdate@googlegroups.com Received: by 2002:a05:6512:360b:b0:510:1773:d124 with SMTP id f11-20020a056512360b00b005101773d124ls355258lfs.2.-pod-prod-07-eu; Fri, 26 Jan 2024 08:11:04 -0800 (PST) X-Received: by 2002:a2e:8518:0:b0:2ce:211:31ba with SMTP id j24-20020a2e8518000000b002ce021131bamr1019464lji.97.1706285464540; Fri, 26 Jan 2024 08:11:04 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1706285464; cv=none; d=google.com; s=arc-20160816; b=TYtnUavA6T3NZ3XD7gCiedpqm6jXKGw6F/V+fIkBzMwXez0JdKOOn3IvEyP3CijhIM bZxNns9Pp3Svc7mYcq5tqV9FT7Lj8Oyc4TW6Dyj8T/KH8VQNc6++sM7p/FlQYtEz/GK5 tqAzOTFAhqlCwvgDWug2+U7gbsX/mAdET4Rz/R4q8aXnI/T+h1zjBFsX/gEflT4T8UAz KgZZrrEu6QRKlMdBW71cxaj4iEtUbJg8L2BRZMjQpiMTFwQ91YYeSbHM4f/x7Epg/4s9 +KegpM7zWPgWRZBGt6HCr4YIZmlw+etNJSDkGKtmtBd/ZKxJndZnRFleUIOzZKYJmsiU Cx8Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:dkim-signature; bh=Qybb/LKDEBwWt6syXiSXMAtz07iaOjCFwgwQrDQ4YIc=; fh=mV3Eo16r1xLOrpT3Gt0Kk4skjzApTPKHvBsUNF+naWM=; b=gR19Jxz2i7isOGACQhoe48SqlvgJqda+rORu8t3Zr2leDQOra9RpPdNeKIkxRGLeQP vWm6RE3LLki7vWUVUx0AgtFVEKWx3fGFrSKbvdCnJgWAfoYNDSJL6LZ1zHpwBGF7qYU4 YXrH/xJBZYoRHJ0MSrG343KWOAZHG4oqoMW6bKfUZzgYSr8FVVBRtlCWaM+K6RiWOjcq o07F1dCqwDqlrGBnA8KsIYEi9w0KgNPS9dNYcpYz1vCiwZX0aroeqGFg0g65Wju7xvT8 zRvTDo60j18XVCXz8UR4EBeKHI7atI4eiyMi6khpeQ4bNLo5xzTS+D9y7KxVmbcLPWCd QDOg== ARC-Authentication-Results: i=1; gmr-mx.google.com; dkim=pass header.i=@kynetics-it.20230601.gappssmtp.com header.s=20230601 header.b=R9o2Y1Sa; spf=pass (google.com: domain of dit.kozmaj@kynetics.it designates 2a00:1450:4864:20::52b as permitted sender) smtp.mailfrom=dit.kozmaj@kynetics.it Received: from mail-ed1-x52b.google.com (mail-ed1-x52b.google.com. [2a00:1450:4864:20::52b]) by gmr-mx.google.com with ESMTPS id s22-20020a2e81d6000000b002cf2c5c0941si58819ljg.0.2024.01.26.08.11.04 for <swupdate@googlegroups.com> (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 26 Jan 2024 08:11:04 -0800 (PST) Received-SPF: pass (google.com: domain of dit.kozmaj@kynetics.it designates 2a00:1450:4864:20::52b as permitted sender) client-ip=2a00:1450:4864:20::52b; Received: by mail-ed1-x52b.google.com with SMTP id 4fb4d7f45d1cf-55369c59708so176212a12.1 for <swupdate@googlegroups.com>; Fri, 26 Jan 2024 08:11:04 -0800 (PST) X-Received: by 2002:a17:906:2dcc:b0:a2c:4b28:90d5 with SMTP id h12-20020a1709062dcc00b00a2c4b2890d5mr1579061eji.2.1706285463099; Fri, 26 Jan 2024 08:11:03 -0800 (PST) Received: from dit-HP-Pavilion-Laptop-15-cw1xxx.lan (host188-126-32-195.dimensionesrl.eu. [195.32.126.188]) by smtp.gmail.com with ESMTPSA id h17-20020a17090634d100b00a312651ff8dsm775949ejb.157.2024.01.26.08.11.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 26 Jan 2024 08:11:02 -0800 (PST) From: dit.kozmaj@kynetics.it To: swupdate@googlegroups.com Cc: Dit Kozmaj <dit.kozmaj@kynetics.it> Subject: [swupdate] [PATCH] doc: Improve POST /upload request documentation Date: Fri, 26 Jan 2024 17:11:00 +0100 Message-Id: <20240126161100.101078-1-dit.kozmaj@kynetics.it> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Original-Sender: dit.kozmaj@kynetics.it X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@kynetics-it.20230601.gappssmtp.com header.s=20230601 header.b=R9o2Y1Sa; spf=pass (google.com: domain of dit.kozmaj@kynetics.it designates 2a00:1450:4864:20::52b as permitted sender) smtp.mailfrom=dit.kozmaj@kynetics.it Content-Type: text/plain; charset="UTF-8" Precedence: list Mailing-list: list swupdate@googlegroups.com; contact swupdate+owners@googlegroups.com List-ID: <swupdate.googlegroups.com> X-Spam-Checked-In-Group: swupdate@googlegroups.com X-Google-Group-Id: 605343134186 List-Post: <https://groups.google.com/group/swupdate/post>, <mailto:swupdate@googlegroups.com> List-Help: <https://groups.google.com/support/>, <mailto:swupdate+help@googlegroups.com> List-Archive: <https://groups.google.com/group/swupdate List-Subscribe: <https://groups.google.com/group/swupdate/subscribe>, <mailto:swupdate+subscribe@googlegroups.com> List-Unsubscribe: <mailto:googlegroups-manage+605343134186+unsubscribe@googlegroups.com>, <https://groups.google.com/group/swupdate/subscribe> |
Series |
doc: Improve POST /upload request documentation
|
expand
|
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 -----------