rudism
/
dotplan-online
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated api description in readme

This commit is contained in:
Rudis Muiznieks 2020-07-19 13:15:26 -05:00
parent a5cf07a181
commit f7aea7c651
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -23,6 +23,7 @@ Any dotplan implementation should expose at least the following two endpoints:
- `timestamp` - when this plan was created - `timestamp` - when this plan was created
- `404` if no plan found - `404` if no plan found
- `301` redirect if domain SRV record indicates plan is on a different dotplan provider - `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 - `POST /verify/{email}` - verify PGP signature of a plan
- request json data: - request json data:
- `pubkey` - ascii armored public PGP key to verify the signature with - `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 - `403` if server-side verification is not supported
- `404` if no plan found - `404` if no plan found
- `308` redirect if domain SRV record indicates plan is on a different dotplan provider. - `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 ### Authentication