changeset 4594:1da63fe35ef3

mod_auth_http: Format README better
author Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
date Wed, 16 Jun 2021 17:32:43 +0200
parents b65a363d32d2
children bac3dae031ee
files mod_auth_http/README.markdown
diffstat 1 files changed, 7 insertions(+), 48 deletions(-) [+]
line wrap: on
line diff
--- a/mod_auth_http/README.markdown	Tue Jun 15 18:16:07 2021 +0200
+++ b/mod_auth_http/README.markdown	Wed Jun 16 17:32:43 2021 +0200
@@ -58,54 +58,13 @@
 of `501 Not Implemented`, but other error codes will also be handled by
 Prosody.
 
-### register
-
-**HTTP method:**
-: POST
-
-**Success codes:**
-: 201
-
-**Error codes:**
-: 409 (user exists)
-
-### check_password
-
-**HTTP method:**
-: GET
-
-**Success codes:**
-: 200
-
-**Response:**
-: A text string of `true` if the user exists, or `false` otherwise.
-
-### user_exists
-
-**HTTP method:**
-: GET
-
-**Success codes:**
-: 200
-
-**Response:**
-: A text string of `true` if the user exists, or `false` otherwise.
-
-### set_password
-
-**HTTP method:**
-: POST
-
-**Success codes:**
-: 200, 201, or 204
-
-### remove_user
-
-**HTTP method:**
-: POST
-
-**Success codes:**
-: 200, 201 or 204
+  Method          HTTP method Success codes   Error codes       Response
+  --------        ----        ---             ----------------- -----------------------------------------------------------------
+  register        POST        201             409 (user exists)
+  check\_password GET         200                               A text string of `true` if the user exists, or `false` otherwise.
+  user\_exists    GET         200                               A text string of `true` if the user exists, or `false` otherwise.
+  set\_password   POST        200, 201 or 204
+  remove\_user    POST        200, 201 or 204
 
 ## Examples