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

api: document the --swagger option

Browse Source
This commit is contained in:
Simon Michael 2016-04-18 17:07:11 -07:00
parent d317836442
commit 53e8b928ea
3 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
hledger-api/doc/hledger-api.1
View File

@ -12,6 +12,10 @@ hledger\-api \- web API server for the hledger accounting tool
.PD 0 .PD 0
.P .P
.PD .PD
\f[C]hledger\-api\ \-\-swagger\f[]
.PD 0
.P
.PD
\f[C]hledger\ api\ \-\-\ [OPTIONS]\f[] \f[C]hledger\ api\ \-\-\ [OPTIONS]\f[]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
@ -32,10 +36,12 @@ For more about the format, see hledger(1) or hledger_journal(5).
.PP .PP
The server listens on port 8001, or another specified with The server listens on port 8001, or another specified with
\f[C]\-p\ PORT\f[]. \f[C]\-p\ PORT\f[].
.PP
Note there is no built\-in access control, so you will need to hide Note there is no built\-in access control, so you will need to hide
hledger\-api behind an authenticating proxy if you want to restrict hledger\-api behind an authenticating proxy if you want to restrict
access. access.
.PP
If invoked as \f[C]hledger\-api\ \-\-swagger\f[], instead of starting a
server the API docs will be printed in Swagger 2.0 format.
.SH OPTIONS .SH OPTIONS
.PP .PP
Note: if invoking hledger\-api as a hledger subcommand, write Note: if invoking hledger\-api as a hledger subcommand, write
@ -57,6 +63,11 @@ use a different TCP port (default: 8001)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-swagger\f[]
print API docs in Swagger 2.0 format, and exit
.RS
.RE
.TP
.B \f[C]\-h\f[] .B \f[C]\-h\f[]
show usage show usage
.RS .RS

8
hledger-api/doc/hledger-api.1.m4.md
View File

@ -15,6 +15,7 @@ hledger-api - web API server for the hledger accounting tool
# SYNOPSIS # SYNOPSIS
`hledger-api [OPTIONS]`\ `hledger-api [OPTIONS]`\
`hledger-api --swagger`\
`hledger api -- [OPTIONS]` `hledger api -- [OPTIONS]`
# DESCRIPTION # DESCRIPTION
@ -34,11 +35,13 @@ Data is served from the usual hledger journal file:
For more about the format, see hledger(1) or hledger_journal(5). For more about the format, see hledger(1) or hledger_journal(5).
The server listens on port 8001, or another specified with `-p PORT`. The server listens on port 8001, or another specified with `-p PORT`.
Note there is no built-in access control, so you will need to hide Note there is no built-in access control, so you will need to hide
hledger-api behind an authenticating proxy if you want to restrict hledger-api behind an authenticating proxy if you want to restrict
access. access.
If invoked as `hledger-api --swagger`, instead of starting a server
the API docs will be printed in Swagger 2.0 format.
# OPTIONS # OPTIONS
Note: if invoking hledger-api as a hledger subcommand, write `--` before options as shown above. Note: if invoking hledger-api as a hledger subcommand, write `--` before options as shown above.
@ -52,6 +55,9 @@ Note: if invoking hledger-api as a hledger subcommand, write `--` before options
`-p --port=PORT` `-p --port=PORT`
: use a different TCP port (default: 8001) : use a different TCP port (default: 8001)
`--swagger`
: print API docs in Swagger 2.0 format, and exit
`-h` `-h`
: show usage : show usage

14
hledger-api/doc/hledger-api.1.txt
View File

@ -8,6 +8,7 @@ NNAAMMEE
SSYYNNOOPPSSIISS SSYYNNOOPPSSIISS
hledger-api [OPTIONS] hledger-api [OPTIONS]
hledger-api --swagger
hledger api -- [OPTIONS] hledger api -- [OPTIONS]
DDEESSCCRRIIPPTTIIOONN DDEESSCCRRIIPPTTIIOONN
@ -24,12 +25,14 @@ DDEESSCCRRIIPPTTIIOONN
$LEDGER_FILE, or another file specified with -f. For more about the $LEDGER_FILE, or another file specified with -f. For more about the
format, see hledger(1) or hledger_journal(5). format, see hledger(1) or hledger_journal(5).
The server listens on port 8001, or another specified with -p PORT. The server listens on port 8001, or another specified with -p PORT.
Note there is no built-in access control, so you will need to hide
Note there is no built-in access control, so you will need to hide hledger-api behind an authenticating proxy if you want to restrict
hledger-api behind an authenticating proxy if you want to restrict
access. access.
If invoked as hledger-api --swagger, instead of starting a server the
API docs will be printed in Swagger 2.0 format.
OOPPTTIIOONNSS OOPPTTIIOONNSS
Note: if invoking hledger-api as a hledger subcommand, write -- before Note: if invoking hledger-api as a hledger subcommand, write -- before
options as shown above. options as shown above.
@ -44,6 +47,9 @@ OOPPTTIIOONNSS
--pp ----ppoorrtt==PPOORRTT --pp ----ppoorrtt==PPOORRTT
use a different TCP port (default: 8001) use a different TCP port (default: 8001)
----sswwaaggggeerr
print API docs in Swagger 2.0 format, and exit
--hh show usage --hh show usage
----hheellpp show detailed help ----hheellpp show detailed help