SONAR-12717 add WS api/workflows/search

returns unresolved hotspots of a project, with components and rules details

1 files changed, 61 insertions, 0 deletions

diff --git a/sonar-ws/src/main/protobuf/ws-hotspots.proto b/sonar-ws/src/main/protobuf/ws-hotspots.proto
new file mode 100644
index 00000000000..6630860bdff
--- /dev/null
+++ b/sonar-ws/src/main/protobuf/ws-hotspots.proto
@@ -0,0 +1,61 @@
+// SonarQube, open source software quality management tool.
+// Copyright (C) 2008-2016 SonarSource
+// mailto:contact AT sonarsource DOT com
+//
+// SonarQube is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 3 of the License, or (at your option) any later version.
+//
+// SonarQube is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with this program; if not, write to the Free Software Foundation,
+// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+syntax = "proto2";
+
+package sonarqube.ws.hotspots;
+
+import "ws-commons.proto";
+
+option java_package = "org.sonarqube.ws";
+option java_outer_classname = "Hotspots";
+option optimize_for = SPEED;
+
+// Response of GET api/hotspots/search
+message SearchWsResponse {
+  optional sonarqube.ws.commons.Paging paging = 1;
+  repeated Hotspot hotspots = 2;
+  repeated Component components = 3;
+  optional sonarqube.ws.commons.Rules rules = 4;
+}
+
+message Hotspot {
+  optional string key = 1;
+  optional string component = 2;
+  optional string project = 3;
+  optional string rule = 4;
+  optional string status = 5;
+//  FIXME resolution field will be added later
+//  optional string resolution = 6;
+  optional int32 line = 7;
+  optional string message = 8;
+  optional string assignee = 9;
+  // SCM login of the committer who introduced the issue
+  optional string author = 10;
+  optional string creationDate = 11;
+  optional string updateDate = 12;
+}
+
+message Component {
+  optional string organization = 1;
+  optional string key = 2;
+  optional string qualifier = 3;
+  optional string name = 4;
+  optional string longName = 5;
+  optional string path = 6;
+}