Rename /node/ledger-chunk to /node/ledger_chunk for consistency (#7763)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: achamayou <4016369+achamayou@users.noreply.github.com>

Author: achamayou

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Added time-based snapshot scheduling. Snapshots can now be triggered after a configurable wall-clock interval (`snapshots.time_interval`) elapses, in addition to the existing transaction-count threshold (`snapshots.tx_count`). A new `snapshots.min_tx_count` option (default 2) sets the minimum number of transactions required before a time-based snapshot fires. Snapshot timing state is replicated to backups via a new `public:ccf.internal.snapshot_status` internal table (#7731).
 - Added support for endpoints that defer their HTTP response until the submitted transaction reaches a terminal consensus state (committed or invalidated). Endpoint authors can call `set_consensus_committed_function()` when installing an endpoint to register a callback that is invoked once the transaction is globally committed or invalidated. The callback receives the `ccf::TxID` and a `ccf::FinalTxStatus` (either `Committed` or `Invalid`), and may inspect or modify the response before it is sent. A built-in `ccf::endpoints::default_respond_on_commit_func` is provided that returns the original response on commit, or an error on invalidation. See the logging sample app (`/log/blocking/private`) for example usage (#7562).
 
+### Changed
+
+- Renamed `/node/ledger-chunk` and `/node/ledger-chunk/{chunk_name}` endpoints to `/node/ledger_chunk` and `/node/ledger_chunk/{chunk_name}` for consistency with the naming convention used by other `/node/*` endpoints.
+
 ### Fixed
 
 - Fixed the Turin SEV-SNP CPUID mapping used for product detection (#7748).

doc/operations/configuration.rst

@@ -29,7 +29,7 @@ The `enabled_operator_features` configuration field allows enabling or disabling
 Currently supported features are:
 
 1. 'SnapshotRead': gates access to endpoints used to fetch snapshots directly from nodes (:http:GET:`/node/snapshot`, :http:HEAD:`/node/snapshot`, :http:GET:`/node/snapshot/{snapshot_name}` and :http:HEAD:`/node/snapshot/{snapshot_name}`).
-2. 'LedgerChunkRead': gates access to endpoints used to retrieve ledger chunks (:http:GET:`/node/ledger-chunk`, :http:HEAD:`/node/ledger-chunk`, :http:GET:`/node/ledger-chunk/{chunk_name}` and :http:HEAD:`/node/ledger-chunk/{chunk_name}`).
+2. 'LedgerChunkRead': gates access to endpoints used to retrieve ledger chunks (:http:GET:`/node/ledger_chunk`, :http:HEAD:`/node/ledger_chunk`, :http:GET:`/node/ledger_chunk/{chunk_name}` and :http:HEAD:`/node/ledger_chunk/{chunk_name}`).
 
 Since these operations may require disk IO and produce large responses, these features should not be enabled on interfaces with public access, and instead restricted to interfaces with local connectivity for node-to-node and operator access.
 

doc/operations/ledger_snapshot.rst

@@ -50,7 +50,7 @@ Download Endpoints
 In order to facilitate long term backup of the ledger files (also called chunks), nodes can enable HTTP endpoints that allow a client to download committed ledger files.
 The `LedgerChunkRead` feature must be added to `enabled_operator_features` on the relevant `rpc_interfaces` entries in the node configuration.
 
-1. :http:GET:`/node/ledger-chunk` and :http:HEAD:`/node/ledger-chunk`, both taking a `since` query parameter.
+1. :http:GET:`/node/ledger_chunk` and :http:HEAD:`/node/ledger_chunk`, both taking a `since=<seqno>` query parameter.
 
 These endpoints can be used by a client to download the next ledger chunk including a given sequence number `<seqno>`.
 They redirect to the appropriate chunk if it exists, using the endpoints described below, or return a `404 Not Found` response if no such chunk is available.
@@ -61,17 +61,17 @@ In the typical case, a requesting client will first hit a Backup, and will event
 
     sequenceDiagram
         Note over Client: Client asks for chunk starting at index
-        Client->>+Backup: GET /node/ledger-chunk?since=index
-        Backup->>-Client: 308 Location: /node/ledger-chunk/ledger_startIndex_endIndex.committed
+        Client->>+Backup: GET /node/ledger_chunk?since=index
+        Backup->>-Client: 308 Location: /node/ledger_chunk/ledger_startIndex_endIndex.committed
         Note over Backup: Backup node has that chunk
-        Client->>+Backup: GET /node/ledger-chunk/ledger_startIndex_endIndex.committed
+        Client->>+Backup: GET /node/ledger_chunk/ledger_startIndex_endIndex.committed
         Backup->>-Client: 200 <Chunk Contents>
-        Client->>+Backup: GET /node/ledger-chunk?since=endIndex+1
+        Client->>+Backup: GET /node/ledger_chunk?since=endIndex+1
         Note over Backup: Backup node does not yet have a committed chunk starting at endIndex+1
-        Backup->>-Client: 308 Location: https://primary/node/ledger-chunk?since=endIndex+1
-        Client->>+Primary: GET /node/ledger-chunk?since=endIndex+1
-        Primary->>-Client: 308 Location: /node/ledger-chunk/ledger_endIndex+1_nextEndIndex.committed
-        Client->>+Primary: GET /node/ledger-chunk/ledger_startIndex_endIndex.committed
+        Backup->>-Client: 308 Location: https://primary/node/ledger_chunk?since=endIndex+1
+        Client->>+Primary: GET /node/ledger_chunk?since=endIndex+1
+        Primary->>-Client: 308 Location: /node/ledger_chunk/ledger_endIndex+1_nextEndIndex.committed
+        Client->>+Primary: GET /node/ledger_chunk/ledger_startIndex_endIndex.committed
         Note over Primary: But the Primary node has the most recent chunk already
         Primary->>-Client: 200 <Chunk Contents>
 
@@ -95,18 +95,18 @@ then the following sequence can occur:
 .. mermaid::
 
     sequenceDiagram
-        Client->>+Primary: GET /node/ledger-chunk?since=51
-        Primary->>-Client: 308 Location: https://backup/node/ledger-chunk?since=51
-        Client->>+Backup: GET /node/ledger-chunk?since=51
-        Backup->>-Client: 308 Location: /node/ledger-chunk/ledger_51-100.committed
-        Client->>+Backup: GET /node/ledger-chunk/ledger_51-100.committed
+        Client->>+Primary: GET /node/ledger_chunk?since=51
+        Primary->>-Client: 308 Location: https://backup/node/ledger_chunk?since=51
+        Client->>+Backup: GET /node/ledger_chunk?since=51
+        Backup->>-Client: 308 Location: /node/ledger_chunk/ledger_51-100.committed
+        Client->>+Backup: GET /node/ledger_chunk/ledger_51-100.committed
         Backup->>-Client: 200 <Chunk Contents>
-        Client->>+Backup: GET /node/ledger-chunk?since=101
+        Client->>+Backup: GET /node/ledger_chunk?since=101
         Note over Backup: Backup node does not have 101-150
-        Backup->>-Client: 308 Location: https://primary/node/ledger-chunk?since=51
-        Client->>+Primary: GET /node/ledger-chunk?since=101
+        Backup->>-Client: 308 Location: https://primary/node/ledger_chunk?since=51
+        Client->>+Primary: GET /node/ledger_chunk?since=101
 
-2. :http:GET:`/node/ledger-chunk/{chunk_name}` and :http:HEAD:`/node/ledger-chunk/{chunk_name}`
+2. :http:GET:`/node/ledger_chunk/{chunk_name}` and :http:HEAD:`/node/ledger_chunk/{chunk_name}`
 
 These endpoints allow downloading a specific ledger chunk by name, where `<chunk-name>` is of the form `ledger_<start_seqno>-<end_seqno>.committed`.
 They support the HTTP `Range` header for partial downloads, and the `HEAD` method for clients to query metadata such as the total size without downloading the full chunk.
@@ -126,7 +126,7 @@ This allows clients to verify the integrity of downloaded files and avoid re-dow
 ETag and If-None-Match
 ^^^^^^^^^^^^^^^^^^^^^^
 
-``GET /node/ledger-chunk/{chunk_name}`` supports ``ETag`` and ``If-None-Match`` headers, allowing clients to atomically check whether a chunk (or a range of a chunk) has changed and re-download it in a single request, without needing a separate metadata query first.
+``GET /node/ledger_chunk/{chunk_name}`` supports ``ETag`` and ``If-None-Match`` headers, allowing clients to atomically check whether a chunk (or a range of a chunk) has changed and re-download it in a single request, without needing a separate metadata query first.
 Every successful ``GET`` response includes an ``ETag`` header whose value uses the `RFC 9530 <https://www.rfc-editor.org/rfc/rfc9530>`_ digest format: ``"sha-256=:<base64_digest>:"``, where ``<base64_digest>`` is the base64-encoded SHA-256 digest of the returned content (which may be a sub-range when the ``Range`` header is used).
 
 .. note:: ETag values must be surrounded by double quotes, as per `RFC 7232 <https://www.rfc-editor.org/rfc/rfc7232#section-2.3>`_.
@@ -140,7 +140,7 @@ When the client already holds a chunk and wants to check if it has changed, it s
 
     sequenceDiagram
         Note over Client: Client already has chunk with known ETag
-        Client->>+Node: GET /node/ledger-chunk/ledger_1-100.committed<br/>If-None-Match: "sha-256=:47DEQpj8HBSa+/TImW...=:"
+        Client->>+Node: GET /node/ledger_chunk/ledger_1-100.committed<br/>If-None-Match: "sha-256=:47DEQpj8HBSa+/TImW...=:"
         Note over Node: Computes digest, matches If-None-Match
         Node->>-Client: 304 Not Modified<br/>ETag: "sha-256=:47DEQpj8HBSa+/TImW...=:"
         Note over Client: No body transferred, client keeps existing copy
@@ -151,7 +151,7 @@ If the ``If-None-Match`` ETag does not match the current content (e.g. the clien
 
     sequenceDiagram
         Note over Client: Client sends an ETag that does not match
-        Client->>+Node: GET /node/ledger-chunk/ledger_1-100.committed<br/>If-None-Match: "sha-256=:AAAA...=:"
+        Client->>+Node: GET /node/ledger_chunk/ledger_1-100.committed<br/>If-None-Match: "sha-256=:AAAA...=:"
         Note over Node: Computes digest, does not match If-None-Match
         Node->>-Client: 200 OK<br/>ETag: "sha-256=:47DEQpj8HBSa+/TImW...=:"<br/><Chunk Contents>
         Note over Client: Client stores chunk and new ETag for future requests

doc/schemas/node_openapi.json

@@ -1200,9 +1200,9 @@
         }
       }
     },
-    "/node/ledger-chunk": {
+    "/node/ledger_chunk": {
       "get": {
-        "description": "Redirect to the corresponding /node/ledger-chunk/{chunk_name} endpoint for the ledger chunk including the sequence number specified in the 'since' query parameter.",
+        "description": "Redirect to the corresponding /node/ledger_chunk/{chunk_name} endpoint for the ledger chunk including the sequence number specified in the 'since' query parameter.",
         "operationId": "GetNodeLedgerChunk",
         "parameters": [
           {
@@ -1228,7 +1228,7 @@
         }
       },
       "head": {
-        "description": "Redirect to the corresponding /node/ledger-chunk/{chunk_name} endpoint for the ledger chunk including the sequence number specified in the 'since' query parameter.",
+        "description": "Redirect to the corresponding /node/ledger_chunk/{chunk_name} endpoint for the ledger chunk including the sequence number specified in the 'since' query parameter.",
         "operationId": "HeadNodeLedgerChunk",
         "parameters": [
           {
@@ -1254,7 +1254,7 @@
         }
       }
     },
-    "/node/ledger-chunk/{chunk_name}": {
+    "/node/ledger_chunk/{chunk_name}": {
       "get": {
         "description": "Download a specific ledger chunk by name. Supports HTTP Range header for partial downloads.",
         "operationId": "GetNodeLedgerChunkChunkName",

src/node/rpc/file_serving_handlers.h

@@ -719,7 +719,7 @@ namespace ccf::node
         const auto chunk_filename = chunk_path.value().filename();
 
         auto redirect_url = fmt::format(
-          "https://{}/node/ledger-chunk/{}", address.value(), chunk_filename);
+          "https://{}/node/ledger_chunk/{}", address.value(), chunk_filename);
         LOG_DEBUG_FMT("Redirecting to ledger chunk: {}", redirect_url);
         ctx.rpc_ctx->set_response_header(
           ccf::http::headers::LOCATION, redirect_url);
@@ -746,7 +746,7 @@ namespace ccf::node
         }
 
         auto location = fmt::format(
-          "https://{}/node/ledger-chunk?{}={}",
+          "https://{}/node/ledger_chunk?{}={}",
           address.value(),
           file_since_param_key,
           since_idx);
@@ -773,7 +773,7 @@ namespace ccf::node
           if (address.has_value())
           {
             auto location =
-              fmt::format("https://{}/node/ledger-chunk", address.value());
+              fmt::format("https://{}/node/ledger_chunk", address.value());
             location += fmt::format("?{}={}", file_since_param_key, since_idx);
 
             ctx.rpc_ctx->set_response_header(http::headers::LOCATION, location);
@@ -799,27 +799,27 @@ namespace ccf::node
     };
     registry
       .make_read_only_endpoint(
-        "/ledger-chunk", HTTP_HEAD, find_chunk, no_auth_required)
+        "/ledger_chunk", HTTP_HEAD, find_chunk, no_auth_required)
       .set_forwarding_required(endpoints::ForwardingRequired::Never)
       .add_query_parameter<ccf::SeqNo>(
         file_since_param_key, ccf::endpoints::RequiredParameter)
       .require_operator_feature(endpoints::OperatorFeature::LedgerChunkRead)
       .set_openapi_summary("Ledger chunk metadata")
       .set_openapi_description(
-        "Redirect to the corresponding /node/ledger-chunk/{chunk_name} "
+        "Redirect to the corresponding /node/ledger_chunk/{chunk_name} "
         "endpoint for the ledger chunk including the sequence number specified "
         "in the 'since' query parameter.")
       .install();
     registry
       .make_read_only_endpoint(
-        "/ledger-chunk", HTTP_GET, find_chunk, no_auth_required)
+        "/ledger_chunk", HTTP_GET, find_chunk, no_auth_required)
       .set_forwarding_required(endpoints::ForwardingRequired::Never)
       .add_query_parameter<ccf::SeqNo>(
         file_since_param_key, ccf::endpoints::RequiredParameter)
       .require_operator_feature(endpoints::OperatorFeature::LedgerChunkRead)
       .set_openapi_summary("Download ledger chunk")
       .set_openapi_description(
-        "Redirect to the corresponding /node/ledger-chunk/{chunk_name} "
+        "Redirect to the corresponding /node/ledger_chunk/{chunk_name} "
         "endpoint for the ledger chunk including the sequence number specified "
         "in the 'since' query parameter.")
       .install();
@@ -938,7 +938,7 @@ namespace ccf::node
     };
     registry
       .make_command_endpoint(
-        "/ledger-chunk/{chunk_name}",
+        "/ledger_chunk/{chunk_name}",
         HTTP_HEAD,
         get_ledger_chunk,
         no_auth_required)
@@ -951,7 +951,7 @@ namespace ccf::node
       .install();
     registry
       .make_command_endpoint(
-        "/ledger-chunk/{chunk_name}",
+        "/ledger_chunk/{chunk_name}",
         HTTP_GET,
         get_ledger_chunk,
         no_auth_required)