Skip to content

Commit 69bd32c

Browse files
bhartnettKolbyML
authored andcommitted
PR comment updates.
1 parent fed487d commit 69bd32c

File tree

4 files changed

+19
-6
lines changed

4 files changed

+19
-6
lines changed

jsonrpc/src/content/results.json

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,10 +222,23 @@
222222
},
223223
"PutContentResult": {
224224
"name": "PutContentResult",
225-
"description": "Returns the number of peers that the content was gossiped to",
225+
"description": "Returns the number of peers that the content was gossiped to and a flag indicating whether the content was stored locally or not.",
226226
"schema": {
227-
"title": "number of peers",
228-
"type": "number"
227+
"type": "object",
228+
"required": [
229+
"peerCount",
230+
"storedLocally"
231+
],
232+
"properties": {
233+
"peerCount": {
234+
"description": "Indicates how many peers the content was gossiped to.",
235+
"type": "number"
236+
},
237+
"storedLocally": {
238+
"description": "Indicates whether the content was stored locally or not.",
239+
"type": "boolean"
240+
}
241+
}
229242
}
230243
}
231244
}

jsonrpc/src/methods/beacon.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@
200200
},
201201
{
202202
"name": "portal_beaconPutContent",
203-
"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.",
203+
"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.",
204204
"params": [
205205
{
206206
"$ref": "#/components/contentDescriptors/ContentKey"

jsonrpc/src/methods/history.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@
192192
},
193193
{
194194
"name": "portal_historyPutContent",
195-
"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.",
195+
"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.",
196196
"params": [
197197
{
198198
"$ref": "#/components/contentDescriptors/ContentKey"

jsonrpc/src/methods/state.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
},
187187
{
188188
"name": "portal_statePutContent",
189-
"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.",
189+
"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.",
190190
"params": [
191191
{
192192
"$ref": "#/components/contentDescriptors/ContentKey"

0 commit comments

Comments
 (0)