From f7aea7c651b46cc275b07c5d5aad215e71713017 Mon Sep 17 00:00:00 2001 From: Rudis Muiznieks Date: Sun, 19 Jul 2020 13:15:26 -0500 Subject: [PATCH] updated api description in readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 200d5ac..0cd2fee 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ Any dotplan implementation should expose at least the following two endpoints: - `timestamp` - when this plan was created - `404` if no plan found - `301` redirect if domain SRV record indicates plan is on a different dotplan provider + - This is optional for servers to act as relays, in practice the client should look up the SRV record itself - `POST /verify/{email}` - verify PGP signature of a plan - request json data: - `pubkey` - ascii armored public PGP key to verify the signature with @@ -32,6 +33,7 @@ Any dotplan implementation should expose at least the following two endpoints: - `403` if server-side verification is not supported - `404` if no plan found - `308` redirect if domain SRV record indicates plan is on a different dotplan provider. + - This is optional for servers to act as relays, in practice the client should look up the SRV record itself. ### Authentication