Skip to content

WIP: Add JSON-RPC interface documentation #14458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
promag wants to merge 1 commit into from
Closed

WIP: Add JSON-RPC interface documentation #14458

promag wants to merge 1 commit into from

Conversation

@promag
Copy link
Contributor

@promag promag commented Oct 10, 2018 •
edited
Loading

This is poorly written and structured but I want to know if it makes sense.

The idea is not to copy -help outputs.

Closes #14448.

Follow ups:

@kristapsk
Copy link
Contributor

kristapsk commented Oct 10, 2018

Concept ACK

@fanquake fanquake added the Docs label Oct 10, 2018
@ch4ot1c
Copy link
Contributor

ch4ot1c commented Oct 10, 2018

Concept ACK 👍

@sipa sipa changed the title Add JSON-RCP interaface documentation Add JSON-RPC interaface documentation Oct 11, 2018
@sipa sipa changed the title Add JSON-RPC interaface documentation Add JSON-RPC interface documentation Oct 11, 2018
@sipa
Copy link
Member

sipa commented Oct 12, 2018

Concept ACK

jnewbery
jnewbery reviewed Oct 12, 2018
View reviewed changes
Copy link
Contributor

@jnewbery jnewbery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Concept ACK. Looks good so far!

doc/JSON-RPC-interface.md Outdated
Copy link
Contributor

@jnewbery jnewbery Oct 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove 'issue '

practicalswift
practicalswift reviewed Oct 13, 2018
View reviewed changes
doc/JSON-RPC-interface.md Outdated
Copy link
Contributor

@practicalswift practicalswift Oct 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename this file json-rpc-interface.md to make it consistent with the other files.

Copy link
Contributor

@ch4ot1c ch4ot1c Oct 14, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think matching REST-interface.md is the intention - should it be lowercase too?

practicalswift
practicalswift reviewed Oct 13, 2018
View reviewed changes
doc/JSON-RPC-interface.md Outdated
Copy link
Contributor

@practicalswift practicalswift Oct 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Increment header levels one level at a time. You might want to use mdl to check the Markdown formatting :-)

@promag promag changed the title Add JSON-RPC interface documentation WIP: Add JSON-RPC interface documentation Oct 20, 2018
@DrahtBot DrahtBot mentioned this pull request Oct 28, 2018
Merged
@DrahtBot
Copy link
Contributor

DrahtBot commented Oct 28, 2018

Reviewers, this pull request conflicts with the following ones:

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@laanwj
Copy link
Member

laanwj commented Jan 15, 2019

@harding might want to have a look here as this adds technical documentation

@promag promag force-pushed the 2018-10-doc-json-rpc branch from 880be1c to 29eb75d Compare January 15, 2019 15:17
@promag
Copy link
Contributor Author

promag commented Jan 15, 2019 •
edited
Loading

Rebased, still WIP though. One way to move this forward is to improve in smaller PR's.

@Sjors
Copy link
Member

Sjors commented Jan 15, 2019

Concept ACK on general documentation of how to use the RPC, as well as maybe providing more context for specific issues.

However, I'm worried that maintaining this list of bitcoind options is going to get out of sync. I would prefer a release-time script that turns man pages into mark down: https://github.com/bitcoin/bitcoin/blob/master/doc/man/bitcoind.1

maflcko
maflcko reviewed Jan 15, 2019
View reviewed changes
@harding harding mentioned this pull request Jan 21, 2019
Merged
@harding
Copy link
Contributor

harding commented Jan 21, 2019

Suggestion: the document could mention that Bitcoin Core allows money values to be passed as either a float or a string. That's an unexpected feature, but one that can be quite nice for users of JSON implementations that aren't good at high-precision.

laanwj added a commit that referenced this pull request Jan 24, 2019
@laanwj
Merge #15223: Doc: add information about security to the JSON-RPC doc
5eb32d2 
5a5ea93 Doc: add information about security to the JSON-RPC doc (David A. Harding)

