modified the ListNews REST API to not swallow other APIs

Resolves #264
TUM-Dev · Oct 16, 2023 · 50e9844 · 50e9844
1 parent 371ed3f
commit 50e9844
Show file tree

Hide file tree

Showing 6 changed files with 226 additions and 259 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
@@ -28,7 +28,7 @@ service Campus {
 
   rpc ListNews(ListNewsRequest) returns (ListNewsReply) {
     option (google.api.http) = {
-      get: "/news/{last_news_id}",
+      get: "/news",
       response_body: "news"
     };
   }

diff --git a/server/api/tumdev/campus_backend.swagger.json b/server/api/tumdev/campus_backend.swagger.json
@@ -680,17 +680,17 @@
         ]
       }
     },
-    "/news/alerts": {
+    "/news": {
       "get": {
-        "operationId": "Campus_ListNewsAlerts",
+        "operationId": "Campus_ListNews",
         "responses": {
           "200": {
             "description": "",
             "schema": {
               "type": "array",
               "items": {
                 "type": "object",
-                "$ref": "#/definitions/apiNewsAlert"
+                "$ref": "#/definitions/apiNews"
               }
             }
           },
@@ -703,30 +703,46 @@
         },
         "parameters": [
           {
-            "name": "lastNewsAlertId",
+            "name": "lastNewsId",
             "description": "the last id of the news item received. 0 to get all news items",
             "in": "query",
             "required": false,
             "type": "integer",
             "format": "int32"
+          },
+          {
+            "name": "newsSource",
+            "description": "filter by news source id. 0 to get all news items",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "format": "int32"
+          },
+          {
+            "name": "oldestDateAt",
+            "description": "the oldest time you want to be included in the response",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "format": "date-time"
           }
         ],
         "tags": [
           "Campus"
         ]
       }
     },
-    "/news/sources": {
+    "/news/alerts": {
       "get": {
-        "operationId": "Campus_ListNewsSources",
+        "operationId": "Campus_ListNewsAlerts",
         "responses": {
           "200": {
             "description": "",
             "schema": {
               "type": "array",
               "items": {
                 "type": "object",
-                "$ref": "#/definitions/apiNewsSource"
+                "$ref": "#/definitions/apiNewsAlert"
               }
             }
           },
@@ -737,22 +753,32 @@
             }
           }
         },
+        "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/{lastNewsId}": {
+    "/news/sources": {
       "get": {
-        "operationId": "Campus_ListNews",
+        "operationId": "Campus_ListNewsSources",
         "responses": {
           "200": {
             "description": "",
             "schema": {
               "type": "array",
               "items": {
                 "type": "object",
-                "$ref": "#/definitions/apiNews"
+                "$ref": "#/definitions/apiNewsSource"
               }
             }
           },
@@ -763,32 +789,6 @@
             }
           }
         },
-        "parameters": [
-          {
-            "name": "lastNewsId",
-            "description": "the last id of the news item received. 0 to get all news items",
-            "in": "path",
-            "required": true,
-            "type": "integer",
-            "format": "int32"
-          },
-          {
-            "name": "newsSource",
-            "description": "filter by news source id. 0 to get all news items",
-            "in": "query",
-            "required": false,
-            "type": "integer",
-            "format": "int32"
-          },
-          {
-            "name": "oldestDateAt",
-            "description": "the oldest time you want to be included in the response",
-            "in": "query",
-            "required": false,
-            "type": "string",
-            "format": "date-time"
-          }
-        ],
         "tags": [
           "Campus"
         ]

diff --git a/server/backend/movie.go b/server/backend/movie.go
@@ -2,6 +2,7 @@ package backend
 
 import (
 	"context"
+
 	pb "github.com/TUM-Dev/Campus-Backend/server/api/tumdev"
 	"github.com/TUM-Dev/Campus-Backend/server/model"
 	log "github.com/sirupsen/logrus"

diff --git a/server/backend/rpcserver.go b/server/backend/rpcserver.go
@@ -3,6 +3,7 @@ package backend
 import (
 	"context"
 	"errors"
+
 	pb "github.com/TUM-Dev/Campus-Backend/server/api/tumdev"
 	"github.com/TUM-Dev/Campus-Backend/server/backend/ios_notifications/apns"
 	"github.com/TUM-Dev/Campus-Backend/server/model"