PROTOCOL: Add bandwidth liststask/30217

See: #30217

1 files changed, 25 insertions, 1 deletions

diff --git a/src/main/resources/docs/PROTOCOL b/src/main/resources/docs/PROTOCOL
index 9f65e43..58ed4dc 100644
--- a/src/main/resources/docs/PROTOCOL
+++ b/src/main/resources/docs/PROTOCOL
@@ -89,6 +89,7 @@
 
    'relay-descriptors' contains  the following substructure:
 
+   * bandwidths
    * consensuses
    * extra-infos
    * microdescs
@@ -111,7 +112,9 @@
 
    * for consensuses, microdescs, and votes from the valid-after dates,
    * for extra-infos, server-descriptors, statuses, and tor from the
-     published dates.
+     published dates,
+   * for bandwidths, from the file_created value if available, otherwise the
+     timestamp.
 
 3.0 Index Files
 
@@ -181,6 +184,7 @@
 
    'relay-descriptors' contains  the following substructure:
 
+   * bandwidths
    * consensuses
    * extra-infos
    * microdescs
@@ -236,6 +240,15 @@
    are derived from the valid-after dates of the referencing microdesc
    consensus.
 
+4.3.6
+   'bandwidths' contains documents named:
+
+   year DASH month DASH day DASH hour DASH minute DASH second
+   DASH BANDWIDTH DASH DIGEST
+
+   Where DIGEST is the uppercase-hex encoded SHA256 digest of the bandwidth
+   file and BANDWIDTH is the string "bandwidth".
+
 4.4 'webstats' below 'recent'
 
    'webstats' contains compressed log files named according to
@@ -331,6 +344,7 @@
 
    'relay-descriptors' contains  the following substructure:
 
+   * bandwidth
    * certs
    * consensus
    * extra-info
@@ -387,6 +401,16 @@
 
    and below the subdirectories of 'micro' and 'consensus-microdescs'.
 
+5.3.5
+   'bandwidth' contains the subdirectory structure
+
+   year SEP month SEP day
+
+   Where the time related values are taken from the file_created value where
+   available, otherwise the timestamp.
+
+   The files are named according to the structure in 4.3.6.
+
 5.4 'webstats' below 'out'
 
    'webstats' contains compressed log files structured and named according