Skip to content

Commit

Permalink
PR comment updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
bhartnett committed Dec 3, 2024
1 parent 64785fa commit a12e4fc
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 6 deletions.
19 changes: 16 additions & 3 deletions jsonrpc/src/content/results.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
}
}
2 changes: 1 addition & 1 deletion jsonrpc/src/methods/beacon.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion jsonrpc/src/methods/history.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion jsonrpc/src/methods/state.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit a12e4fc

Please sign in to comment.