From fb25b8621280de025b2fb9cae40f40d1eab7ae91 Mon Sep 17 00:00:00 2001 From: mountford Date: Tue, 12 Dec 2017 11:50:54 -0800 Subject: [PATCH] Put help information on the main page It turns out that the RDAP spec does not envision multiple help pages. We can still support them (for the TOS, for instance), but we shouldn't expect users to go searching for help other than the main page. Therefore, consolidate the useful information on the main page, and get rid of some of the others. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=178792548 --- .../registry/config/RegistryConfig.java | 18 +-------------- .../registry/rdap/RdapHelpActionTest.java | 13 ----------- .../google/registry/rdap/RdapTestHelper.java | 22 ++----------------- .../rdap/testdata/rdap_help_index.json | 20 ++++++++++++----- 4 files changed, 17 insertions(+), 56 deletions(-) diff --git a/java/google/registry/config/RegistryConfig.java b/java/google/registry/config/RegistryConfig.java index 165d2c38d..8f664ee11 100644 --- a/java/google/registry/config/RegistryConfig.java +++ b/java/google/registry/config/RegistryConfig.java @@ -1086,22 +1086,6 @@ public final class RegistryConfig { return new ImmutableMap.Builder() .put("/", RdapNoticeDescriptor.builder() .setTitle("RDAP Help") - .setDescription(ImmutableList.of( - "RDAP Help Topics (use /help/index for information)", - "syntax", - "tos (Terms of Service)")) - .setLinkValueSuffix("help/") - .build()) - .put("/index", RdapNoticeDescriptor.builder() - .setTitle("RDAP Help") - .setDescription(ImmutableList.of( - "RDAP Help Topics (use /help/index for information)", - "syntax", - "tos (Terms of Service)")) - .setLinkValueSuffix("help/index") - .build()) - .put("/syntax", RdapNoticeDescriptor.builder() - .setTitle("RDAP Command Syntax") .setDescription(ImmutableList.of( "domain/XXXX", "nameserver/XXXX", @@ -1114,7 +1098,7 @@ public final class RegistryConfig { "entities?fn=XXXX", "entities?handle=XXXX", "help/XXXX")) - .setLinkValueSuffix("help/syntax") + .setLinkValueSuffix("help/") .setLinkHrefUrlString("https://github.com/google/nomulus/blob/master/docs/rdap.md") .build()) .put("/tos", RdapNoticeDescriptor.builder() diff --git a/javatests/google/registry/rdap/RdapHelpActionTest.java b/javatests/google/registry/rdap/RdapHelpActionTest.java index abc8fd208..7aff97d1a 100644 --- a/javatests/google/registry/rdap/RdapHelpActionTest.java +++ b/javatests/google/registry/rdap/RdapHelpActionTest.java @@ -104,13 +104,6 @@ public class RdapHelpActionTest { assertThat(response.getStatus()).isEqualTo(404); } - @Test - public void testHelpActionIndex_works() throws Exception { - assertThat(generateActualJson("/index")) - .isEqualTo(generateExpectedJson("index", "rdap_help_index.json")); - assertThat(response.getStatus()).isEqualTo(200); - } - @Test public void testHelpActionDefault_getsIndex() throws Exception { assertThat(generateActualJson("")) @@ -125,12 +118,6 @@ public class RdapHelpActionTest { assertThat(response.getStatus()).isEqualTo(200); } - @Test - public void testHelpActionSyntax_works() throws Exception { - generateActualJson("/syntax"); - assertThat(response.getStatus()).isEqualTo(200); - } - @Test public void testHelpActionTos_works() throws Exception { assertThat(generateActualJson("/tos")) diff --git a/javatests/google/registry/rdap/RdapTestHelper.java b/javatests/google/registry/rdap/RdapTestHelper.java index a5800d6a7..572a17214 100644 --- a/javatests/google/registry/rdap/RdapTestHelper.java +++ b/javatests/google/registry/rdap/RdapTestHelper.java @@ -200,24 +200,6 @@ public class RdapTestHelper { "/", RdapNoticeDescriptor.builder() .setTitle("RDAP Help") - .setDescription(ImmutableList.of( - "RDAP Help Topics (use /help/topic for information)", - "syntax", - "tos (Terms of Service)")) - .setLinkValueSuffix("help/") - .build(), - "/index", - RdapNoticeDescriptor.builder() - .setTitle("RDAP Help") - .setDescription(ImmutableList.of( - "RDAP Help Topics (use /help/topic for information)", - "syntax", - "tos (Terms of Service)")) - .setLinkValueSuffix("help/index") - .build(), - "/syntax", - RdapNoticeDescriptor.builder() - .setTitle("RDAP Command Syntax") .setDescription(ImmutableList.of( "domain/XXXX", "nameserver/XXXX", @@ -230,8 +212,8 @@ public class RdapTestHelper { "entities?fn=XXXX", "entities?handle=XXXX", "help/XXXX")) - .setLinkValueSuffix("help/syntax") - .setLinkHrefUrlString("https://www.registry.tld/about/rdap/syntax.html") + .setLinkValueSuffix("help/") + .setLinkHrefUrlString("https://github.com/google/nomulus/blob/master/docs/rdap.md") .build(), "/tos", RdapNoticeDescriptor.builder() diff --git a/javatests/google/registry/rdap/testdata/rdap_help_index.json b/javatests/google/registry/rdap/testdata/rdap_help_index.json index b809acfa6..b05f126ea 100644 --- a/javatests/google/registry/rdap/testdata/rdap_help_index.json +++ b/javatests/google/registry/rdap/testdata/rdap_help_index.json @@ -6,17 +6,25 @@ "title" : "RDAP Help", "description" : [ - "RDAP Help Topics (use \/help\/topic for information)", - "syntax", - "tos (Terms of Service)" + "domain/XXXX", + "nameserver/XXXX", + "entity/XXXX", + "domains?name=XXXX", + "domains?nsLdhName=XXXX", + "domains?nsIp=XXXX", + "nameservers?name=XXXX", + "nameservers?ip=XXXX", + "entities?fn=XXXX", + "entities?handle=XXXX", + "help/XXXX" ], "links" : [ { "value" : "https://example.tld/rdap/help/%NAME%", - "rel" : "self", - "type" : "application/rdap+json", - "href" : "https://example.tld/rdap/help/%NAME%" + "rel" : "alternate", + "type" : "text/html", + "href" : "https://github.com/google/nomulus/blob/master/docs/rdap.md" } ] },