Skip to content

Commit e9a54b4

Browse files
committed
Update proto comment of related_locations
1 parent beddc7e commit e9a54b4

File tree

5 files changed

+28
-10
lines changed

5 files changed

+28
-10
lines changed

proto/rdf/jsonschema/Diagnostic.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@
5959
"items": {
6060
"$ref": "#/definitions/reviewdog.rdf.RelatedLocation"
6161
},
62-
"type": "array"
62+
"type": "array",
63+
"description": "Related locations for this diagnostic. Optional."
6364
}
6465
},
6566
"additionalProperties": true,
@@ -134,11 +135,13 @@
134135
"reviewdog.rdf.RelatedLocation": {
135136
"properties": {
136137
"message": {
137-
"type": "string"
138+
"type": "string",
139+
"description": "Explanation of this related location. Optional."
138140
},
139141
"location": {
140142
"$ref": "#/definitions/reviewdog.rdf.Location",
141-
"additionalProperties": true
143+
"additionalProperties": true,
144+
"description": "Required."
142145
}
143146
},
144147
"additionalProperties": true,

proto/rdf/jsonschema/DiagnosticResult.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@
114114
"items": {
115115
"$ref": "#/definitions/reviewdog.rdf.RelatedLocation"
116116
},
117-
"type": "array"
117+
"type": "array",
118+
"description": "Related locations for this diagnostic. Optional."
118119
}
119120
},
120121
"additionalProperties": true,
@@ -174,11 +175,13 @@
174175
"reviewdog.rdf.RelatedLocation": {
175176
"properties": {
176177
"message": {
177-
"type": "string"
178+
"type": "string",
179+
"description": "Explanation of this related location. Optional."
178180
},
179181
"location": {
180182
"$ref": "#/definitions/reviewdog.rdf.Location",
181-
"additionalProperties": true
183+
"additionalProperties": true,
184+
"description": "Required."
182185
}
183186
},
184187
"additionalProperties": true,

proto/rdf/jsonschema/RelatedLocation.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
"RelatedLocation": {
66
"properties": {
77
"message": {
8-
"type": "string"
8+
"type": "string",
9+
"description": "Explanation of this related location. Optional."
910
},
1011
"location": {
1112
"$ref": "#/definitions/reviewdog.rdf.Location",
12-
"additionalProperties": true
13+
"additionalProperties": true,
14+
"description": "Required."
1315
}
1416
},
1517
"additionalProperties": true,

proto/rdf/reviewdog.pb.go

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

proto/rdf/reviewdog.proto

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ message Diagnostic {
6565
// Optional.
6666
string original_output = 7;
6767

68+
// Related locations for this diagnostic.
69+
// Optional.
6870
repeated RelatedLocation related_locations = 8;
6971
}
7072

@@ -85,8 +87,11 @@ message Location {
8587
}
8688

8789
message RelatedLocation {
90+
// Explanation of this related location.
91+
// Optional.
8892
string message = 1;
8993

94+
// Required.
9095
Location location = 2;
9196
}
9297

0 commit comments

Comments
 (0)