mirrors
/
sonarqube
mirror of https://github.com/SonarSource/sonarqube.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 237 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27990 Commits
59 Branches
Tree: 8e0777254f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '8e0777254f'
${ noResults }
sonarqube/sonar-ws-generator
Julien Lancelot e428c8d049 Update license headers templates in sonar-ws-generators 5 years ago
..
src/main Update license headers templates in sonar-ws-generators 5 years ago
README.md Add README.md to sonar-ws-generator 6 years ago
build.gradle Use consistent version of gson 6 years ago
run.sh Move To Gradle 6 years ago

README.md

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”