Required and Repeated fields (#23)

aep-dev · Sep 15, 2024 · 3bd6113 · 3bd6113
1 parent 1e577cf
commit 3bd6113
Show file tree

Hide file tree

Showing 10 changed files with 352 additions and 301 deletions.
diff --git a/example/bookstore/v1/bookstore.pb.go b/example/bookstore/v1/bookstore.pb.go
diff --git a/example/bookstore/v1/bookstore.proto b/example/bookstore/v1/bookstore.proto
@@ -62,10 +62,16 @@ service Bookstore {
 // A Book resource.
 message Book {
   // Field for isbn.
-  string isbn = 1;
+  repeated string isbn = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Field for details.
-  Details details = 2;
+  // Field for price.
+  float price = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Field for published.
+  bool published = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Field for edition.
+  int32 edition = 4;
 
   // Field for path.
   string path = 10000;
@@ -157,12 +163,3 @@ message ApplyBookRequest {
   // The resource to perform the operation on.
   Book book = 10015 [(google.api.field_behavior) = REQUIRED];
 }
-
-// A Details resource.
-message Details {
-  // Field for edition.
-  string edition = 1;
-
-  // Field for supported_ereaders.
-  string supported_ereaders = 2;
-}
diff --git a/example/bookstore/v1/bookstore.swagger.json b/example/bookstore/v1/bookstore.swagger.json
@@ -299,12 +299,25 @@
       "type": "object",
       "properties": {
         "isbn": {
-          "type": "string",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
           "description": "Field for isbn."
         },
-        "details": {
-          "$ref": "#/definitions/v1Details",
-          "description": "Field for details."
+        "price": {
+          "type": "number",
+          "format": "float",
+          "description": "Field for price."
+        },
+        "published": {
+          "type": "boolean",
+          "description": "Field for published."
+        },
+        "edition": {
+          "type": "integer",
+          "format": "int32",
+          "description": "Field for edition."
         },
         "path": {
           "type": "string",
@@ -315,21 +328,12 @@
           "description": "Field for id."
         }
       },
-      "description": "A Book resource."
-    },
-    "v1Details": {
-      "type": "object",
-      "properties": {
-        "edition": {
-          "type": "string",
-          "description": "Field for edition."
-        },
-        "supportedEreaders": {
-          "type": "string",
-          "description": "Field for supported_ereaders."
-        }
-      },
-      "description": "A Details resource."
+      "description": "A Book resource.",
+      "required": [
+        "isbn",
+        "price",
+        "published"
+      ]
     },
     "v1ListBookResponse": {
       "type": "object",

diff --git a/example/bookstore/v1/bookstore.yaml b/example/bookstore/v1/bookstore.yaml
@@ -5,14 +5,22 @@ resources:
     plural: "books"
     properties:
       isbn:
-        type: STRING
+        type: ARRAY
+        array_primitive_type: STRING
         number: 1
         required: true
-      details:
-        type: OBJECT
+      price:
+        type: FLOAT
         number: 2
         required: true
-        object_type: Details
+      published:
+        type: BOOLEAN
+        number: 3
+        required: true
+      edition:
+        type: INT32
+        number: 4
+        required: false
     # parents:
     #   - "bookstore.example.com/Publisher"
     methods:
@@ -37,12 +45,3 @@ resources:
 #       - "Publisher"
 #     methods:
 #       read: {}
-objects:
-  - kind: "Details"
-    properties:
-      edition:
-        type: STRING
-        number: 1
-      supported_ereaders:
-        type: STRING
-        number: 2
diff --git a/example/bookstore/v1/bookstore_openapi.json b/example/bookstore/v1/bookstore_openapi.json
@@ -111,34 +111,35 @@
       "type": "object",
       "required": [
         "isbn",
-        "details"
+        "price",
+        "published"
       ],
       "properties": {
-        "details": {
-          "$ref": "#/components/schemas/Details"
+        "edition": {
+          "type": "integer",
+          "format": "int32"
         },
         "id": {
           "type": "string",
           "readOnly": true,
           "x-terraform-id": true
         },
         "isbn": {
-          "type": "string"
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         },
         "path": {
           "type": "string",
           "readOnly": true
-        }
-      }
-    },
-    "Details": {
-      "type": "object",
-      "properties": {
-        "edition": {
-          "type": "string"
         },
-        "supported_ereaders": {
-          "type": "string"
+        "price": {
+          "type": "number",
+          "format": "float"
+        },
+        "published": {
+          "type": "boolean"
         }
       }
     }

diff --git a/schema/resourcedefinition.pb.go b/schema/resourcedefinition.pb.go
diff --git a/schema/resourcedefinition.proto b/schema/resourcedefinition.proto
@@ -61,6 +61,7 @@ enum Type {
   FLOAT = 5;
   BOOLEAN = 6;
   OBJECT = 7;
+  ARRAY = 8;
 }
 
 message Property {
@@ -73,4 +74,9 @@ message Property {
 
   // If type is OBJECT, this is the name of the object in `messages`.
   string object_type = 5;
+
+  oneof array_type {
+    string array_object_type = 6;
+    Type array_primitive_type = 7;
+  }
 }
diff --git a/writer/openapi/openapi.go b/writer/openapi/openapi.go
@@ -7,6 +7,7 @@ import (
 
 	"github.com/aep-dev/aepc/constants"
 	"github.com/aep-dev/aepc/parser"
+	"github.com/aep-dev/aepc/schema"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 )
@@ -174,7 +175,7 @@ func resourceToSchema(r *parser.ParsedResource) (Schema, error) {
 		if err != nil {
 			return Schema{}, err
 		}
-		properties[f.Name] = Schema{
+		s := Schema{
 			Type:         t.openapi_type,
 			Format:       t.openapi_format,
 			Ref:          t.openapi_ref,
@@ -184,6 +185,13 @@ func resourceToSchema(r *parser.ParsedResource) (Schema, error) {
 		if f.Required {
 			required = append(required, f.Name)
 		}
+		if f.Type == schema.Type_ARRAY {
+			s.Items = &Schema{
+				Type: t.array_type.openapi_type,
+				Format: t.array_type.openapi_format,
+			}
+		}
+		properties[f.Name] = s
 	}
 	return Schema{
 		Type:       "object",