diff options
| author | Daniel Schwarz <daniel.schwarz@sonarsource.com> | 2017-12-06 10:17:39 +0100 |
|---|---|---|
| committer | Daniel Schwarz <bartfastiel@users.noreply.github.com> | 2017-12-06 14:40:17 +0100 |
| commit | 67b8132247f0332b1ff4df2923cc2aad479d46e4 (patch) | |
| tree | 3a9abd4b7c24718e28c2affb5344369a39ed70a2 /sonar-ws-generator/README.md | |
| parent | 481f592895b0801f245fba0615d19c83fbdc8b5c (diff) | |
| download | sonarqube-67b8132247f0332b1ff4df2923cc2aad479d46e4.tar.gz sonarqube-67b8132247f0332b1ff4df2923cc2aad479d46e4.zip | |
Add README.md to sonar-ws-generator
Diffstat (limited to 'sonar-ws-generator/README.md')
| -rw-r--r-- | sonar-ws-generator/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/sonar-ws-generator/README.md b/sonar-ws-generator/README.md new file mode 100644 index 00000000000..75369809b57 --- /dev/null +++ b/sonar-ws-generator/README.md @@ -0,0 +1,17 @@ +# What is this project used for? + +The *sonar-ws-generator* must be used to generate the java sources used to access the Web API (HTTP) of SonarQube. +The generated sources are not compilable on their own, but require to be copied in the `sonar-ws` module. + +# How do I use it? + +* Make your changes on the SonarQube Web API (protobuf specification of responses in sonar-ws or `WebService` implementations in sonar-server) +* Build SonarQube (for example with `./quick-build.sh`) +* Run this generator: `sonar-ws-generator/run.sh` +* Check your git status: the generated sources are copied in `sonar-ws/src/main/java`. Please double check the changed code. +* Now you can rebuild sonar-ws and use it in integration tests + +# Hints +* A request parameter has type `List<String>` if its description contains "comma-separated" or "list of" (case insensitive). Examples: + * "Comma-separated list of metric keys" + * "List of metric keys" |