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

;web: tweak JSON PUT doc

Browse Source
This commit is contained in:
Simon Michael 2020-05-21 09:57:27 -07:00
parent 0f922b3850
commit 7ccbfa11ac
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -218,7 +218,8 @@ it provides only these routes.):
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).
Note the payload must be the full exact JSON representation of a hledger transaction. Note the payload must be the full exact JSON representation of a hledger transaction
(partial JSON won't do).
You can download some sample JSON from `/transactions` or `/accounttransactions`, You can download some sample JSON from `/transactions` or `/accounttransactions`,
or export it using hledger-lib's `writeJsonFile` helper (there's also `readJsonFile` for testing): or export it using hledger-lib's `writeJsonFile` helper (there's also `readJsonFile` for testing):
@ -236,7 +237,11 @@ $ python -m json.tool txn.json >pretty
$ mv pretty txn.json $ mv pretty txn.json
``` ```
Here's how it looks as of hledger-1.17: Here's how it looks as of hledger-1.17.
(Note this corresponds to the Transaction data type - use its definition in
[Hledger.Data.Types](https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs)
for reference):
```json ```json
{ {
"tcode": "", "tcode": "",