From 6fffa1ac05cac26f8bd4b376530763481a9c7c33 Mon Sep 17 00:00:00 2001 From: Ted Unangst Date: Sun, 10 Nov 2019 23:51:11 -0500 Subject: [PATCH] update login api docs --- docs/honk.3 | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/honk.3 b/docs/honk.3 index 43f0337..5f0ffd0 100644 --- a/docs/honk.3 +++ b/docs/honk.3 @@ -35,11 +35,11 @@ See below. An authorization token. .El .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 . .Ss login Send a POST request to -.Pa /login +.Pa /dologin with the following form values. .Bl -tag -width username .It Fa username @@ -53,7 +53,12 @@ Must be .Pp This will return a token to be used for future requests. 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 The .Fa action