Fix embedded messages (#280)

* Handle readonly and writeonly for all versions above draft-06 * protoc-gen-jsonschema: fix embedded messages with embedded messages All schemas in definitions and definitions from embedded messages will now be written on the root schema. * Fix naming of sub messages * Fix failing test
pubgo · Jan 6, 2022 · 7f9a651 · 7f9a651
1 parent 82ab4fb
commit 7f9a651
Show file tree

Hide file tree

Showing 10 changed files with 263 additions and 41 deletions.
diff --git a/apps/protoc-gen-jsonschema/examples/tests/embedded/message.proto b/apps/protoc-gen-jsonschema/examples/tests/embedded/message.proto
@@ -0,0 +1,46 @@
+// Copyright 2021 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+syntax = "proto3";
+
+package tests.embedded.message.v1;
+
+import "google/api/annotations.proto";
+
+option go_package = "github.com/google/gnostic/apps/protoc-gen-openapi/examples/tests/embedded/message/v1;message";
+
+service Messaging {
+  rpc UpdateMessage(Message) returns (Message) {
+    option (google.api.http) = {
+      post : "/v1/messages/{message_id}"
+      body : "*"
+    };
+  }
+}
+
+message Message {
+  string message_id = 1;
+  message Comment {
+    string id = 1;
+    string content = 2;
+    message Reply {
+      string id = 1;
+      string comment_id = 2;
+      string content = 3;
+    }
+    repeated Reply replies = 3;
+  }
+  repeated Comment comments = 2;
+}
diff --git a/apps/protoc-gen-jsonschema/examples/tests/embedded/schemas_json/Message.json b/apps/protoc-gen-jsonschema/examples/tests/embedded/schemas_json/Message.json
@@ -0,0 +1,60 @@
+{
+  "title": "Message",
+  "$id": "http://example.com/schemas/Message.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "messageId": {
+      "title": "messageId",
+      "type": "string"
+    },
+    "comments": {
+      "title": "comments",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Message_Comment"
+      }
+    }
+  },
+  "definitions": {
+    "Message_Comment_Reply": {
+      "title": "Reply",
+      "type": "object",
+      "properties": {
+        "id": {
+          "title": "id",
+          "type": "string"
+        },
+        "commentId": {
+          "title": "commentId",
+          "type": "string"
+        },
+        "content": {
+          "title": "content",
+          "type": "string"
+        }
+      }
+    },
+    "Message_Comment": {
+      "title": "Comment",
+      "type": "object",
+      "properties": {
+        "id": {
+          "title": "id",
+          "type": "string"
+        },
+        "content": {
+          "title": "content",
+          "type": "string"
+        },
+        "replies": {
+          "title": "replies",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Message_Comment_Reply"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/apps/protoc-gen-jsonschema/examples/tests/embedded/schemas_proto/Message.json b/apps/protoc-gen-jsonschema/examples/tests/embedded/schemas_proto/Message.json
@@ -0,0 +1,60 @@
+{
+  "title": "Message",
+  "$id": "http://example.com/schemas/Message.json",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "message_id": {
+      "title": "message_id",
+      "type": "string"
+    },
+    "comments": {
+      "title": "comments",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Message_Comment"
+      }
+    }
+  },
+  "definitions": {
+    "Message_Comment_Reply": {
+      "title": "Reply",
+      "type": "object",
+      "properties": {
+        "id": {
+          "title": "id",
+          "type": "string"
+        },
+        "comment_id": {
+          "title": "comment_id",
+          "type": "string"
+        },
+        "content": {
+          "title": "content",
+          "type": "string"
+        }
+      }
+    },
+    "Message_Comment": {
+      "title": "Comment",
+      "type": "object",
+      "properties": {
+        "id": {
+          "title": "id",
+          "type": "string"
+        },
+        "content": {
+          "title": "content",
+          "type": "string"
+        },
+        "replies": {
+          "title": "replies",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Message_Comment_Reply"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/apps/protoc-gen-jsonschema/examples/tests/embedded/testdata_json/Message.json b/apps/protoc-gen-jsonschema/examples/tests/embedded/testdata_json/Message.json
@@ -0,0 +1,27 @@
+{
+  "messageId": "123abc",
+  "comments": [
+    {
+      "id": "abc123",
+      "content": "first comment",
+      "replies": [
+        {
+          "id": "xyz123",
+          "commentId": "abc123",
+          "content": "first reply to first comment"
+        }
+      ]
+    },
+    {
+      "id": "123abc",
+      "content": "second comment",
+      "replies": [
+        {
+          "id": "123xyz",
+          "commentId": "123abc",
+          "content": "first reply to second comment"
+        }
+      ]
+    }
+  ]
+}
diff --git a/apps/protoc-gen-jsonschema/examples/tests/mapfields/schemas_json/Message.json b/apps/protoc-gen-jsonschema/examples/tests/mapfields/schemas_json/Message.json
@@ -14,7 +14,7 @@
       "$ref": "http://example.com/schemas/AnotherMessage.json"
     },
     "subMessage": {
-      "$ref": "#/definitions/SubMessage"
+      "$ref": "#/definitions/Message_SubMessage"
     },
     "stringList": {
       "title": "stringList",
@@ -27,7 +27,7 @@
       "title": "subMessageList",
       "type": "array",
       "items": {
-        "$ref": "#/definitions/SubMessage"
+        "$ref": "#/definitions/Message_SubMessage"
       }
     },
     "anotherMessageList": {
@@ -55,7 +55,7 @@
       "title": "subMessagesMap",
       "type": "object",
       "additionalProperties": {
-        "$ref": "#/definitions/SubMessage"
+        "$ref": "#/definitions/Message_SubMessage"
       }
     },
     "anotherMessagesMap": {
@@ -74,10 +74,8 @@
     }
   },
   "definitions": {
-    "SubMessage": {
+    "Message_SubMessage": {
       "title": "SubMessage",
-      "$id": "/schemas/SubMessage",
-      "$schema": "http://json-schema.org/draft-07/schema#",
       "type": "object",
       "properties": {
         "id": {

diff --git a/apps/protoc-gen-jsonschema/examples/tests/mapfields/schemas_proto/Message.json b/apps/protoc-gen-jsonschema/examples/tests/mapfields/schemas_proto/Message.json
@@ -14,7 +14,7 @@
       "$ref": "http://example.com/schemas/AnotherMessage.json"
     },
     "sub_message": {
-      "$ref": "#/definitions/SubMessage"
+      "$ref": "#/definitions/Message_SubMessage"
     },
     "string_list": {
       "title": "string_list",
@@ -27,7 +27,7 @@
       "title": "sub_message_list",
       "type": "array",
       "items": {
-        "$ref": "#/definitions/SubMessage"
+        "$ref": "#/definitions/Message_SubMessage"
       }
     },
     "another_message_list": {
@@ -55,7 +55,7 @@
       "title": "sub_messages_map",
       "type": "object",
       "additionalProperties": {
-        "$ref": "#/definitions/SubMessage"
+        "$ref": "#/definitions/Message_SubMessage"
       }
     },
     "another_messages_map": {
@@ -74,10 +74,8 @@
     }
   },
   "definitions": {
-    "SubMessage": {
+    "Message_SubMessage": {
       "title": "SubMessage",
-      "$id": "/schemas/SubMessage",
-      "$schema": "http://json-schema.org/draft-07/schema#",
       "type": "object",
       "properties": {
         "id": {