dirk/honk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update login api docs

Browse source
This commit is contained in:
Ted Unangst 2019-11-10 23:51:11 -05:00
parent 4fc4b67f91
commit 6fffa1ac05
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/honk.3
View file

@ -35,11 +35,11 @@ See below.
An authorization token. An authorization token.
.El .El
.Pp .Pp
The API URL for all actions other than login is The API URL for all actions other than login and logout is
.Pa /api . .Pa /api .
.Ss login .Ss login
Send a POST request to Send a POST request to
.Pa /login .Pa /dologin
with the following form values. with the following form values.
.Bl -tag -width username .Bl -tag -width username
.It Fa username .It Fa username
@ -53,7 +53,12 @@ Must be
.Pp .Pp
This will return a token to be used for future requests. This will return a token to be used for future requests.
The token is valid for one year. The token is valid for one year.
You can stop using the API at any time, but you can never logout. .Ss logout
Send a request to
.Pa /logout
with the
.Fa token
to be expired.
.Ss honk .Ss honk
The The
.Fa action .Fa action