slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: web: improve /add docs (#1026)

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-05-14 09:27:41 -07:00
parent 71ec1e3986
commit dfb9574433
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
hledger-web/hledger-web.m4.md
View File

@ -194,10 +194,11 @@ more attention than hledger-api in future:
Also, you can append a new transaction to the journal by sending a PUT request to `/add` (hledger-web only). Also, you can append a new transaction to the journal by sending a PUT request to `/add` (hledger-web only).
As with the web UI's add form, hledger-web must be started with the `add` capability for this (enabled by default). As with the web UI's add form, hledger-web must be started with the `add` capability for this (enabled by default).
The payload should be a valid hledger transaction as JSON, similar to what you get from `/transactions`/`accounttransactions`. The payload should be a valid hledger transaction as JSON, similar to what you get from `/transactions` or `/accounttransactions`.
Or, a useful way to generate test data is with the `readJsonFile`/`writeJsonFile` helpers in Hledger.Web.Json, Another way to generate test data is with the `readJsonFile`/`writeJsonFile` helpers in Hledger.Web.Json,
which will read or write any of hledger's JSON-capable types from or to a file. which read or write any of hledger's [JSON-capable types](https://github.com/simonmichael/hledger/blob/master/hledger-web/Hledger/Web/Json.hs#L45)
from or to a file.
Eg here we write the first transaction of a sample journal: Eg here we write the first transaction of a sample journal:
```shell ```shell
$ make ghci-web $ make ghci-web
@ -206,9 +207,9 @@ $ make ghci-web
>>> :q >>> :q
$ python -m json.tool <txn.json >txn.pretty.json # optional: make human-readable $ python -m json.tool <txn.json >txn.pretty.json # optional: make human-readable
``` ```
([example, discussion](https://github.com/simonmichael/hledger/issues/316#issuecomment-465858507)) ([sample output & discussion](https://github.com/simonmichael/hledger/issues/316#issuecomment-465858507))
And here's how to test `/add` with curl: And here's how to test adding that with curl:
```shell ```shell
$ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.pretty.json; echo $ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.pretty.json; echo
``` ```