mirrored the comments from the RPC to the protofile

This way, we make sure that they are actually displayed to the users
TUM-Dev · Mar 11, 2024 · bcb5b4c · bcb5b4c
1 parent 2b3a542
commit bcb5b4c
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 8 deletions.
diff --git a/server/api/tumdev/campus_backend.pb.go b/server/api/tumdev/campus_backend.pb.go
diff --git a/server/api/tumdev/campus_backend.proto b/server/api/tumdev/campus_backend.proto
@@ -91,6 +91,7 @@ service Campus {
     };
   }
 
+  // Returns all dishes for a specific cafeteria, year, week and day
   rpc ListDishes(ListDishesRequest) returns (ListDishesReply) {
     option (google.api.http) = {
       get: "/dishes",
@@ -389,9 +390,11 @@ message ListDishesRequest {
   string canteen_id = 1;
   // >=2022 until the current year
   int32 year = 2;
-  // range 1 - 53
+  // Week of the dish.
+  // Must be in the range 1 - 52
   int32 week = 3;
-  // range 0 (Monday) - 4 (Friday)
+  // Day of the week
+  // Days must be in the range 0 (Monday) - 4 (Friday)
   int32 day = 4;
 }
 

diff --git a/server/api/tumdev/campus_backend.swagger.json b/server/api/tumdev/campus_backend.swagger.json
@@ -434,6 +434,7 @@
     },
     "/dishes": {
       "get": {
+        "summary": "Returns all dishes for a specific cafeteria, year, week and day",
         "operationId": "Campus_ListDishes",
         "responses": {
           "200": {
@@ -469,15 +470,15 @@
           },
           {
             "name": "week",
-            "description": "range 1 - 53",
+            "description": "Week of the dish.\nMust be in the range 1 - 52",
             "in": "query",
             "required": false,
             "type": "integer",
             "format": "int32"
           },
           {
             "name": "day",
-            "description": "range 0 (Monday) - 4 (Friday)",
+            "description": "Day of the week\nDays must be in the range 0 (Monday) - 4 (Friday)",
             "in": "query",
             "required": false,
             "type": "integer",

diff --git a/server/api/tumdev/campus_backend_grpc.pb.go b/server/api/tumdev/campus_backend_grpc.pb.go
diff --git a/server/backend/cafeteria.go b/server/backend/cafeteria.go
@@ -638,8 +638,6 @@ func (s *CampusServer) GetCafeterias(ctx context.Context, _ *pb.ListCanteensRequ
 	}, requestStatus
 }
 
-// ListDishes gRPC Endpoint
-// Returns all dishes for a specific cafeteria, year, week and day
 func (s *CampusServer) ListDishes(ctx context.Context, req *pb.ListDishesRequest) (*pb.ListDishesReply, error) {
 	if req.Year < 2022 {
 		return &pb.ListDishesReply{}, status.Error(codes.Internal, "Years must be larger or equal to 2022 ") // currently, no previous values have been added