[REST] adding basic documentation #5329

pull jonasschnelli wants to merge 1 commits into bitcoin:master from jonasschnelli:rest-documentation changing 1 files +24 −0

jonasschnelli commented at 3:43 PM on November 20, 2014: contributor

thanks for improving the grammar.
jonasschnelli force-pushed on Nov 20, 2014
in doc/REST-interface.md:None in 1e0e3a5b04 outdated
```
   0 | @@ -0,0 +1,24 @@
   1 | +Unauthenticated REST Interface
   2 | +==============================
   3 | +
   4 | +The REST API can be enabled with the `-rest` option.
```
Diapolo commented at 4:01 PM on November 20, 2014:

I can't find that option in my codebase, was it forgotten?

sipa commented at 4:03 PM on November 20, 2014:

#5326 is mostly not yet merged
jonasschnelli commented at 6:15 PM on November 20, 2014: contributor

Yes. Sorry. I did split this pull off but it's based on #5326. It did this to no lose overview and separate discussions.

in doc/REST-interface.md:None in 1e0e3a5b04 outdated

  19 | +
  20 | +For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option.
  21 | +
  22 | +Risks
  23 | +-------------
  24 | +Running a webbrowser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:1234/tx/json/1234567890">` which might breaks the nodes privacy.

laanwj commented at 9:11 AM on November 24, 2014:

s/might breaks/might break/

jonasschnelli force-pushed on Nov 26, 2014
jonasschnelli commented at 1:26 PM on November 26, 2014: contributor

Updated with a typo-fix mentioned by @laanwj
[REST] adding basic documentation 199627c94c
jonasschnelli force-pushed on Nov 26, 2014
laanwj added the label Docs and Output on Dec 5, 2014
laanwj merged this on Dec 5, 2014
laanwj closed this on Dec 5, 2014
laanwj referenced this in commit c932c47e34 on Dec 5, 2014
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels