feat:News alerts (#219)

* implemented all news alert apis * fixed duplicate file * regen * fixed a typo * removed the now obsolete newsAlerts apis * added context * fixed a mistake during rebasing
TUM-Dev · Oct 1, 2023 · 6bdc697 · 6bdc697
1 parent d10d13a
commit 6bdc697
Show file tree

Hide file tree

Showing 9 changed files with 1,338 additions and 1,228 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.pb.gw.go b/server/api/tumdev/campus_backend.pb.gw.go
diff --git a/server/api/tumdev/campus_backend.proto b/server/api/tumdev/campus_backend.proto
@@ -12,8 +12,11 @@ option java_outer_classname = "CampusApiProto";
 option java_package = "app.tum.campus.api";
 
 service Campus {
-  rpc GetTopNews(GetTopNewsRequest) returns (GetTopNewsReply) {
-    option (google.api.http) = {get: "/news/top"};
+  rpc GetNewsAlerts(GetNewsAlertsRequest) returns (GetNewsAlertsReply) {
+    option (google.api.http) = {
+      get: "/news/alerts"
+      response_body: "alerts"
+    };
   }
 
   rpc GetNewsSources(GetNewsSourcesRequest) returns (GetNewsSourcesReply) {
@@ -264,8 +267,16 @@ message NewsSource {
   string icon = 3;
 }
 
-message GetTopNewsRequest {}
-message GetTopNewsReply {
+message GetNewsAlertsRequest {
+  // the last id of the news item received. 0 to get all news items
+  int32 last_news_alert_id = 1;
+}
+
+message GetNewsAlertsReply {
+  repeated NewsAlert alerts = 1;
+}
+
+message NewsAlert {
   string image_url = 1;
   string link = 2;
   google.protobuf.Timestamp created = 3;

diff --git a/server/api/tumdev/campus_backend.swagger.json b/server/api/tumdev/campus_backend.swagger.json
@@ -703,17 +703,17 @@
         ]
       }
     },
-    "/news/sources": {
+    "/news/alerts": {
       "get": {
-        "operationId": "Campus_GetNewsSources",
+        "operationId": "Campus_GetNewsAlerts",
         "responses": {
           "200": {
             "description": "",
             "schema": {
               "type": "array",
               "items": {
                 "type": "object",
-                "$ref": "#/definitions/apiNewsSource"
+                "$ref": "#/definitions/apiNewsAlert"
               }
             }
           },
@@ -724,19 +724,33 @@
             }
           }
         },
+        "parameters": [
+          {
+            "name": "lastNewsAlertId",
+            "description": "the last id of the news item received. 0 to get all news items",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "format": "int32"
+          }
+        ],
         "tags": [
           "Campus"
         ]
       }
     },
-    "/news/top": {
+    "/news/sources": {
       "get": {
-        "operationId": "Campus_GetTopNews",
+        "operationId": "Campus_GetNewsSources",
         "responses": {
           "200": {
-            "description": "A successful response.",
+            "description": "",
             "schema": {
-              "$ref": "#/definitions/apiGetTopNewsReply"
+              "type": "array",
+              "items": {
+                "type": "object",
+                "$ref": "#/definitions/apiNewsSource"
+              }
             }
           },
           "default": {
@@ -1272,6 +1286,18 @@
         }
       }
     },
+    "apiGetNewsAlertsReply": {
+      "type": "object",
+      "properties": {
+        "alerts": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/apiNewsAlert"
+          }
+        }
+      }
+    },
     "apiGetNewsReply": {
       "type": "object",
       "properties": {
@@ -1362,29 +1388,6 @@
         }
       }
     },
-    "apiGetTopNewsReply": {
-      "type": "object",
-      "properties": {
-        "imageUrl": {
-          "type": "string"
-        },
-        "link": {
-          "type": "string"
-        },
-        "created": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "from": {
-          "type": "string",
-          "format": "date-time"
-        },
-        "to": {
-          "type": "string",
-          "format": "date-time"
-        }
-      }
-    },
     "apiGetUpdateNoteReply": {
       "type": "object",
       "properties": {
@@ -1594,6 +1597,29 @@
         }
       }
     },
+    "apiNewsAlert": {
+      "type": "object",
+      "properties": {
+        "imageUrl": {
+          "type": "string"
+        },
+        "link": {
+          "type": "string"
+        },
+        "created": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "from": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "to": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "apiNewsSource": {
       "type": "object",
       "properties": {