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

;doc: JSON output, web: link to OpenAPI spec

Browse Source
This commit is contained in:
Simon Michael 2024-05-31 19:41:23 -10:00
parent 88f70eba6b
commit a5a067204e
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -260,6 +260,9 @@ Most of the JSON corresponds to hledger's data types; for details of what the fi
and click on the various data types, eg and click on the various data types, eg
[Transaction](https://hackage.haskell.org/package/hledger-lib-1.17.1/docs/Hledger-Data-Types.html#t:Transaction). [Transaction](https://hackage.haskell.org/package/hledger-lib-1.17.1/docs/Hledger-Data-Types.html#t:Transaction).
And for a higher level understanding, see the [journal docs](hledger.html#journal). And for a higher level understanding, see the [journal docs](hledger.html#journal).
There is also a basic [OpenAPI specification][openapi.yaml].
[openapi.yaml]: https://github.com/simonmichael/hledger/blob/master/hledger-web/config/openapi.yaml
In some cases there is outer JSON corresponding to a "Report" type. In some cases there is outer JSON corresponding to a "Report" type.
To understand that, go to the To understand that, go to the

3
hledger/hledger.m4.md
View File

@ -604,6 +604,7 @@ Some notes about the various output formats:
representation of hledger's internal data types. To understand the representation of hledger's internal data types. To understand the
JSON, read the Haskell type definitions, which are mostly in JSON, read the Haskell type definitions, which are mostly in
<https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs>. <https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs>.
[hledger-web's OpenAPI specification][openapi.yaml] may also be relevant.
<!-- <!--
- The JSON output from hledger commands is essentially the same as the - The JSON output from hledger commands is essentially the same as the
@ -626,6 +627,8 @@ Some notes about the various output formats:
find otherwise, please let us know. find otherwise, please let us know.
(Cf [#1195](https://github.com/simonmichael/hledger/issues/1195)) (Cf [#1195](https://github.com/simonmichael/hledger/issues/1195))
[openapi.yaml]: https://github.com/simonmichael/hledger/blob/master/hledger-web/config/openapi.yaml
### SQL output ### SQL output
- This is not yet much used; real-world feedback is welcome. - This is not yet much used; real-world feedback is welcome.