From beeb454dd1053cbc980a48920e2b7297fa8b64bd Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Mon, 5 May 2014 14:07:42 +0200 Subject: [PATCH] SONAR-5254 apply naming conventions of URLs --- .../api-documentation/collections/web-services.coffee | 2 +- .../models/web-service-action-response.coffee | 2 +- .../main/java/org/sonar/server/source/ws/ScmAction.java | 4 ++-- .../main/java/org/sonar/server/source/ws/ShowAction.java | 4 ++-- .../src/main/java/org/sonar/server/ws/ListingWs.java | 6 +++--- .../java/org/sonar/server/source/ws/ScmActionTest.java | 2 +- .../java/org/sonar/server/source/ws/ShowActionTest.java | 2 +- .../src/test/java/org/sonar/server/ws/ListingWsTest.java | 8 ++++---- .../resources/org/sonar/server/ws/ListingWsTest/list.json | 4 ++-- .../server/ws/ListingWsTest/list_including_internals.json | 6 +++--- 10 files changed, 20 insertions(+), 20 deletions(-) diff --git a/sonar-server/src/main/coffee/api-documentation/collections/web-services.coffee b/sonar-server/src/main/coffee/api-documentation/collections/web-services.coffee index 395273cec38..1f1e5ca4cc7 100644 --- a/sonar-server/src/main/coffee/api-documentation/collections/web-services.coffee +++ b/sonar-server/src/main/coffee/api-documentation/collections/web-services.coffee @@ -13,7 +13,7 @@ define [ @includeInternals = false url: -> - "#{baseUrl}/api/webservices/list?includeInternals=#{@includeInternals}" + "#{baseUrl}/api/webservices/list?include_internals=#{@includeInternals}" parse: (r) -> r.webServices.map (webService) -> diff --git a/sonar-server/src/main/coffee/api-documentation/models/web-service-action-response.coffee b/sonar-server/src/main/coffee/api-documentation/models/web-service-action-response.coffee index d284fd3288e..77373cc113e 100644 --- a/sonar-server/src/main/coffee/api-documentation/models/web-service-action-response.coffee +++ b/sonar-server/src/main/coffee/api-documentation/models/web-service-action-response.coffee @@ -7,4 +7,4 @@ define [ class WebServiceActionResponse extends Backbone.Model url: -> - "#{baseUrl}/api/webservices/responseExample?controller=#{@get('controller')}&action=#{@get('action')}" + "#{baseUrl}/api/webservices/response_example?controller=#{@get('controller')}&action=#{@get('action')}" 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 f54a7299c1b..6fd42a66fa3 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 @@ -61,7 +61,7 @@ public class ScmAction implements RequestHandler { .setExampleValue("20"); action - .createParam("groupCommits") + .createParam("group_commits") .setDescription("Group lines by SCM commit") .setPossibleValues("false", "true") .setDefaultValue("true"); @@ -79,7 +79,7 @@ public class ScmAction implements RequestHandler { String dates = service.getScmDateData(fileKey); JsonWriter json = response.newJsonWriter().beginObject(); - scmWriter.write(authors, dates, from, to, request.mandatoryParamAsBoolean("groupCommits"), json); + scmWriter.write(authors, dates, from, to, request.mandatoryParamAsBoolean("group_commits"), json); json.endObject().close(); } } 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 4086bfe3b22..6e05c5d9bb1 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 @@ -73,7 +73,7 @@ public class ShowAction implements RequestHandler { .setDefaultValue("false"); action - .createParam("groupCommits") + .createParam("group_commits") .setDescription("Group lines by SCM commit. Used only if 'scm' is 'true'") .setPossibleValues("false", "true") .setDefaultValue("true"); @@ -96,7 +96,7 @@ public class ShowAction implements RequestHandler { if (request.mandatoryParamAsBoolean("scm")) { String scmAuthorData = sourceService.getScmAuthorData(fileKey); String scmDataData = sourceService.getScmDateData(fileKey); - scmWriter.write(scmAuthorData, scmDataData, from, to, request.mandatoryParamAsBoolean("groupCommits"), json); + scmWriter.write(scmAuthorData, scmDataData, from, to, request.mandatoryParamAsBoolean("group_commits"), json); } json.endObject().close(); diff --git a/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java b/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java index 2a7b9a231dc..34c05975ab3 100644 --- a/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java +++ b/sonar-server/src/main/java/org/sonar/server/ws/ListingWs.java @@ -59,7 +59,7 @@ public class ListingWs implements WebService { } }); action - .createParam("includeInternals") + .createParam("include_internals") .setDescription("Include web services that are implemented for internal use only. Their forward-compatibility is " + "not assured.") .setPossibleValues("false", "true") @@ -68,7 +68,7 @@ public class ListingWs implements WebService { private void defineResponseExample(final Context context, NewController controller) { NewAction action = controller - .createAction("responseExample") + .createAction("response_example") .setHandler(new RequestHandler() { @Override public void handle(Request request, Response response) throws Exception { @@ -96,7 +96,7 @@ public class ListingWs implements WebService { } void handleList(List controllers, Request request, Response response) { - boolean includeInternals = request.mandatoryParamAsBoolean("includeInternals"); + boolean includeInternals = request.mandatoryParamAsBoolean("include_internals"); JsonWriter writer = response.newJsonWriter(); writer.beginObject(); writer.name("webServices").beginArray(); diff --git a/sonar-server/src/test/java/org/sonar/server/source/ws/ScmActionTest.java b/sonar-server/src/test/java/org/sonar/server/source/ws/ScmActionTest.java index 589cf4505c7..9d3c349998f 100644 --- a/sonar-server/src/test/java/org/sonar/server/source/ws/ScmActionTest.java +++ b/sonar-server/src/test/java/org/sonar/server/source/ws/ScmActionTest.java @@ -53,7 +53,7 @@ public class ScmActionTest { when(sourceService.getScmAuthorData(fileKey)).thenReturn("1=julien"); when(sourceService.getScmDateData(fileKey)).thenReturn("1=2013-01-01"); - WsTester.TestRequest request = tester.newGetRequest("api/sources", "scm").setParam("key", fileKey).setParam("groupCommits", "false"); + WsTester.TestRequest request = tester.newGetRequest("api/sources", "scm").setParam("key", fileKey).setParam("group_commits", "false"); request.execute(); verify(scmWriter).write(eq("1=julien"), eq("1=2013-01-01"), eq(1), eq(Integer.MAX_VALUE), eq(false), any(JsonWriter.class)); } diff --git a/sonar-server/src/test/java/org/sonar/server/source/ws/ShowActionTest.java b/sonar-server/src/test/java/org/sonar/server/source/ws/ShowActionTest.java index b1196418430..38fec0dc63f 100644 --- a/sonar-server/src/test/java/org/sonar/server/source/ws/ShowActionTest.java +++ b/sonar-server/src/test/java/org/sonar/server/source/ws/ShowActionTest.java @@ -153,7 +153,7 @@ public class ShowActionTest { .newGetRequest("api/sources", "show") .setParam("key", fileKey) .setParam("scm", "true") - .setParam("groupCommits", "false"); + .setParam("group_commits", "false"); request.execute().assertJson(getClass(), "show_source_with_scm_commits.json"); } diff --git a/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java b/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java index 910770fca82..e21904299d3 100644 --- a/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java +++ b/sonar-server/src/test/java/org/sonar/server/ws/ListingWsTest.java @@ -49,7 +49,7 @@ public class ListingWsTest { assertThat(index.isPost()).isFalse(); assertThat(index.isInternal()).isFalse(); - assertThat(controller.action("responseExample")).isNotNull(); + assertThat(controller.action("response_example")).isNotNull(); } @Test @@ -62,7 +62,7 @@ public class ListingWsTest { public void list_including_internals() throws Exception { WsTester tester = new WsTester(ws, new MetricWebService()); tester.newGetRequest("api/webservices", "list") - .setParam("includeInternals", "true") + .setParam("include_internals", "true") .execute() .assertJson(getClass(), "list_including_internals.json"); } @@ -71,7 +71,7 @@ public class ListingWsTest { public void response_example() throws Exception { WsTester tester = new WsTester(ws, new MetricWebService()); tester - .newGetRequest("api/webservices", "responseExample") + .newGetRequest("api/webservices", "response_example") .setParam("controller", "api/metric") .setParam("action", "create") .execute().assertJson(getClass(), "response_example.json"); @@ -113,7 +113,7 @@ public class ListingWsTest { .setDefaultValue("BLOCKER"); create.createParam("name"); - newController.createAction("internalAction").setInternal(true).setHandler(new RequestHandler() { + newController.createAction("internal_action").setInternal(true).setHandler(new RequestHandler() { @Override public void handle(Request request, Response response) throws Exception { diff --git a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json index b223fafa43b..2d522866dd0 100644 --- a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json +++ b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list.json @@ -47,7 +47,7 @@ "hasResponseExample": false, "params": [ { - "key": "includeInternals", + "key": "include_internals", "description": "Include web services that are implemented for internal use only. Their forward-compatibility is not assured.", "required": false, "defaultValue": "false", @@ -56,7 +56,7 @@ ] }, { - "key": "responseExample", + "key": "response_example", "internal": false, "post": false, "hasResponseExample": false, diff --git a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json index 149264d89b8..15c3bd6a7a0 100644 --- a/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json +++ b/sonar-server/src/test/resources/org/sonar/server/ws/ListingWsTest/list_including_internals.json @@ -27,7 +27,7 @@ ] }, { - "key": "internalAction", + "key": "internal_action", "since": "3.2", "internal": true, "post": false, @@ -54,7 +54,7 @@ "hasResponseExample": false, "params": [ { - "key": "includeInternals", + "key": "include_internals", "description": "Include web services that are implemented for internal use only. Their forward-compatibility is not assured.", "required": false, "defaultValue": "false", @@ -63,7 +63,7 @@ ] }, { - "key": "responseExample", + "key": "response_example", "internal": false, "post": false, "hasResponseExample": false, -- 2.39.5