@restorecommerce/protos 2.0.2 → 3.0.1

package/io/restorecommerce/auth.proto

@@ -7,33 +7,33 @@ import "io/restorecommerce/attribute.proto";
  * Subject of creating User
  */
 message Subject {
-  string id = 1; // user id
-  string scope = 2; // target scope (ID of the target scoping entity)
-  bool unauthenticated = 3; // for unauthenticated context
-  string token = 4;
+  optional string id = 1; // user id
+  optional string scope = 2; // target scope (ID of the target scoping entity)
+  optional bool unauthenticated = 3; // for unauthenticated context
+  optional string token = 4;
 }
 
 message Tokens {
-  string name = 1; // token name
-  double expires_in = 2; // expiration date for token
-  string token = 3; // token
+  optional string name = 1; // token name
+  optional double expires_in = 2; // expiration date for token
+  optional string token = 3; // token
   repeated string scopes = 4; // identifier for role_association
-  string type = 5; // type of token eg: access_token, refresh_token
-  bool interactive = 6;
-  double last_login = 7;
+  optional string type = 5; // type of token eg: access_token, refresh_token
+  optional bool interactive = 6;
+  optional double last_login = 7;
 }
 
 message HierarchicalScope {
-  string id = 1; // root node
+  optional string id = 1; // root node
   repeated HierarchicalScope children = 2; // children nodes
-  string role = 3; // role identifier associated with root node scope
+  optional string role = 3; // role identifier associated with root node scope
 }
 
 message RoleAssociation {
-  string role = 1;  // role ID
+  optional string role = 1;  // role ID
   repeated io.restorecommerce.attribute.Attribute attributes = 2;  // useful attributes for RBAC/ABAC like organizational scope
-  string id = 3; // identifier for role_association
-  double created = 4; // timestamp when the role was created
+  optional string id = 3; // identifier for role_association
+  optional double created = 4; // timestamp when the role was created
 }
 
 message HierarchicalScopesRequest {

package/io/restorecommerce/authentication_log.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "authentication_log";
-
+service AuthenticationLogService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (AuthenticationLogListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -25,7 +23,7 @@ service Service {
 
 message AuthenticationLogList {
   repeated AuthenticationLog items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -44,16 +42,16 @@ message AuthenticationLogResponse {
  * Authentication Log
  */
 message AuthenticationLog {
-  string id = 1; // log id
-  string ipv4_address = 2;
-  string ipv6_address = 3;
-  string operating_system = 4;
-  string user_agent = 5;
-  double date = 6; // time stamp of login, logout or token update
-  string activity = 7; // login, logout
-  io.restorecommerce.meta.Meta meta = 8; // meta info
-  string subject_id = 9; // subject id
-  string token_name = 10; // token name associated with io.restorecommerce.auth.Token.token_name
+  optional string id = 1; // log id
+  optional string ipv4_address = 2;
+  optional string ipv6_address = 3;
+  optional string operating_system = 4;
+  optional string user_agent = 5;
+  optional double date = 6; // time stamp of login, logout or token update
+  optional string activity = 7; // login, logout
+  optional io.restorecommerce.meta.Meta meta = 8; // meta info
+  optional string subject_id = 9; // subject id
+  optional string token_name = 10; // token name associated with io.restorecommerce.auth.Token.token_name
 }
 
 message Deleted {

package/io/restorecommerce/command.proto

@@ -10,11 +10,11 @@ import "io/restorecommerce/options.proto";
 
 // command resource
 message Command {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;  // command name
+  optional  string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;  // command name
   repeated CommandParameter parameters = 4; // all possible parameters
-  string description = 5; // command description
+  optional string description = 5; // command description
 }
 
 message CommandParameter {
@@ -26,15 +26,15 @@ message CommandParameter {
     string_value = 4;
   }
 
-  string field = 1; //  field name
-  string description = 2; // field description
-  ParameterType type = 3; // field's type
-  string properties = 4; // dump properties in case of `object_value``
+  optional string field = 1; //  field name
+  optional string description = 2; // field description
+  optional ParameterType type = 3; // field's type
+  optional string properties = 4; // dump properties in case of `object_value``
 }
 
 message CommandList {
   repeated Command items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -49,9 +49,7 @@ message CommandResponse {
   io.restorecommerce.status.Status status = 2;
 }
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "command";
-
+service CommandService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CommandListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };

package/io/restorecommerce/commandinterface.proto

@@ -9,8 +9,8 @@ import "io/restorecommerce/options.proto";
 // used to send requests through Kafka or gRPC
 message CommandRequest {
   //  command identifier (used to demultiplex operation in the command implementation)
-  string name = 1;
-  google.protobuf.Any payload = 2;  // variable payload
+  optional string name = 1;
+  optional google.protobuf.Any payload = 2;  // variable payload
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -26,7 +26,6 @@ message CommandResponse {
 /**
 * RPC service for executing commands
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "commandinterface";
+service CommandInterfaceService {
   rpc Command(CommandRequest) returns (google.protobuf.Any);
 }

package/io/restorecommerce/contact_point.proto

@@ -14,9 +14,7 @@ import "io/restorecommerce/contact_point_type.proto";
 import "io/restorecommerce/timezone.proto";
 import "io/restorecommerce/locale.proto";
 
-service Service {
-  option (io.restorecommerce.options.service_name) = "contact_point";
-
+service ContactPointService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ContactPointListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -32,7 +30,7 @@ message Deleted {
 
 message ContactPointList {
   repeated ContactPoint items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -48,9 +46,9 @@ message ContactPointResponse {
 }
 
 message ContactPoint {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string physical_address_id = 3 [
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string physical_address_id = 3 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -59,9 +57,9 @@ message ContactPoint {
       field_name: "physicalAddress",
     }
   ];
-  string website = 5;
-  string email = 6;
-  string contact_point_type_id = 7 [
+  optional string website = 5;
+  optional string email = 6;
+  optional string contact_point_type_id = 7 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.contact_point_type.ContactPointType",
       target_service: "resource",
@@ -70,8 +68,8 @@ message ContactPoint {
       field_name: "contactPointType",
     }
   ];
-  string telephone = 8;
-  string timezone_id = 9 [
+  optional string telephone = 8;
+  optional string timezone_id = 9 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.timezone.Timezone",
       target_service: "resource",
@@ -80,7 +78,7 @@ message ContactPoint {
       field_name: "timezone",
     }
   ];
-  string locale_id = 10 [
+  optional string locale_id = 10 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.locale.Locale",
       target_service: "resource",

package/io/restorecommerce/contact_point_type.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "contact_point_type";
-
+service ContactPointTypeService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ContactPointTypeListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,14 +27,14 @@ message Deleted {
 
 message ContactPointTypeList {
   repeated ContactPointType items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
 message ContactPointType {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string type = 3;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string type = 3;
 }
 
 message ContactPointTypeListResponse {

package/io/restorecommerce/country.proto

@@ -11,9 +11,7 @@ import "io/restorecommerce/options.proto";
 /*
 * Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "country";
-
+service CountryService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CountryListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -29,7 +27,7 @@ message Deleted {
 
 message CountryList {
   repeated Country items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -45,10 +43,10 @@ message CountryResponse {
 }
 
 message Country {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string country_code = 4;
-  string geographical_name = 5;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string country_code = 4;
+  optional string geographical_name = 5;
   repeated string economic_areas = 6;
 }

package/io/restorecommerce/credential.proto

@@ -11,7 +11,7 @@ import "io/restorecommerce/status.proto";
 /*
 * Microservice definition.
 */
-service Service {
+service CredentialService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CredentialListResponse);
   rpc Create (CredentialList) returns (CredentialListResponse);
   rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
@@ -25,7 +25,7 @@ message Deleted {
 
 message CredentialList {
   repeated Credential items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -41,11 +41,11 @@ message CredentialResponse {
 }
 
 message Credential {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
-  string name = 3;
-  string description = 4;
-  string user = 5;
-  string pass = 6;
-  google.protobuf.Any credentials = 7; /// additional credentials as auth key or certificates etc
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
+  optional string name = 3;
+  optional string description = 4;
+  optional string user = 5;
+  optional string pass = 6;
+  optional google.protobuf.Any credentials = 7; /// additional credentials as auth key or certificates etc
 }

package/io/restorecommerce/customer.proto

@@ -17,9 +17,7 @@ import "io/restorecommerce/organization.proto";
 /*
 Microservice definition.
 */
-service Service {
-  option (io.restorecommerce.options.service_name) = "customer";
-
+service CustomerService {
   rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (CustomerListResponse) {
     option (io.restorecommerce.options.is_query) = true;
   };
@@ -31,7 +29,7 @@ service Service {
 
 message CustomerList {
   repeated Customer items = 1;
-  uint32 total_count = 2;
+  optional uint32 total_count = 2;
   io.restorecommerce.auth.Subject subject = 3;
 }
 
@@ -47,8 +45,8 @@ message CustomerResponse {
 }
 
 message Customer {
-  string id = 1;
-  io.restorecommerce.meta.Meta meta = 2;
+  optional string id = 1;
+  optional io.restorecommerce.meta.Meta meta = 2;
   oneof customer {
     IndividualUser individual_user = 3;
     OrgUser org_user = 4;
@@ -57,7 +55,7 @@ message Customer {
 }
 
 message IndividualUser {
-  string user_id = 1 [
+  optional string user_id = 1 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.user.User",
       target_service: "identity",
@@ -66,7 +64,7 @@ message IndividualUser {
       field_name: "user",
     }
   ];
-  string address_id = 2 [
+  optional string address_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",
@@ -87,7 +85,7 @@ message IndividualUser {
 }
 
 message OrgUser {
-  string user_id = 1 [
+  optional string user_id = 1 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.user.User",
       target_service: "identity",
@@ -96,7 +94,7 @@ message OrgUser {
       field_name: "user",
     }
   ];
-  string organization_id = 2 [
+  optional string organization_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.organization.Organization",
       target_service: "resource",
@@ -109,7 +107,7 @@ message OrgUser {
 
 message Guest {
   bool guest = 1;
-  string address_id = 2 [
+  optional string address_id = 2 [
     (io.restorecommerce.options.resolver) = {
       target_type: ".io.restorecommerce.address.Address",
       target_service: "resource",

package/io/restorecommerce/file.proto

@@ -0,0 +1,23 @@
+syntax = "proto3";
+
+package io.restorecommerce.file;
+
+message File {
+  optional string id = 1;
+  optional int64 index = 2;
+  optional string caption = 3;
+  optional string filename = 4;
+  optional string content_type = 5;
+  optional string url = 6;
+  optional int64 bytes = 7;
+  repeated string tags = 8;
+}
+
+message FileList {
+  repeated File items = 1;
+  optional uint32 total_count = 2;
+}
+
+message Deleted {
+  string id = 1;
+}

package/io/restorecommerce/filter.proto

@@ -29,7 +29,7 @@ message Filter {
 }
 
 message FilterOp {
-  repeated Filter filter = 1;
+  repeated Filter filters = 1;
   enum Operator {
     and = 0;
     or = 1;