From 734dbe2e58c0f0e7cb771ce16a399241420980f9 Mon Sep 17 00:00:00 2001 From: Stas Vilchik Date: Wed, 18 May 2016 16:24:58 +0200 Subject: [PATCH] SONAR-6438 Sanitize description of WS sections (#985) --- .../org/sonar/server/authentication/ws/AuthenticationWs.java | 2 +- .../src/main/java/org/sonar/server/ce/ws/CeWs.java | 2 +- .../main/java/org/sonar/server/component/ws/ComponentsWs.java | 2 +- .../src/main/java/org/sonar/server/component/ws/EventsWs.java | 2 +- .../main/java/org/sonar/server/component/ws/ResourcesWs.java | 2 +- .../src/main/java/org/sonar/server/config/ws/PropertiesWs.java | 2 +- .../java/org/sonar/server/duplication/ws/DuplicationsWs.java | 2 +- .../main/java/org/sonar/server/issue/filter/IssueFilterWs.java | 2 +- .../src/main/java/org/sonar/server/issue/ws/IssuesWs.java | 2 +- .../src/main/java/org/sonar/server/language/ws/LanguageWs.java | 2 +- .../org/sonar/server/measure/custom/ws/CustomMeasuresWs.java | 2 +- .../src/main/java/org/sonar/server/measure/ws/MeasuresWs.java | 2 +- .../main/java/org/sonar/server/measure/ws/TimeMachineWs.java | 2 +- .../src/main/java/org/sonar/server/metric/ws/MetricsWs.java | 2 +- .../java/org/sonar/server/permission/ws/PermissionsWs.java | 2 +- .../src/main/java/org/sonar/server/platform/ws/SystemWs.java | 3 ++- .../src/main/java/org/sonar/server/plugins/ws/PluginsWs.java | 2 +- .../src/main/java/org/sonar/server/project/ws/ProjectsWs.java | 2 +- .../main/java/org/sonar/server/qualitygate/ws/QGatesWs.java | 2 +- .../java/org/sonar/server/qualityprofile/ws/QProfilesWs.java | 2 +- .../src/main/java/org/sonar/server/rule/ws/RulesWs.java | 2 +- .../src/main/java/org/sonar/server/source/ws/SourcesWs.java | 2 +- .../src/main/java/org/sonar/server/test/ws/TestsWs.java | 2 +- .../src/main/java/org/sonar/server/user/ws/FavoritesWs.java | 2 +- .../main/java/org/sonar/server/user/ws/UserPropertiesWs.java | 2 +- .../src/main/java/org/sonar/server/user/ws/UsersWs.java | 2 +- .../main/java/org/sonar/server/usergroups/ws/UserGroupsWs.java | 2 +- .../main/java/org/sonar/server/usertoken/ws/UserTokensWs.java | 3 +-- .../src/main/java/org/sonar/server/ws/WebServicesWs.java | 2 +- .../src/main/resources/org/sonar/server/ws/list-example.json | 2 +- .../server/ws/WebServicesWsTest/list_including_internals.json | 2 +- 31 files changed, 32 insertions(+), 32 deletions(-) diff --git a/server/sonar-server/src/main/java/org/sonar/server/authentication/ws/AuthenticationWs.java b/server/sonar-server/src/main/java/org/sonar/server/authentication/ws/AuthenticationWs.java index 258802bf223..79600e01b5e 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/authentication/ws/AuthenticationWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/authentication/ws/AuthenticationWs.java @@ -28,7 +28,7 @@ public class AuthenticationWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/authentication"); - controller.setDescription("Check authentication credentials"); + controller.setDescription("Check authentication credentials."); defineValidateAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/CeWs.java b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/CeWs.java index 8b037190ed3..9196c24d3bd 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/ce/ws/CeWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/ce/ws/CeWs.java @@ -35,7 +35,7 @@ public class CeWs implements WebService { public void define(Context context) { NewController controller = context .createController(ENDPOINT) - .setDescription("Compute Engine"); + .setDescription("Get information on Compute Engine tasks."); for (CeWsAction action : actions) { action.define(controller); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/component/ws/ComponentsWs.java b/server/sonar-server/src/main/java/org/sonar/server/component/ws/ComponentsWs.java index 52bc5dba201..94ecff8f704 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/component/ws/ComponentsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/component/ws/ComponentsWs.java @@ -39,7 +39,7 @@ public class ComponentsWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/components") .setSince("4.2") - .setDescription("Components management"); + .setDescription("Get information about a component (file, directory, project, ...) and its ancestors or children."); for (ComponentsWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/component/ws/EventsWs.java b/server/sonar-server/src/main/java/org/sonar/server/component/ws/EventsWs.java index 4b664057e77..c60de5082f0 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/component/ws/EventsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/component/ws/EventsWs.java @@ -27,7 +27,7 @@ public class EventsWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/events"); - controller.setDescription("Project's events management"); + controller.setDescription("Manage project events."); controller.setSince("2.6"); defineIndexAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java b/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java index ed2151a4070..c6c6984ba61 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/component/ws/ResourcesWs.java @@ -30,7 +30,7 @@ public class ResourcesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/resources") - .setDescription("Former components web service") + .setDescription("Former components web api. Deprecated since 5.4.") .setSince("2.10"); defineIndexAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/config/ws/PropertiesWs.java b/server/sonar-server/src/main/java/org/sonar/server/config/ws/PropertiesWs.java index a70ecf9cb2f..3b2a9085b9a 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/config/ws/PropertiesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/config/ws/PropertiesWs.java @@ -27,7 +27,7 @@ public class PropertiesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/properties"); - controller.setDescription("Properties management"); + controller.setDescription("Manage global and project properties."); controller.setSince("2.6"); defineIndexAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/duplication/ws/DuplicationsWs.java b/server/sonar-server/src/main/java/org/sonar/server/duplication/ws/DuplicationsWs.java index 940ef1820c4..b36b9276760 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/duplication/ws/DuplicationsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/duplication/ws/DuplicationsWs.java @@ -33,7 +33,7 @@ public class DuplicationsWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/duplications") .setSince("4.4") - .setDescription("Display duplications information"); + .setDescription("Get duplication information for a project."); showAction.define(controller); controller.done(); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java index 9d1569f6c71..fa821d16189 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/filter/IssueFilterWs.java @@ -33,7 +33,7 @@ public class IssueFilterWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/issue_filters") .setSince("4.2") - .setDescription("Issue Filters management"); + .setDescription("Get details on existing issue filters/saved issue searches."); for (IssueFilterWsAction action : actions) { action.define(controller); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/IssuesWs.java b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/IssuesWs.java index 8b0c4db9f28..7114e6585ab 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/issue/ws/IssuesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/issue/ws/IssuesWs.java @@ -46,7 +46,7 @@ public class IssuesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(API_ENDPOINT); - controller.setDescription("Coding rule issues"); + controller.setDescription("Read and update issues."); controller.setSince("3.6"); for (IssuesWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/language/ws/LanguageWs.java b/server/sonar-server/src/main/java/org/sonar/server/language/ws/LanguageWs.java index f014dffd02c..7ec4a596c4c 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/language/ws/LanguageWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/language/ws/LanguageWs.java @@ -35,7 +35,7 @@ public class LanguageWs implements WebService { @Override public void define(Context context) { NewController languages = context.createController("api/languages") - .setDescription("Programming languages") + .setDescription("Get the list of programming languages supported in this instance.") .setSince("5.1"); list.define(languages); diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java index ee0a60c1f0f..71fffc85334 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/custom/ws/CustomMeasuresWs.java @@ -33,7 +33,7 @@ public class CustomMeasuresWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(ENDPOINT) - .setDescription("Custom measures management") + .setDescription("Manage custom measures for a project. See also api/metrics.") .setSince("5.2"); for (CustomMeasuresWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MeasuresWs.java b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MeasuresWs.java index 7118ada394f..832af90ee75 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MeasuresWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/MeasuresWs.java @@ -33,7 +33,7 @@ public class MeasuresWs implements WebService { public void define(Context context) { NewController controller = context.createController(MeasuresWsParameters.CONTROLLER_MEASURES) .setSince("5.4") - .setDescription("Measures search"); + .setDescription("Get components or children with specified measures."); for (MeasuresWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java index 11b1096da85..f43e243f014 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/measure/ws/TimeMachineWs.java @@ -30,7 +30,7 @@ public class TimeMachineWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/timemachine") - .setDescription("Get a list of past measures") + .setDescription("Get project measure data from past analyses.") .setSince("2.10"); defineSystemAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/metric/ws/MetricsWs.java b/server/sonar-server/src/main/java/org/sonar/server/metric/ws/MetricsWs.java index 8a70bf8d5e8..c7122486041 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/metric/ws/MetricsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/metric/ws/MetricsWs.java @@ -34,7 +34,7 @@ public class MetricsWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(ENDPOINT); - controller.setDescription("Metrics management"); + controller.setDescription("Get information on automatic metrics, and manage custom metrics. See also api/custom_measures."); controller.setSince("2.6"); for (MetricsWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/permission/ws/PermissionsWs.java b/server/sonar-server/src/main/java/org/sonar/server/permission/ws/PermissionsWs.java index 0c717f9277f..cbc91a1658b 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/permission/ws/PermissionsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/permission/ws/PermissionsWs.java @@ -33,7 +33,7 @@ public class PermissionsWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(CONTROLLER); - controller.setDescription("Permissions management"); + controller.setDescription("Manage permission templates, and the granting and revoking of permissions at the global and project levels."); controller.setSince("3.7"); for (PermissionsWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java index 218b47222a7..bcf62c17e31 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/platform/ws/SystemWs.java @@ -31,7 +31,8 @@ public class SystemWs implements WebService { @Override public void define(Context context) { - NewController controller = context.createController("api/system"); + NewController controller = context.createController("api/system") + .setDescription("Get system details, and perform some management actions, such as restarting, and initiating a database migration (as part of a system upgrade)."); for (SystemWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/plugins/ws/PluginsWs.java b/server/sonar-server/src/main/java/org/sonar/server/plugins/ws/PluginsWs.java index 21f5c521196..d92cdfca959 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/plugins/ws/PluginsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/plugins/ws/PluginsWs.java @@ -34,7 +34,7 @@ public class PluginsWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/plugins"); - controller.setDescription("Plugin management") + controller.setDescription("Manage the plugins on the server, including installing, uninstalling, and upgrading.") .setSince("5.2"); for (PluginsWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProjectsWs.java b/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProjectsWs.java index 25a4e8a0e95..8a06da7d277 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProjectsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProjectsWs.java @@ -40,7 +40,7 @@ public class ProjectsWs implements WebService { public void define(Context context) { NewController controller = context.createController(ENDPOINT) .setSince("2.10") - .setDescription("Projects management"); + .setDescription("Manage project existence."); defineIndexAction(controller); defineCreateAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualitygate/ws/QGatesWs.java b/server/sonar-server/src/main/java/org/sonar/server/qualitygate/ws/QGatesWs.java index 1e1802bc386..6342b7c59dc 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/qualitygate/ws/QGatesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/qualitygate/ws/QGatesWs.java @@ -51,7 +51,7 @@ public class QGatesWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/qualitygates") .setSince("4.3") - .setDescription("This service manages quality gates, including conditions and project association"); + .setDescription("Manage quality gates, including conditions and project association."); for (QGateWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/QProfilesWs.java b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/QProfilesWs.java index 1de99bfcef6..a9b87c520e3 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/QProfilesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/qualityprofile/ws/QProfilesWs.java @@ -43,7 +43,7 @@ public class QProfilesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(API_ENDPOINT) - .setDescription("Quality Profiles") + .setDescription("Manage quality profiles.") .setSince("4.4"); ruleActivationActions.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java index 3c0faf4cb3b..97c352fecd5 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/rule/ws/RulesWs.java @@ -33,7 +33,7 @@ public class RulesWs implements WebService { public void define(Context context) { NewController controller = context .createController("api/rules") - .setDescription("Coding rules"); + .setDescription("Get and update some details of automatic rules, and manage custom rules."); for (RulesWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java b/server/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java index e4b361a81a7..70a03461426 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/source/ws/SourcesWs.java @@ -33,7 +33,7 @@ public class SourcesWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/sources") .setSince("4.2") - .setDescription("Display sources information"); + .setDescription("Get details on source files. See also api/tests."); for (SourcesWsAction action : actions) { action.define(controller); } diff --git a/server/sonar-server/src/main/java/org/sonar/server/test/ws/TestsWs.java b/server/sonar-server/src/main/java/org/sonar/server/test/ws/TestsWs.java index 4cc01fc3b25..5512cb36ada 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/test/ws/TestsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/test/ws/TestsWs.java @@ -33,7 +33,7 @@ public class TestsWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/tests") .setSince("4.4") - .setDescription("Tests management. Deprecated since 5.6"); + .setDescription("Get details on test files. See also api/sources. Deprecated since 5.6."); for (TestsWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/user/ws/FavoritesWs.java b/server/sonar-server/src/main/java/org/sonar/server/user/ws/FavoritesWs.java index cca930837a0..40ce6b8059b 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/user/ws/FavoritesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/user/ws/FavoritesWs.java @@ -27,7 +27,7 @@ public class FavoritesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/favorites"); - controller.setDescription("User's favorites management"); + controller.setDescription("Manage user favorites."); controller.setSince("2.6"); defineIndexAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/user/ws/UserPropertiesWs.java b/server/sonar-server/src/main/java/org/sonar/server/user/ws/UserPropertiesWs.java index c82a5335f3a..9736620d95a 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/user/ws/UserPropertiesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/user/ws/UserPropertiesWs.java @@ -27,7 +27,7 @@ public class UserPropertiesWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/user_properties"); - controller.setDescription("User properties management"); + controller.setDescription("Manage user properties."); controller.setSince("2.6"); defineIndexAction(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/user/ws/UsersWs.java b/server/sonar-server/src/main/java/org/sonar/server/user/ws/UsersWs.java index d60fe7d2785..83f7b848c6e 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/user/ws/UsersWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/user/ws/UsersWs.java @@ -33,7 +33,7 @@ public class UsersWs implements WebService { public void define(Context context) { NewController controller = context.createController("api/users") .setSince("3.6") - .setDescription("Users management"); + .setDescription("Manage users."); for (UsersWsAction action : actions) { action.define(controller); diff --git a/server/sonar-server/src/main/java/org/sonar/server/usergroups/ws/UserGroupsWs.java b/server/sonar-server/src/main/java/org/sonar/server/usergroups/ws/UserGroupsWs.java index 16b6e3ad4d2..5eb12a96f59 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/usergroups/ws/UserGroupsWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/usergroups/ws/UserGroupsWs.java @@ -32,7 +32,7 @@ public class UserGroupsWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController("api/user_groups") - .setDescription("User groups management") + .setDescription("Manage user groups.") .setSince("5.2"); for (UserGroupsWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/usertoken/ws/UserTokensWs.java b/server/sonar-server/src/main/java/org/sonar/server/usertoken/ws/UserTokensWs.java index 6ec1b145c13..2813d550f44 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/usertoken/ws/UserTokensWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/usertoken/ws/UserTokensWs.java @@ -33,8 +33,7 @@ public class UserTokensWs implements WebService { @Override public void define(Context context) { NewController controller = context.createController(CONTROLLER) - .setDescription("User token management. To enhance security, tokens can be used to take the place " + - "of user credentials in analysis configuration. A token can be revoked at any time.") + .setDescription("List, create, and delete a user's access tokens.") .setSince("5.3"); for (UserTokensWsAction action : actions) { diff --git a/server/sonar-server/src/main/java/org/sonar/server/ws/WebServicesWs.java b/server/sonar-server/src/main/java/org/sonar/server/ws/WebServicesWs.java index d9715fc9806..7d08b5f3324 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/ws/WebServicesWs.java +++ b/server/sonar-server/src/main/java/org/sonar/server/ws/WebServicesWs.java @@ -44,7 +44,7 @@ public class WebServicesWs implements WebService { NewController controller = context .createController("api/webservices") .setSince("4.2") - .setDescription("List web services"); + .setDescription("Get information on the web api supported on this instance."); defineList(context, controller); defineResponseExample(context, controller); controller.done(); diff --git a/server/sonar-server/src/main/resources/org/sonar/server/ws/list-example.json b/server/sonar-server/src/main/resources/org/sonar/server/ws/list-example.json index 8aad3729e82..32b2dc97b87 100644 --- a/server/sonar-server/src/main/resources/org/sonar/server/ws/list-example.json +++ b/server/sonar-server/src/main/resources/org/sonar/server/ws/list-example.json @@ -44,7 +44,7 @@ }, { "path": "api/webservices", - "description": "List web services", + "description": "Get information on the web api supported on this instance.", "since": "4.2", "actions": [ { diff --git a/server/sonar-server/src/test/resources/org/sonar/server/ws/WebServicesWsTest/list_including_internals.json b/server/sonar-server/src/test/resources/org/sonar/server/ws/WebServicesWsTest/list_including_internals.json index b5b23df28c2..527ccf3dd42 100644 --- a/server/sonar-server/src/test/resources/org/sonar/server/ws/WebServicesWsTest/list_including_internals.json +++ b/server/sonar-server/src/test/resources/org/sonar/server/ws/WebServicesWsTest/list_including_internals.json @@ -44,7 +44,7 @@ }, { "path": "api/webservices", - "description": "List web services", + "description": "Get information on the web api supported on this instance.", "since": "4.2", "actions": [ { -- 2.39.5