Skip to content

Commit

Permalink
Update validation wording.
Browse files Browse the repository at this point in the history
  • Loading branch information
bhartnett committed Oct 18, 2024
1 parent f7befbc commit c4aae4f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
4 changes: 2 additions & 2 deletions jsonrpc/src/methods/beacon.json
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
},
{
"name": "portal_beaconGetContent",
"summary": "Get content from the local database if it exists, otherwise look up the target content key in the network. After fetching from the network the content is validated and stored in the local database if storage criteria is met before being returned.",
"summary": "Get content from the local database if it exists, otherwise look up the target content key in the network. After fetching from the network the content is validated for correctness and stored in the local database if storage criteria is met before being returned.",
"params": [
{
"$ref": "#/components/contentDescriptors/ContentKey"
Expand Down Expand Up @@ -200,7 +200,7 @@
},
{
"name": "portal_beaconPutContent",
"summary": "Validate and store the provided 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": "Validate that the content is well formed and store it 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.",
"params": [
{
"$ref": "#/components/contentDescriptors/ContentKey"
Expand Down
28 changes: 17 additions & 11 deletions jsonrpc/src/methods/history.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
},
{
"name": "portal_historyGetContent",
"summary": "Get content from the local database if it exists, otherwise look up the target content key in the network. After fetching from the network the content is validated and stored in the local database if storage criteria is met before being returned.",
"summary": "Get content from the local database if it exists, otherwise look up the target content key in the network. After fetching from the network the content is validated for correctness and stored in the local database if storage criteria is met before being returned.",
"params": [
{
"$ref": "#/components/contentDescriptors/ContentKey"
Expand All @@ -135,9 +135,11 @@
"result": {
"$ref": "#/components/contentDescriptors/GetContentResult"
},
"errors":[{
"$ref": "#/components/errors/ContentNotFoundError"
}]
"errors": [
{
"$ref": "#/components/errors/ContentNotFoundError"
}
]
},
{
"name": "portal_historyTraceGetContent",
Expand All @@ -150,9 +152,11 @@
"result": {
"$ref": "#/components/contentDescriptors/TraceGetContentResult"
},
"errors":[{
"$ref": "#/components/errors/ContentNotFoundErrorWithTrace"
}]
"errors": [
{
"$ref": "#/components/errors/ContentNotFoundErrorWithTrace"
}
]
},
{
"name": "portal_historyStore",
Expand Down Expand Up @@ -180,13 +184,15 @@
"result": {
"$ref": "#/components/contentDescriptors/LocalContentResult"
},
"errors":[{
"$ref": "#/components/errors/ContentNotFoundError"
}]
"errors": [
{
"$ref": "#/components/errors/ContentNotFoundError"
}
]
},
{
"name": "portal_historyPutContent",
"summary": "Validate and store the provided 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": "Validate that the content is well formed and store it 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.",
"params": [
{
"$ref": "#/components/contentDescriptors/ContentKey"
Expand Down

0 comments on commit c4aae4f

Please sign in to comment.