How to access extended rule description through web API?

  • which versions are you using (SonarQube, Scanner, Plugin, and any relevant extension)
  • what are you trying to achieve
    I’d like to access extended (custom) rule description through web API
  • what have you tried so far to achieve this
    I add an extended description to a rule through SQ web interface
    I access this rule through api/rules/show resource then I look at htmlDesc field but this field doesn’t contain my extended description


This is working for me in the latest version.

Speaking of which, 6.7.6 has some age on it at this point. The current version is 8.0 (8.1 to drop any day now) and the current LTS is 7.9.1. You should upgrade at your earliest convenience.


Many thanks Ann for your answer!

Unfortunately we are currently stuck with 6.x because of the sonar.branch parameter deprecation (7.8).

Best regards,

Yeah this is way late, but I saw this while searching a related topic, so in case anyone else is looking this up…

IDK about 6.x, but in 8.6, the extended description is in fields htmlNote and mdNote, which are distinct from htmlDesc / mdDesc, which only show the built-in description for non-custom rules. So try those fields.

1 Like