From 69bd32c574b477c59dc33992748b8e88eff7a12d Mon Sep 17 00:00:00 2001 From: bhartnett <51288821+bhartnett@users.noreply.github.com> Date: Tue, 3 Dec 2024 11:36:18 +0800 Subject: [PATCH] PR comment updates. --- jsonrpc/src/content/results.json | 19 ++++++++++++++++--- jsonrpc/src/methods/beacon.json | 2 +- jsonrpc/src/methods/history.json | 2 +- jsonrpc/src/methods/state.json | 2 +- 4 files changed, 19 insertions(+), 6 deletions(-) diff --git a/jsonrpc/src/content/results.json b/jsonrpc/src/content/results.json index 6aec591..b991f74 100644 --- a/jsonrpc/src/content/results.json +++ b/jsonrpc/src/content/results.json @@ -222,10 +222,23 @@ }, "PutContentResult": { "name": "PutContentResult", - "description": "Returns the number of peers that the content was gossiped to", + "description": "Returns the number of peers that the content was gossiped to and a flag indicating whether the content was stored locally or not.", "schema": { - "title": "number of peers", - "type": "number" + "type": "object", + "required": [ + "peerCount", + "storedLocally" + ], + "properties": { + "peerCount": { + "description": "Indicates how many peers the content was gossiped to.", + "type": "number" + }, + "storedLocally": { + "description": "Indicates whether the content was stored locally or not.", + "type": "boolean" + } + } } } } diff --git a/jsonrpc/src/methods/beacon.json b/jsonrpc/src/methods/beacon.json index 70bfa57..dd69f36 100644 --- a/jsonrpc/src/methods/beacon.json +++ b/jsonrpc/src/methods/beacon.json @@ -200,7 +200,7 @@ }, { "name": "portal_beaconPutContent", - "summary": "Store the content in the local database if storage criteria is met, then send the content to interested peers. Clients may choose to send to some or all peers.", + "summary": "Store the content in the local database if storage criteria is met, then send the content to interested peers using the client's default gossip mechanisms.", "params": [ { "$ref": "#/components/contentDescriptors/ContentKey" diff --git a/jsonrpc/src/methods/history.json b/jsonrpc/src/methods/history.json index 43cffb2..d0c166d 100644 --- a/jsonrpc/src/methods/history.json +++ b/jsonrpc/src/methods/history.json @@ -192,7 +192,7 @@ }, { "name": "portal_historyPutContent", - "summary": "Store the content in the local database if storage criteria is met, then send the content to interested peers. Clients may choose to send to some or all peers.", + "summary": "Store the content in the local database if storage criteria is met, then send the content to interested peers using the client's default gossip mechanisms.", "params": [ { "$ref": "#/components/contentDescriptors/ContentKey" diff --git a/jsonrpc/src/methods/state.json b/jsonrpc/src/methods/state.json index 4d9bd25..bc16a28 100644 --- a/jsonrpc/src/methods/state.json +++ b/jsonrpc/src/methods/state.json @@ -186,7 +186,7 @@ }, { "name": "portal_statePutContent", - "summary": "Store the content in the local database if storage criteria is met, then send the content to interested peers. Clients may choose to send to some or all peers.", + "summary": "Store the content in the local database if storage criteria is met, then send the content to interested peers using the client's default gossip mechanisms.", "params": [ { "$ref": "#/components/contentDescriptors/ContentKey"