From 888bc158fe88725e30eb47109bc78dcb579a2bd5 Mon Sep 17 00:00:00 2001
From: guyben13 <guyben@google.com>
Date: Tue, 2 Jul 2019 18:20:53 -0400
Subject: [PATCH] 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
---
 .../rdap/UpdateRegistrarRdapBaseUrlsAction.java     | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/core/src/main/java/google/registry/rdap/UpdateRegistrarRdapBaseUrlsAction.java b/core/src/main/java/google/registry/rdap/UpdateRegistrarRdapBaseUrlsAction.java
index aad044037..1529c89f5 100644
--- a/core/src/main/java/google/registry/rdap/UpdateRegistrarRdapBaseUrlsAction.java
+++ b/core/src/main/java/google/registry/rdap/UpdateRegistrarRdapBaseUrlsAction.java
@@ -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,