diff options
| author | Teryk Bellahsene <teryk.bellahsene@sonarsource.com> | 2015-05-15 11:08:51 +0200 |
|---|---|---|
| committer | Teryk Bellahsene <teryk.bellahsene@sonarsource.com> | 2015-05-15 11:08:51 +0200 |
| commit | 77e67e76f88a18833a44463a4a3ce4ef2458f332 (patch) | |
| tree | fb214759be169da8f505f51777a17715ebbd50c8 /sonar-plugin-api | |
| parent | ce138d8485820fca38397ee9d75989f760439658 (diff) | |
| download | sonarqube-77e67e76f88a18833a44463a4a3ce4ef2458f332.tar.gz sonarqube-77e67e76f88a18833a44463a4a3ce4ef2458f332.zip | |
document web service and action naming conventions
Diffstat (limited to 'sonar-plugin-api')
| -rw-r--r-- | sonar-plugin-api/src/main/java/org/sonar/api/server/ws/WebService.java | 3 |
1 files changed, 2 insertions, 1 deletions
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); |