aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-ws/src/main/protobuf/ws-hotspots.proto
blob: ef4721c44ddade0da1e30475333e43c7f8dd6ac6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// 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;

  message Hotspot {
    optional string key = 1;
    optional string component = 2;
    optional string project = 3;
    optional string securityCategory = 4;
    optional string vulnerabilityProbability = 5;
    optional string status = 6;
    optional string resolution = 7;
    optional int32 line = 8;
    optional string message = 9;
    optional string assignee = 10;
    optional string author = 11;
    optional string creationDate = 12;
    optional string updateDate = 13;
    optional sonarqube.ws.commons.TextRange textRange = 14;
    repeated sonarqube.ws.commons.Flow flows = 15;
    optional string ruleKey = 16;
    repeated sonarqube.ws.commons.MessageFormatting messageFormattings = 17;
  }
}

// Response of GET api/hotspots/list
message ListWsResponse {
  optional sonarqube.ws.commons.Paging paging = 1;
  repeated SearchWsResponse.Hotspot hotspots = 2;
}

// Response of GET api/hotspots/show
message ShowWsResponse {
  optional string key = 1;
  optional Component component = 2;
  optional Component project = 3;
  optional Rule rule = 4;
  optional string status = 5;
  optional string resolution = 6;
  optional int32 line = 7;
  optional string hash = 18;
  optional string message = 8;
  optional string assignee = 9;
  optional string author = 10;
  optional string creationDate = 11;
  optional string updateDate = 12;
  optional sonarqube.ws.commons.TextRange textRange = 13;
  repeated sonarqube.ws.commons.Changelog changelog = 14;
  repeated sonarqube.ws.commons.Comment comment = 15;
  repeated sonarqube.ws.commons.User users = 16;
  optional bool canChangeStatus = 17;
  repeated sonarqube.ws.commons.Flow flows = 19;
  repeated sonarqube.ws.commons.MessageFormatting messageFormattings = 20;
  repeated string codeVariants = 21;
}

message Component {
  reserved 1; //drop organization
  optional string key = 2;
  optional string qualifier = 3;
  optional string name = 4;
  optional string longName = 5;
  optional string path = 6;
  optional string branch = 7;
  optional string pullRequest = 8;
}


message Rule {
  optional string key = 1;
  optional string name = 2;
  optional string securityCategory = 3;
  optional string vulnerabilityProbability = 4;
  optional string riskDescription = 5 [deprecated = true];
  optional string vulnerabilityDescription = 6 [deprecated = true];
  optional string fixRecommendations = 7 [deprecated = true];
}

// Response of GET api/hotspots/pull
message HotspotPullQueryTimestamp {
  required int64 queryTimestamp = 1;
}

message HotspotLite {
  optional string key = 1;
  optional string filePath = 2;
  optional string vulnerabilityProbability = 3;
  optional string status = 4;
  optional string resolution = 5;
  optional string message = 6;
  optional int64 creationDate = 7;
  optional TextRange textRange = 8;
  optional string ruleKey = 9;
  optional bool closed = 10;
  optional string assignee = 11;
}

message TextRange {
  optional int32 startLine = 1;
  optional int32 startLineOffset = 2;
  optional int32 endLine = 3;
  optional int32 endLineOffset = 4;
  optional string hash = 5;
}