Rename portal_*Gossip JSON-RPC endpoint to portal_*PutContent #346
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 stored in the local database if storage criteria is met before being returned.", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/ContentKey" | ||
|
|
@@ -135,9 +135,11 @@ | |
| "result": { | ||
| "$ref": "#/components/contentDescriptors/GetContentResult" | ||
| }, | ||
| "errors": [ | ||
| { | ||
| "$ref": "#/components/errors/ContentNotFoundError" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "portal_historyTraceGetContent", | ||
|
|
@@ -150,9 +152,11 @@ | |
| "result": { | ||
| "$ref": "#/components/contentDescriptors/TraceGetContentResult" | ||
| }, | ||
| "errors": [ | ||
| { | ||
| "$ref": "#/components/errors/ContentNotFoundErrorWithTrace" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "portal_historyStore", | ||
|
|
@@ -180,13 +184,15 @@ | |
| "result": { | ||
| "$ref": "#/components/contentDescriptors/LocalContentResult" | ||
| }, | ||
| "errors": [ | ||
| { | ||
| "$ref": "#/components/errors/ContentNotFoundError" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "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.", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/ContentKey" | ||
|
|
@@ -196,7 +202,7 @@ | |
| } | ||
| ], | ||
| "result": { | ||
| "$ref": "#/components/contentDescriptors/PutContentResult" | ||
| } | ||
| } | ||
| ] | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -126,7 +126,7 @@ | |
| }, | ||
| { | ||
| "name": "portal_stateGetContent", | ||
| "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 stored in the local database if storage criteria is met before being returned.", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/ContentKey" | ||
|
|
@@ -185,8 +185,8 @@ | |
| }] | ||
| }, | ||
| { | ||
| "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.", | ||
| "params": [ | ||
| { | ||
| "$ref": "#/components/contentDescriptors/ContentKey" | ||
|
|
@@ -196,7 +196,7 @@ | |
| } | ||
| ], | ||
| "result": { | ||
| "$ref": "#/components/contentDescriptors/PutContentResult" | ||
| } | ||
| } | ||
| ] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like this should also return information about whether the content was added to the database, and possibly if the data was already in the database.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Returning a boolean to indicate if the data was written to the database makes sense. This can be implemented in the same way as portal_*Store currently does. Indicating if the data was already in the database would require a second database lookup to check if the key/data exists before overwriting so I'd say we shouldn't do this for performance reasons.