Dev

README.md

@@ -2,17 +2,17 @@
 
 ## Usage
 
-### Generate clients with [buf](https://buf.build/):
+### Generate clients with [buf](https://buf.build/)
 
 Ensure [buf](https://buf.build/docs/installation) and [protoc](https://grpc.io/docs/protoc-installation/) are installed on your system.
 
 ```sh
 buf dep update ./proto
 ```
 
-#### Rust (tonic):
+#### Rust (tonic)
 
-##### Dependencies:
+##### Dependencies
 
 Install "protoc-gen-\*" with cargo.
 
@@ -22,7 +22,7 @@ cargo install protoc-gen-prost-crate
 cargo install protoc-gen-tonic
 ```
 
-##### Generate:
+##### Generate
 
 ```sh
 buf generate proto --template proto/buf.gen.rust.yaml
@@ -32,17 +32,17 @@ buf generate proto --template proto/buf.gen.rust.yaml
 
 Outputs will be in out/ directory.
 
-#### Typescript in Browser:
+#### Typescript in Browser
 
-##### Dependencies:
+##### Dependencies
 
 Install "protoc-gen-\*" with npm.
 
 ```sh
 npm install -g ts-proto
 ```
 
-##### Generate:
+##### Generate
 
 ```sh
 buf generate proto --template proto/buf.gen.ts.yaml
@@ -54,15 +54,15 @@ Outputs will be in services/ directory.
 
 ### Proto linter
 
-#### Dependencies:
+#### Dependencies
 
 Install protolint with npx.
 
  ```sh
  npx protolint
 ```
 
-#### Lint:
+#### Lint
 
  ```sh
 protolint lint proto
@@ -79,8 +79,11 @@ When using "vscode-proto3" extention in VS Code, add the following to the '.vsco
   }
 }
 ```
+
 ## Optionals
+
 how to select only specific proto, use `--path` args
+
 ```sh
  buf generate proto --template service-apis/proto/buf.gen.py.yaml -o gen --path service-apis/proto/digitalkin/kin --path service-apis/proto/google
-```
+```

proto/digitalkin/cost/v1/cost.proto

@@ -40,12 +40,18 @@ message Cost {
     double cost = 1 [(buf.validate.field).required = true];
     // mission_id: Mission ID linked to the cost
     string mission_id = 2 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "missions:"];
-    // name: Name of the cost (unique by mission_id)
+    // name: Name of the cost
     string name = 3 [(buf.validate.field).required = true];
-    // type: Type of the cost
-    CostType type = 4 [(buf.validate.field).required = true];
+    // cost_type: Type of the cost
+    CostType cost_type = 4 [(buf.validate.field).required = true];
     // unit: Unit of the cost
     string unit = 5 [(buf.validate.field).required = true];
+    // rate: Rate of the cost
+    double rate = 6 [(buf.validate.field).required = true];
+    // setup_version_id: Setup version ID linked to the cost
+    string setup_version_id = 7 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "setup_versions:"];
+    // quantity: Quantity of the cost
+    double quantity = 8 [(buf.validate.field).required = true];
 }
 
 // AddCostRequest: Request to add a cost
@@ -54,56 +60,58 @@ message AddCostRequest {
     double cost = 1 [(buf.validate.field).required = true];
     // mission_id: Mission ID linked to the cost
     string mission_id = 2 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "missions:"];
-    // name: Name of the cost (unique by mission_id)
+    // name: Name of the cost
     string name = 3 [(buf.validate.field).required = true];
-    // type: Type of the cost
-    CostType type = 4 [(buf.validate.field).required = true];
+    // cost_type: Type of the cost
+    CostType cost_type = 4 [(buf.validate.field).required = true];
     // unit: Unit of the cost
     string unit = 5 [(buf.validate.field).required = true];
+    // rate: Rate of the cost
+    double rate = 6 [(buf.validate.field).required = true];
+    // setup_version_id: Setup version ID linked to the cost
+    string setup_version_id = 7 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "setup_versions:"];
+    // quantity: Quantity of the cost
+    double quantity = 8 [(buf.validate.field).required = true];
 }
 
 // AddCostResponse: Response to added cost
 message AddCostResponse {
-    // success: Success of the operation
-    bool success = 1 [(buf.validate.field).required = true];
 }
 
-// GetCostsByMissionRequest: Request to get costs by mission
-message GetCostsByMissionRequest {
-    // mission_id: Mission ID linked to the cost
-    string mission_id = 1 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "missions:"];
-}
 
-// GetCostsByMissionResponse: Response to get costs by mission
-message GetCostsByMissionResponse {
-    // costs: Costs
-    repeated Cost costs = 1 [(buf.validate.field).required = true];
+// CostFilter: Filter criteria for costs
+message CostFilter {
+    // names: Filter costs by one or more names
+    repeated string names = 1;
+
+    // cost_types: Filter costs by cost types
+    repeated CostType cost_types = 2;
 }
 
-// GetCostsByNameRequest: Request to get costs by name
-message GetCostsByNameRequest {
+// GetCostsRequest: Request to get multiple costs
+message GetCostsRequest {
     // mission_id: Mission ID linked to the cost
     string mission_id = 1 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "missions:"];
-    // name: Name of the cost (unique by mission_id)
-    string name = 2 [(buf.validate.field).required = true];
+    // filter: Filter criteria for costs
+    CostFilter filter = 2;
 }
 
-// GetCostsByNameResponse: Response to get costs by name
-message GetCostsByNameResponse {
-    // costs: Costs
-    repeated Cost costs = 1 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "missions:"];
+// GetCostsResponse: Response to get multiple costs
+message GetCostsResponse {
+    // costs: List of cost
+    repeated Cost costs = 1 [(buf.validate.field).required = true];
 }
 
-// GetCostsByTypeRequest: Request to get costs by type
-message GetCostsByTypeRequest {
+// GetCostRequest: Request to get cost by name
+message GetCostRequest {
     // mission_id: Mission ID linked to the cost
     string mission_id = 1 [(buf.validate.field).required = true, (buf.validate.field).string.prefix = "missions:"];
-    // type: Type of the cost
-    CostType type = 2 [(buf.validate.field).required = true];
+    // name: Name of the cost
+    string name = 2 [(buf.validate.field).required = true];
 }
 
-// GetCostsByTypeResponse: Response to get costs by type
-message GetCostsByTypeResponse {
-    // costs: Costs
+// GetCostResponse: Response to get cost by name
+message GetCostResponse {
+    // costs: List of cost
     repeated Cost costs = 1 [(buf.validate.field).required = true];
-}
+}

proto/digitalkin/cost/v1/cost_service.proto

@@ -23,12 +23,9 @@ service CostService {
     // AddCost: Add a cost
     rpc AddCost (AddCostRequest) returns (AddCostResponse);
 
-    // GetCostsByMission: Get a cost by Mission ID
-    rpc GetCostsByMission (GetCostsByMissionRequest) returns (GetCostsByMissionResponse);
+    // GetCost: Get a cost
+    rpc GetCost (GetCostRequest) returns (GetCostResponse);
 
-    // GetCostsByName: Get costs by name
-    rpc GetCostsByName (GetCostsByNameRequest) returns (GetCostsByNameResponse);
-
-    // GetCostsByType: Get costs by type
-    rpc GetCostsByType (GetCostsByTypeRequest) returns (GetCostsByTypeResponse);
+    // GetCosts: Get all costs with filters
+    rpc GetCosts (GetCostsRequest) returns (GetCostsResponse);
 }