diff options
| -rw-r--r-- | server/sonar-server/src/main/java/org/sonar/server/ws/WsAction.java | 1 | ||||
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java | 3 |
2 files changed, 3 insertions, 1 deletions
diff --git a/server/sonar-server/src/main/java/org/sonar/server/ws/WsAction.java b/server/sonar-server/src/main/java/org/sonar/server/ws/WsAction.java index d0d339f27b6..04a1fb9e013 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/ws/WsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/ws/WsAction.java @@ -25,6 +25,7 @@ import org.sonar.api.server.ws.WebService; /** * Since 5.2, this interface is the base for Web Service marker interfaces + * Convention for naming implementations: <i>web_service_class_name</i>Action. ex: ProjectsWsAction, UsersWsAction */ public interface WsAction extends RequestHandler, Definable<WebService.NewController> { // Marker interface diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java index 4a22a4da474..43e0d461c0a 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java @@ -115,7 +115,8 @@ public interface WebService extends Definable<WebService.Context> { * * @param path the controller path must not start or end with "/". It is recommended to start with "api/" * and to use lower-case format with underscores, for example "api/coding_rules". Usual actions - * are "search", "list", "show", "create" and "delete" + * are "search", "list", "show", "create" and "delete". + * the plural form is recommended - ex: api/projects */ public NewController createController(String path) { return new NewController(this, path); |