Update proto comment of related_locations

northwood-labs · Jun 14, 2024 · 34a54e5 · 34a54e5
1 parent 1763917
commit 34a54e5
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 10 deletions.
diff --git a/proto/rdf/jsonschema/Diagnostic.json b/proto/rdf/jsonschema/Diagnostic.json
@@ -59,7 +59,8 @@
                     "items": {
                         "$ref": "#/definitions/reviewdog.rdf.RelatedLocation"
                     },
-                    "type": "array"
+                    "type": "array",
+                    "description": "Related locations for this diagnostic. Optional."
                 }
             },
             "additionalProperties": true,
@@ -134,11 +135,13 @@
         "reviewdog.rdf.RelatedLocation": {
             "properties": {
                 "message": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "Explanation of this related location. Optional."
                 },
                 "location": {
                     "$ref": "#/definitions/reviewdog.rdf.Location",
-                    "additionalProperties": true
+                    "additionalProperties": true,
+                    "description": "Required."
                 }
             },
             "additionalProperties": true,

diff --git a/proto/rdf/jsonschema/DiagnosticResult.json b/proto/rdf/jsonschema/DiagnosticResult.json
@@ -114,7 +114,8 @@
                     "items": {
                         "$ref": "#/definitions/reviewdog.rdf.RelatedLocation"
                     },
-                    "type": "array"
+                    "type": "array",
+                    "description": "Related locations for this diagnostic. Optional."
                 }
             },
             "additionalProperties": true,
@@ -174,11 +175,13 @@
         "reviewdog.rdf.RelatedLocation": {
             "properties": {
                 "message": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "Explanation of this related location. Optional."
                 },
                 "location": {
                     "$ref": "#/definitions/reviewdog.rdf.Location",
-                    "additionalProperties": true
+                    "additionalProperties": true,
+                    "description": "Required."
                 }
             },
             "additionalProperties": true,

diff --git a/proto/rdf/jsonschema/RelatedLocation.json b/proto/rdf/jsonschema/RelatedLocation.json
@@ -5,11 +5,13 @@
         "RelatedLocation": {
             "properties": {
                 "message": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "Explanation of this related location. Optional."
                 },
                 "location": {
                     "$ref": "#/definitions/reviewdog.rdf.Location",
-                    "additionalProperties": true
+                    "additionalProperties": true,
+                    "description": "Required."
                 }
             },
             "additionalProperties": true,

diff --git a/proto/rdf/reviewdog.pb.go b/proto/rdf/reviewdog.pb.go
diff --git a/proto/rdf/reviewdog.proto b/proto/rdf/reviewdog.proto
@@ -65,6 +65,8 @@ message Diagnostic {
   // Optional.
   string original_output = 7;
 
+  // Related locations for this diagnostic.
+  // Optional.
   repeated RelatedLocation related_locations = 8;
 }
 
@@ -85,8 +87,11 @@ message Location {
 }
 
 message RelatedLocation {
+  // Explanation of this related location.
+  // Optional.
   string message = 1;
 
+  // Required.
   Location location = 2;
 }