Add explanation on how to use the MoSAPI endpoint (#137)

* Add explanation on how to use the MoSAPI endpoint

* Add a $ before each command so that it's clearer
This commit is contained in:
guyben13 2019-07-02 18:20:53 -04:00 committed by Lai Jiang
parent 25ee92b5d8
commit 888bc158fe

View file

@ -57,6 +57,19 @@ import javax.inject.Inject;
* a cookie you then send to get the list and finally logout.
*
* <p>The username is [TLD]_ry. It could be any "real" TLD.
*
* <p>For clarity, this is how one would contact this endpoint "manually", from a whitelisted IP
* server:
*
* <p>$ curl [base]/login -I --user [tld]_ry:[password]
*
* <p>get the id=xxx value from the reply
*
* <p>$ curl [base]/registrarRdapBaseUrl/list -b 'id=xxx'
*
* <p>$ curl [base]/logout -b 'id=xxx'
*
* <p>where [base] is https://mosapi.icann.org/mosapi/v1/[tld]
*/
@Action(
service = Action.Service.BACKEND,