((p "All API endpoints conform to the pattern " (kbd "[PREFIX]LETTER[/ZETTEL-ID]") ", where:") (dl (dt (kbd "PREFIX")) (dd (p "is the URL prefix (default: " (@L (@H "“") "/" (@H "”")) "), configured via the " (kbd "url-prefix") " " (a (@ (href . "00001004010000")) "startup configuration") ",")) (dt (kbd "LETTER")) (dd (p "is a single letter that specifies the resource type,")) (dt (kbd "ZETTEL-ID")) (dd (p "is an optional 14 digits string that uniquely " (a (@ (href . "00001006050000")) "identify a zettel") "."))) (p "The following letters are currently in use:") (table (thead (tr (th (@ (class . "center")) "Letter") (th "Without zettel identifier") (th "With " (a (@ (href . "00001006050000")) "zettel identifier")) (th "Mnemonic"))) (tbody (tr (td (@ (class . "center")) (kbd "a")) (td "POST: " (a (@ (href . "00001012050200")) "client authentication")) (td) (td (strong "A") "uthenticate")) (tr (td (@ (class . "center"))) (td "PUT: " (a (@ (href . "00001012050400")) "renew access token")) (td) (td)) (tr (td (@ (class . "center")) (kbd "x")) (td "GET: " (a (@ (href . "00001012070500")) "retrieve administrative data")) (td) (td "E" (strong "x") "ecute")) (tr (td (@ (class . "center"))) (td "POST: " (a (@ (href . "00001012080100")) "execute command")) (td) (td)) (tr (td (@ (class . "center")) (kbd "z")) (td "GET: " (a (@ (href . "00001012051200")) "list zettel") "/" (a (@ (href . "00001012051400")) "query zettel")) (td "GET: " (a (@ (href . "00001012053300")) "retrieve zettel")) (td (strong "Z") "ettel")) (tr (td (@ (class . "center"))) (td "POST: " (a (@ (href . "00001012053200")) "create new zettel")) (td "PUT: " (a (@ (href . "00001012054200")) "update zettel")) (td)) (tr (td (@ (class . "center"))) (td) (td "DELETE: " (a (@ (href . "00001012054600")) "delete zettel")) (td)))) (p "The full URL will contain either the " (@L (@H "“") "http" (@H "”")) " oder " (@L (@H "“") "https" (@H "”")) " scheme, a host name, and an optional port number.") (p "The API examples will assume the " (@L (@H "“") "http" (@H "”")) " schema, the local host " (@L (@H "“") "127.0.0.1" (@H "”")) ", the default port " (@L (@H "“") "23123" (@H "”")) ", and the default empty " (kbd "PREFIX") " " (@L (@H "“") "/" (@H "”")) "." " " "Therefore, all URLs in the API documentation will begin with " (@L (@H "“") "http://127.0.0.1:23123/" (@H "”")) "."))