aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-ws
diff options
context:
space:
mode:
authorBenjamin Campomenosi <109955405+benjamin-campomenosi-sonarsource@users.noreply.github.com>2023-08-22 10:47:51 +0200
committersonartech <sonartech@sonarsource.com>2023-08-22 20:03:05 +0000
commit04fc6db186342232be36c9f1b682ed218e210f9f (patch)
tree9007d9da2e1d45547fce16892202195bae08816e /sonar-ws
parent46741d608660feeaf3af8aef4980e085b3e2ba5c (diff)
downloadsonarqube-04fc6db186342232be36c9f1b682ed218e210f9f.tar.gz
sonarqube-04fc6db186342232be36c9f1b682ed218e210f9f.zip
SONAR-20198 - add clean code fields in rules endpoints
Diffstat (limited to 'sonar-ws')
-rw-r--r--sonar-ws/src/main/protobuf/ws-rules.proto25
1 files changed, 17 insertions, 8 deletions
diff --git a/sonar-ws/src/main/protobuf/ws-rules.proto b/sonar-ws/src/main/protobuf/ws-rules.proto
index e1e242b8b81..06d090623d3 100644
--- a/sonar-ws/src/main/protobuf/ws-rules.proto
+++ b/sonar-ws/src/main/protobuf/ws-rules.proto
@@ -41,9 +41,9 @@ message ListResponse {
// WS api/rules/search
message SearchResponse {
- optional int64 total = 1 [deprecated=true];
- optional int32 p = 2 [deprecated=true];
- optional int64 ps = 3 [deprecated=true];
+ optional int64 total = 1 [deprecated = true];
+ optional int32 p = 2 [deprecated = true];
+ optional int64 ps = 3 [deprecated = true];
repeated Rule rules = 4;
optional Actives actives = 5;
@@ -73,12 +73,13 @@ message Rule {
optional string repo = 2;
optional string name = 3;
optional string createdAt = 4;
- optional string htmlDesc = 5 [deprecated=true];
+ optional string htmlDesc = 5 [deprecated = true];
optional string htmlNote = 6;
optional string mdDesc = 7;
optional string mdNote = 8;
optional string noteLogin = 9;
- optional string severity = 10;
+ // Deprecated since 10.2, replace by impacts
+ optional string severity = 10 [deprecated = true];
optional sonarqube.ws.commons.RuleStatus status = 11;
optional string internalKey = 12;
optional bool isTemplate = 13;
@@ -97,16 +98,17 @@ message Rule {
optional string unusedDebtSubCharName = 28;
// Deprecated since 10.0, replaced by defaultRemFnType
- optional string defaultDebtRemFnType = 29 [deprecated=true];
+ optional string defaultDebtRemFnType = 29 [deprecated = true];
reserved 30;
reserved 31;
reserved 32;
reserved 33;
// Deprecated since 10.0, replaced by remFnType
- optional string debtRemFnType = 34 [deprecated=true];
+ optional string debtRemFnType = 34 [deprecated = true];
reserved 35;
reserved 36;
- optional sonarqube.ws.commons.RuleType type = 37;
+ // Deprecated since 10.2, replace by impacts
+ optional sonarqube.ws.commons.RuleType type = 37 [deprecated = true];
optional string defaultRemFnType = 38;
optional string defaultRemFnGapMultiplier = 39;
optional string defaultRemFnBaseEffort = 40;
@@ -121,6 +123,9 @@ message Rule {
optional DescriptionSections descriptionSections = 49;
optional EducationPrinciples educationPrinciples = 50;
optional string updatedAt = 51;
+ optional sonarqube.ws.commons.CleanCodeAttribute cleanCodeAttribute = 52;
+ optional sonarqube.ws.commons.CleanCodeAttributeCategory cleanCodeAttributeCategory = 53;
+ optional Impacts impacts = 54;
message DescriptionSections {
repeated DescriptionSection descriptionSections = 1;
@@ -149,6 +154,10 @@ message Rule {
}
}
+message Impacts{
+ repeated sonarqube.ws.commons.Impact impacts = 1;
+}
+
message DeprecatedKeys {
repeated string deprecatedKey = 1;
}