From e56ee73b51a20cb3aed067ff2693b8703d577400 Mon Sep 17 00:00:00 2001
From: James Decker <deckerjames@google.com>
Date: Wed, 19 Mar 2025 08:52:41 -0700
Subject: [PATCH] Synchronizing v4 protocol to match changes in v3.1 protocol
Also updated the example pipeline_id to match the pipeline_id
actually expected.
Change-Id: I3c98a9f69e1322f00bbe2eac3f52a93f9e1b9474
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/6355800
Commit-Queue: James Decker <deckerjames@google.com>
Reviewed-by: Joshua Pawlicki <waffles@chromium.org>
Reviewed-by: Sorin Jianu <sorin@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1434838}
---
docs/updater/protocol_4.md | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/docs/updater/protocol_4.md b/docs/updater/protocol_4.md
index 73f1e066fd1ee..df3bd11b89d2d 100644
--- a/docs/updater/protocol_4.md
+++ b/docs/updater/protocol_4.md
@@ -702,8 +702,8 @@ A pipeline object has the following members:
* `pipeline_id`: A string describing the pipeline strategy. This string is
echoed back to the server in `event` objects to help the server attribute
events to a particular pipeline. Pipeline IDs are not necessarily globally
- unique; for example, a server might use an ID of "h1 -> h2 via zucchini" to
- identify a pipeline that updates an application from h1 to h2, using a
+ unique; for example, a server might use an ID of "zucc:h1sha256->h2sha256"
+ to identify a pipeline that updates an application from h1 to h2, using a
zucchini patch, and reuse that ID across many update check responses.
* `operations`: A list of `operation` objects.
@@ -875,23 +875,22 @@ For `eventtype == 3` events:
For `eventtype == 14` events:
* `download_time_ms`: The time elapsed between the start of the download and
- the end of the download, in milliseconds. -1 if unavailable.
- Default: -1.
- * `downloaded_bytes`: The number of bytes successfully received from the
- download server. Default: 0.
+ the end of the download, in milliseconds. -1 if unavailable. Default: -1.
+ * `downloaded`: The number of bytes successfully received from the download
+ server. Default: 0.
* `downloader`: A string identifying the download algorithm / stack. Known
values:
* "" (empty string): Unknown downloader.
* "nsurlsession_background": MacOS background NSURLSession.
* "bits": Microsoft BITS.
* "direct": The Chromium network stack.
- * `expected_bytes`: The number of bytes expected to be downloaded. Default:
- 0.
+ * `total`: The size in bytes of the payload provided in the given url.
+ Default: 0.
* `pipeline_id`: The `pipeline_id` set in the request for this operation's
pipeline.
* `url`: The URL from which the download was attempted.
-For `eventtype` == 60, 61, 62, or 63 events:
+For `eventtype == 60, 61, 62, or 63` events:
* All the members of `eventtype == 3` events.
* `pipeline_id`: The `pipeline_id` set in the request for this operation's
pipeline.