@restorecommerce/protos 2.0.2 → 3.0.1

package/io/restorecommerce/product.proto

@@ -2,20 +2,21 @@ syntax = "proto3";
 
 package io.restorecommerce.product;
 
+import "google/protobuf/any.proto";
 import "io/restorecommerce/resource_base.proto";
 import "io/restorecommerce/meta.proto";
 import "io/restorecommerce/image.proto";
+import "io/restorecommerce/file.proto";
 import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/geometry.proto";
 import "io/restorecommerce/options.proto";
 
 // Used by resolvers
 import "io/restorecommerce/manufacturer.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "product";
-
+service ProductService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -25,22 +26,63 @@ service Service {
   rpc Upsert (ProductList) returns (ProductListResponse);
 }
 
-// Product resource
-message MainProduct {
-  string id = 1;
+enum AssociationType {
+  Miscellaneous = 0;
+  Accessory = 1;
+  Recommendation = 2;
+}
+
+message Association {
+  optional string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.product.Product",
+      target_service: "catalog",
+      target_sub_service: "product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  AssociationType type = 2;
+  repeated string tags = 3;
+  google.protobuf.Any data = 4;
+}
+
+message Appendix {
+  optional int64 index = 1;
+  optional string name = 2;
+  optional string description = 3;
+  repeated string tags = 4;
+  optional string url = 5;
+  optional string content_type = 6;
+  optional io.restorecommerce.image.Image thumbnail = 7;
+}
+
+// Product resource entity
+message Product {
+  option (restorecommerce.options.kafka_subscriber) = {
+    plural: "products"
+    topic: "io.restorecommerce.product.resource"
+    created: "productCreated"
+    updated: "productUpdated"
+    deleted: "productDeleted"
+  };
+
+  optional string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
   oneof product_type {
-    Product product = 2;
-    Bundle bundle = 3;
+    IndividualProduct product = 3;
+    Bundle bundle = 4;
   }
-  bool active = 4;
-  io.restorecommerce.meta.Meta meta = 5;
+  optional bool active = 5;
+  repeated string tags = 6;
+  repeated Association associations = 7;
+  google.protobuf.Any data = 8;
 }
 
-message Product {
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  string manufacturer_id = 4 [
+message IndividualProduct {
+  optional string name = 1;
+  optional string description = 2;
+  optional string manufacturer_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.manufacturer.Manufacturer",
       target_service: "catalog",
@@ -49,24 +91,47 @@ message Product {
       field_name: "manufacturer",
     }
   ];
-  string taric_code = 5;
+  optional string taric_code = 4;
   oneof classification {
-    Identifier prototype = 6;
-    Identifier category = 7;
+    string prototype_id = 5 [
+      (io.restorecommerce.options.resolver) = {
+        target_type: ".io.restorecommerce.product_prototype.ProductPrototype",
+        target_service: "catalog",
+        target_sub_service: "product_prototype",
+        target_method: "Read",
+        field_name: "prototype",
+      }
+    ];
+    string category_id = 6 [
+      (io.restorecommerce.options.resolver) = {
+        target_type: ".io.restorecommerce.product_category.ProductCategory",
+        target_service: "catalog",
+        target_sub_service: "product_category",
+        target_method: "Read",
+        field_name: "category",
+      }
+    ];
   }
-  repeated string tax_id = 8;
-  repeated Variant variants = 9;
-  string gtin = 10;
+  repeated string tax_ids = 7;
+  optional string gtin = 8;
+  oneof nature {
+    PhysicalProduct physical = 9;
+    VirtualProduct virtual = 10;
+  };
+}
+
+message PhysicalProduct {
+  repeated PhysicalVariant variants = 1;
 }
 
-message Identifier {
-  string id = 1;
+message VirtualProduct {
+  repeated VirtualVariant variants = 1;
 }
 
 message ProductList {
-  repeated MainProduct items = 1;
-  uint32 total_count = 2;
-  io.restorecommerce.auth.Subject subject = 3;
+  repeated Product items = 1;
+  optional uint32 total_count = 2;
+  optional io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ProductListResponse {
@@ -76,38 +141,71 @@ message ProductListResponse {
 }
 
 message ProductResponse {
-  MainProduct payload = 1;
+  Product payload = 1;
   io.restorecommerce.status.Status status = 3;
 }
 
-message Variant {
-  string id = 1;
-  string name = 2;
-  string description = 3;
-  int32 stock_level = 4;
-  double price = 5;
-  bool sale = 6;
-  double sale_price = 7;
-  repeated io.restorecommerce.image.Image image = 8;
-  string stock_keeping_unit = 9;
-  string template_variant = 10;
-  repeated io.restorecommerce.attribute.Attribute attributes = 11;
+message Package {
+  optional io.restorecommerce.geometry.BoundingBox3D size_in_cm = 1;
+  optional double weight_in_kg = 2;
+  optional bool rotatable = 3;
+}
+
+message PhysicalVariant {
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional int32 stock_level = 4;
+  optional double price = 5;
+  optional bool sale = 6;
+  optional double sale_price = 7;
+  repeated io.restorecommerce.image.Image images = 8;
+  repeated io.restorecommerce.file.File files = 9;
+  optional string stock_keeping_unit = 10;
+  optional string template_variant = 11;
+  optional Package package = 12;
+  repeated io.restorecommerce.attribute.Attribute attributes = 13;
+}
+
+message VirtualVariant {
+  optional string id = 1;
+  optional string name = 2;
+  optional string description = 3;
+  optional int32 stock_level = 4;
+  optional double price = 5;
+  optional bool sale = 6;
+  optional double sale_price = 7;
+  repeated io.restorecommerce.image.Image images = 8;
+  repeated io.restorecommerce.file.File files = 9;
+  optional string stock_keeping_unit = 10;
+  optional string template_variant = 11;
+  repeated io.restorecommerce.attribute.Attribute attributes = 12;
 }
 
 message Bundle {
-  string id = 1;
-  string name = 3;
-  string description = 4;
-  repeated io.restorecommerce.image.Image image = 5;
-  repeated BundleProduct product = 6;
-  double price = 7;
+  optional string name = 1;
+  optional string description = 2;
+  repeated io.restorecommerce.image.Image images = 3;
+  repeated BundleProduct products = 4;
+  optional double price = 5;
+  optional Package pre_packaged = 6;
 }
 
 message BundleProduct {
-  string product_id = 1;
-  uint32 quantity = 2;
+  optional string product_id = 1 [
+    (io.restorecommerce.options.resolver) = {
+      target_type: ".io.restorecommerce.product.Product",
+      target_service: "catalog",
+      target_sub_service: "product",
+      target_method: "Read",
+      field_name: "product",
+    }
+  ];
+  optional string variant_id = 2;
+  optional uint32 quantity = 3;
+  optional double tax_ratio = 4; //Discount in relation to the bundle price
 }
 
 message Deleted {
-  string id = 1;
+  optional string id = 1;
 }

package/io/restorecommerce/product_category.proto

@@ -14,11 +14,11 @@ import "io/restorecommerce/price_group.proto";
 
 // ProductCategory resource
 message ProductCategory {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  string price_group_id = 5 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional string price_group_id = 5 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.price_group.PriceGroup",
       target_service: "catalog",
@@ -27,13 +27,13 @@ message ProductCategory {
       field_name: "priceGroup",
     }
   ];
-  io.restorecommerce.image.Image image = 6;
-  Parent parent = 7;
+  optional io.restorecommerce.image.Image image = 6;
+  optional Parent parent = 7;
 }
 
 message ProductCategoryList {
   repeated ProductCategory items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -53,12 +53,10 @@ message Deleted {
 }
 
 message Parent {
-  string parent_id = 1;
+  optional string parent_id = 1;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "product_category";
-
+service ProductCategoryService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductCategoryListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/product_prototype.proto

@@ -10,17 +10,17 @@ import "io/restorecommerce/options.proto";
 
 // ProductPrototype resource
 message ProductPrototype {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string version = 4;
-  string description = 5;
-  string category_id = 6;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string version = 4;
+  optional string description = 5;
+  optional string category_id = 6;
 }
 
 message ProductPrototypeList {
   repeated ProductPrototype items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -39,9 +39,7 @@ message Deleted {
   string id = 1;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "product_prototype";
-
+service ProductPrototypeService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductPrototypeListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/rendering.proto

@@ -25,10 +25,10 @@ message Payload {
 message RenderRequest {
   string id = 1; // identifies the render request payload
   // List of templates with associated data and rendering options
-  repeated Payload payload = 2;
+  repeated Payload payloads = 2;
 }
 
 message RenderResponse {
   string id = 1;
-  repeated google.protobuf.Any response = 2;  // error or HTML contents
+  repeated google.protobuf.Any responses = 2;  // error or HTML contents
 }

package/io/restorecommerce/resource_base.proto

@@ -17,8 +17,8 @@ service Service {
 }
 
 message FieldFilter {
-  string name = 1;
-  bool include = 2;
+  optional string name = 1;
+  optional bool include = 2;
 }
 
 message Sort {
@@ -28,7 +28,7 @@ message Sort {
     DESCENDING = 2;
   }
   string field = 1;
-  SortOrder order = 2;
+  optional SortOrder order = 2;
 }
 
 message Filter {
@@ -53,35 +53,35 @@ message Filter {
     DATE = 3;
     ARRAY = 4;
   }
-  ValueType type = 4;
+  optional ValueType type = 4;
   repeated io.restorecommerce.filter.FilterOp filters = 5; // for nested filtering and to make optional its in separate filter.proto file
 }
 
 message FilterOp {
-  repeated Filter filter = 1;
+  repeated Filter filters = 1;
   enum Operator {
     and = 0;
     or = 1;
   }
-  Operator operator = 2;
+  optional Operator operator = 2;
 }
 
 message Search {
-  string search = 1; // search string
+  optional string search = 1; // search string
   repeated string fields = 2; // list of fields to be searched on entity (if not specified all indexed fields will be searched)
-  bool case_sensitive = 3; // default search is case insensitive
+  optional bool case_sensitive = 3; // default search is case insensitive
 }
 
 message ReadRequest {
-  uint32 offset = 1;
-  uint32 limit = 2;
-  repeated Sort sort = 3;
+  optional uint32 offset = 1;
+  optional uint32 limit = 2;
+  repeated Sort sorts = 3;
 
   /// Filter based on fieldName|operation, value|list
   repeated FilterOp filters = 4; // repeated filters
 
   /// Fields selector
-  repeated FieldFilter field = 5;
+  repeated FieldFilter fields = 5;
 
   /** Check the query parameters of HTTP request.
     * If query parameter `locales` is given,
@@ -93,19 +93,19 @@ message ReadRequest {
   repeated string locales_limiter = 7;
 
   repeated string custom_queries = 8;
-  google.protobuf.Any custom_arguments = 9;
+  optional google.protobuf.Any custom_arguments = 9;
   io.restorecommerce.auth.Subject subject = 10;
-  Search search = 11;
+  optional Search search = 11;
 }
 
 message DeleteRequest {
   /// Request to purge the whole collection
-  bool collection = 1;
+  optional bool collection = 1;
   /// Delete specified documents
   repeated string ids = 2;
   io.restorecommerce.auth.Subject subject = 3;
-  repeated string view = 4; // list of views to be dropped
-  repeated string analyzer = 5; // list of analyzers to be deleted
+  repeated string views = 4; // list of views to be dropped
+  repeated string analyzers = 5; // list of analyzers to be deleted
 }
 
 message DeleteResponse {
@@ -116,7 +116,7 @@ message DeleteResponse {
 /// List of resources
 message ResourceList {
   repeated Resource items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -135,6 +135,6 @@ message ResourceResponse {
 
 /// Example resource
 message Resource {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
 }

package/io/restorecommerce/role.proto

@@ -8,9 +8,7 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/status.proto";
 import "io/restorecommerce/options.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "role";
-
+service RoleService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RoleListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -21,16 +19,16 @@ service Service {
 }
 
 message Role {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3; // specifies the role of the user
-  string description = 4;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3; // specifies the role of the user
+  optional string description = 4;
   repeated string assignable_by_roles = 5; // role id who can assign this role
 }
 
 message RoleList {
   repeated Role items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 

package/io/restorecommerce/rule.proto

@@ -14,9 +14,9 @@ import "io/restorecommerce/options.proto";
 * Target specified by a Rule or a Request.
 */
 message Target {
-  repeated io.restorecommerce.attribute.Attribute subject = 1;
+  repeated io.restorecommerce.attribute.Attribute subjects = 1;
   repeated io.restorecommerce.attribute.Attribute resources = 2;
-  repeated io.restorecommerce.attribute.Attribute action = 3;
+  repeated io.restorecommerce.attribute.Attribute actions = 3;
 }
 
 /**
@@ -28,29 +28,29 @@ enum Effect {
 }
 
 message Rule {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  Target target = 5;
-  ContextQuery context_query = 6;
-  string condition = 7; // JS code
-  Effect effect = 8;
-  bool evaluation_cacheable = 9;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional Target target = 5;
+  optional ContextQuery context_query = 6;
+  optional string condition = 7; // JS code
+  optional Effect effect = 8;
+  optional bool evaluation_cacheable = 9;
 }
 
 message RuleRQ { // used for `whatIsAllowed` / reverse queries
-  string id = 1;
-  Target target = 2;
-  Effect effect = 3;
-  string condition = 4;
-  ContextQuery context_query = 5;
-  bool evaluation_cacheable = 6;
+  optional string id = 1;
+  optional Target target = 2;
+  optional Effect effect = 3;
+  optional string condition = 4;
+  optional ContextQuery context_query = 5;
+  optional bool evaluation_cacheable = 6;
 }
 
 message RuleList {
   repeated Rule items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -70,12 +70,10 @@ message RuleResponse {
 // The retrieved data can then be passed onto the request's context
 message ContextQuery {
   repeated io.restorecommerce.filter.FilterOp filters = 1;
-  string query = 2;
+  optional string query = 2;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "rule";
-
+service RuleService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RuleListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/search.proto

@@ -6,16 +6,14 @@ import "io/restorecommerce/auth.proto";
 import "io/restorecommerce/options.proto";
 
 // Service provides the CRUD operations
-service Service {
-  option (io.restorecommerce.options.service_name) = "search";
-
+service SearchService {
   rpc Search (SearchRequest) returns (SearchResponse);
 }
 
 message SearchRequest {
-  string collection = 1;
-  string text = 2;
-  repeated string acl = 3;
+  optional string collection = 1;
+  optional string text = 2;
+  repeated string acls = 3;
   io.restorecommerce.auth.Subject subject = 4;
 }
 

package/io/restorecommerce/status.proto

@@ -3,24 +3,29 @@ syntax = "proto3";
 package io.restorecommerce.status;
 
 message Status {
-  string id = 1;
-  uint32 code = 2;
-  string message = 3;
+  optional string id = 1;
+  optional uint32 code = 2;
+  optional string message = 3;
 }
 
 message StatusArray {
-repeated Status status = 1;
+  repeated Status status = 1;
 }
 
 message StatusObj {
-  Status status = 1;
+  optional Status status = 1;
 }
 
 message OperationStatusObj {
-  OperationStatus operation_status = 1;
+  optional OperationStatus operation_status = 1;
 }
 
 message OperationStatus {
-  uint32 code = 1;
-  string message = 2;
+  optional uint32 code = 1;
+  optional string message = 2;
+}
+
+message StatusListResponse {
+  repeated Status status = 1;
+  optional OperationStatus operation_status = 2;
 }

package/io/restorecommerce/tax.proto

@@ -15,9 +15,7 @@ import "io/restorecommerce/tax_type.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "tax";
-
+service TaxService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -33,7 +31,7 @@ message Deleted {
 
 message TaxList {
   repeated Tax items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -49,9 +47,9 @@ message TaxResponse {
 }
 
 message Tax {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string country_id = 3 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string country_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.country.Country",
       target_service: "resource",
@@ -60,9 +58,9 @@ message Tax {
       field_name: "country",
     }
   ];
-  double rate = 4;
-  string variant = 5;
-  string type_id = 6 [
+  optional double rate = 4;
+  optional string variant = 5;
+  optional string type_id = 6 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.tax_type.TaxType",
       target_service: "resource",
@@ -72,3 +70,8 @@ message Tax {
     }
   ];
 }
+
+message VAT {
+  optional string tax_id = 1;
+  optional double vat = 2;
+}