Pull request description:

  This documents some information about using the RPC interface securely, as suggested in bitcoin-core/bitcoincore.org#637 by @luke-jr and @TheBlueMatt.  I think it should fit in well with #14458, but is not dependent on it (and shouldn't have any significant merge conflicts with it).

Tree-SHA512: e09d82c3029ed17a8bcf50722ea25a8c6c514731f3bce01908cbb6fe48bc96a3068a025beabebc602d18e1bc0dc3f2602848abc05dca1d3efe2a988ee50068c0
fanquake
fanquake reviewed Feb 17, 2019
View reviewed changes
Sjors
Sjors reviewed Feb 19, 2019
View reviewed changes
Copy link
Member

@Sjors Sjors left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. I suggest we remove the "todo" comments, merge this and improve it after the 0.18 release.

@promag promag force-pushed the 2018-10-doc-json-rpc branch from 29eb75d to fa90c0c Compare April 14, 2019 09:52
@promag
Copy link
Contributor Author

promag commented Apr 14, 2019

Rebased and removed configurations section, kind of agree with @Sjors #14458 (comment). What left isn't worth I think, so closing.

@promag promag closed this Apr 14, 2019
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jul 1, 2021
@laanwj @PastaPastaPasta
Merge bitcoin#15223: Doc: add information about security to the JSON-…
01c5f28 
…RPC doc

5a5ea93 Doc: add information about security to the JSON-RPC doc (David A. Harding)

Pull request description:

  This documents some information about using the RPC interface securely, as suggested in bitcoin-core/bitcoincore.org#637 by @luke-jr and @TheBlueMatt.  I think it should fit in well with bitcoin#14458, but is not dependent on it (and shouldn't have any significant merge conflicts with it).

Tree-SHA512: e09d82c3029ed17a8bcf50722ea25a8c6c514731f3bce01908cbb6fe48bc96a3068a025beabebc602d18e1bc0dc3f2602848abc05dca1d3efe2a988ee50068c0
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Sep 11, 2021
@laanwj @PastaPastaPasta
Merge bitcoin#15223: Doc: add information about security to the JSON-…
63a21fd 
…RPC doc

5a5ea93 Doc: add information about security to the JSON-RPC doc (David A. Harding)

Pull request description:

  This documents some information about using the RPC interface securely, as suggested in bitcoin-core/bitcoincore.org#637 by @luke-jr and @TheBlueMatt.  I think it should fit in well with bitcoin#14458, but is not dependent on it (and shouldn't have any significant merge conflicts with it).

Tree-SHA512: e09d82c3029ed17a8bcf50722ea25a8c6c514731f3bce01908cbb6fe48bc96a3068a025beabebc602d18e1bc0dc3f2602848abc05dca1d3efe2a988ee50068c0
vijaydasmp pushed a commit to vijaydasmp/dash that referenced this pull request Sep 12, 2021
@laanwj @vijaydasmp
Merge bitcoin#15223: Doc: add information about security to the JSON-…
7db1a44 
…RPC doc

5a5ea93 Doc: add information about security to the JSON-RPC doc (David A. Harding)

Pull request description:

  This documents some information about using the RPC interface securely, as suggested in bitcoin-core/bitcoincore.org#637 by @luke-jr and @TheBlueMatt.  I think it should fit in well with bitcoin#14458, but is not dependent on it (and shouldn't have any significant merge conflicts with it).

Tree-SHA512: e09d82c3029ed17a8bcf50722ea25a8c6c514731f3bce01908cbb6fe48bc96a3068a025beabebc602d18e1bc0dc3f2602848abc05dca1d3efe2a988ee50068c0
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@fanquake fanquake fanquake left review comments

+5 more reviewers

@Sjors Sjors Sjors left review comments

@jnewbery jnewbery jnewbery left review comments

@ch4ot1c ch4ot1c ch4ot1c left review comments

@maflcko maflcko maflcko left review comments

@practicalswift practicalswift practicalswift left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.