Merged
Conversation
ziogaschr
commented
Jan 20, 2021
26da9ed to
735fd88
Compare
meowsbits
approved these changes
Jan 20, 2021
Contributor
meowsbits
left a comment
There was a problem hiding this comment.
LGTM.
Example snippet provided as generated locally:
{
"openrpc": "1.2.6",
"info": {
"title": "Core-Geth RPC API",
"version": "1.11.22-unstable/generated-at:2021-01-20T15:07:56-06:00"
},
"externalDocs": {
"description": "ETC Labs Documentation",
"url": "https://etclabscore.github.io/core-geth/"
},
"servers": [
{
"url": "ws://127.0.0.1:8546",
"name": "tcp"
}
],
"methods": [
{
"name": "admin_addPeer",
"description": "```go\nfunc (api *privateAdminAPI) AddPeer(url string) (bool, error) {\n\tserver := api.node.Server()\n\tif server == nil {\n\t\treturn false, ErrNodeStopped\n\t}\n\tnode, err := enode.Parse(enode.ValidSchemes, url)\n\tif err != nil {\n\t\treturn false, fmt.Errorf(\"invalid enode: %v\", err)\n\t}\n\tserver.AddPeer(node)\n\treturn true, nil\n}// AddPeer requests connecting to a remote node, and also maintaining the new\n// connection at all times, even reconnecting if it is lost.\n\n```",
"summary": "AddPeer requests connecting to a remote node, and also maintaining the new\nconnection at all times, even reconnecting if it is lost.\n",
"paramStructure": "by-position",
"params": [
{
"name": "url",
"description": "string",
"summary": "",
"schema": {
"type": ["string"]
},
"required": true,
"deprecated": false
}
],
"result": {
"name": "bool",
"description": "bool",
"summary": "",
"schema": {
"type": ["boolean"]
},
"required": true,
"deprecated": false
},
"deprecated": false,
"externalDocs": {
"description": "Github remote link",
"url": "https://github.com/etclabscore/core-geth/blob/master/node/api.go#L65"
}
},
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The RPC discovery document was returning links to GitHub repo of
ethereum/go-ethereum. This PR makes those links, link back to ouretclabscore/core-gethrepo.On top of that, this PR also adds link to our documentation site for the whole discovery document. This link has to be updated to the final page made available by #306.
Fixes #297