From: Julien Lancelot <julien.lancelot@sonarsource.com>
Date: Mon, 12 May 2014 15:55:13 +0000 (+0200)
Subject: Fix response examples
X-Git-Tag: 4.4-RC1~1120
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=05242f4403fab7cbaa276d601b86d09634a14672;p=sonarqube.git

Fix response examples
---

diff --git a/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java b/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java
index cb41f8a88df..01e0976b338 100644
--- a/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java
+++ b/sonar-server/src/main/java/org/sonar/server/source/ws/ScmAction.java
@@ -19,6 +19,7 @@
  */
 package org.sonar.server.source.ws;
 
+import com.google.common.io.Resources;
 import org.apache.commons.lang.ObjectUtils;
 import org.sonar.api.server.ws.Request;
 import org.sonar.api.server.ws.RequestHandler;
@@ -41,6 +42,7 @@ public class ScmAction implements RequestHandler {
     WebService.NewAction action = controller.createAction("scm")
       .setDescription("Get SCM information of source files")
       .setSince("4.4")
+      .setResponseExample(Resources.getResource(getClass(), "example-scm.json"))
       .setHandler(this);
 
     action
diff --git a/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java b/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java
index cd2f7d44255..05b00a71334 100644
--- a/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java
+++ b/sonar-server/src/main/java/org/sonar/server/source/ws/ShowAction.java
@@ -43,7 +43,7 @@ public class ShowAction implements RequestHandler {
     WebService.NewAction action = controller.createAction("show")
       .setDescription("Get source code")
       .setSince("4.4")
-      .setResponseExample(Resources.getResource(getClass(), "show-example-show.json"))
+      .setResponseExample(Resources.getResource(getClass(), "example-show.json"))
       .setHandler(this);
 
     action
diff --git a/sonar-server/src/main/resources/org/sonar/server/source/ws/example-scm.json b/sonar-server/src/main/resources/org/sonar/server/source/ws/example-scm.json
new file mode 100644
index 00000000000..513f3e4a17f
--- /dev/null
+++ b/sonar-server/src/main/resources/org/sonar/server/source/ws/example-scm.json
@@ -0,0 +1,7 @@
+{
+  "scm": [
+    [1, "julien", "2013-03-13"],
+    [2, "julien", "2013-03-14"],
+    [3, "simon", "2014-01-01"]
+  ]
+}
diff --git a/sonar-server/src/main/resources/org/sonar/server/source/ws/example-show.json b/sonar-server/src/main/resources/org/sonar/server/source/ws/example-show.json
new file mode 100644
index 00000000000..74ef52f4510
--- /dev/null
+++ b/sonar-server/src/main/resources/org/sonar/server/source/ws/example-show.json
@@ -0,0 +1,10 @@
+{
+  "sources": [
+    [20, "<span class=\"k\">package </span>org.sonar.check;"],
+    [21, ""],
+    [22, "<span class=\"k\">public </span><span class=\"k\">enum </span><span class=\"sym-922 sym\">Priority</span> {"],
+    [23, "  <span class=\"cppd\">/**</span>"],
+    [24, "<span class=\"cppd\">   * WARNING : DO NOT CHANGE THE ENUMERATION ORDER</span>"],
+    [25, "<span class=\"cppd\">   * the enum ordinal is used for db persistence</span>"]
+  ]
+}
diff --git a/sonar-server/src/main/resources/org/sonar/server/source/ws/scm-example-show.json b/sonar-server/src/main/resources/org/sonar/server/source/ws/scm-example-show.json
deleted file mode 100644
index 513f3e4a17f..00000000000
--- a/sonar-server/src/main/resources/org/sonar/server/source/ws/scm-example-show.json
+++ /dev/null
@@ -1,7 +0,0 @@
-{
-  "scm": [
-    [1, "julien", "2013-03-13"],
-    [2, "julien", "2013-03-14"],
-    [3, "simon", "2014-01-01"]
-  ]
-}
diff --git a/sonar-server/src/main/resources/org/sonar/server/source/ws/show-example-show.json b/sonar-server/src/main/resources/org/sonar/server/source/ws/show-example-show.json
deleted file mode 100644
index 74ef52f4510..00000000000
--- a/sonar-server/src/main/resources/org/sonar/server/source/ws/show-example-show.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
-  "sources": [
-    [20, "<span class=\"k\">package </span>org.sonar.check;"],
-    [21, ""],
-    [22, "<span class=\"k\">public </span><span class=\"k\">enum </span><span class=\"sym-922 sym\">Priority</span> {"],
-    [23, "  <span class=\"cppd\">/**</span>"],
-    [24, "<span class=\"cppd\">   * WARNING : DO NOT CHANGE THE ENUMERATION ORDER</span>"],
-    [25, "<span class=\"cppd\">   * the enum ordinal is used for db persistence</span>"]
-  ]
-}
diff --git a/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java b/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java
index 0af6b0cc185..3d47f925a57 100644
--- a/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java
+++ b/sonar-server/src/test/java/org/sonar/server/source/ws/SourcesWsTest.java
@@ -52,9 +52,9 @@ public class SourcesWsTest {
     WebService.Action scm = controller.action("scm");
     assertThat(scm).isNotNull();
     assertThat(scm.handler()).isSameAs(scmAction);
-    assertThat(show.since()).isEqualTo("4.4");
-    assertThat(show.isInternal()).isFalse();
-    assertThat(show.responseExampleAsString()).isNotEmpty();
+    assertThat(scm.since()).isEqualTo("4.4");
+    assertThat(scm.isInternal()).isFalse();
+    assertThat(scm.responseExampleAsString()).isNotEmpty();
     assertThat(scm.params()).hasSize(4);
   }
 }