changed the naming a bit 🤷

TUM-Dev · Oct 14, 2024 · a7046b8 · a7046b8
1 parent 2bb9fba
commit a7046b8
Show file tree

Hide file tree

Showing 7 changed files with 478 additions and 289 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
@@ -132,8 +132,14 @@ service Campus {
   }
 
   // List all information necessary for the "Campus" tab
-  rpc ListStudentClub(ListCampusRequest) returns (ListCampusReply) {
+  rpc ListStudentClub(ListStudentGroupRequest) returns (ListStudentGroupReply) {
     option (google.api.http) = {get: "/student_clubs"};
+    option deprecated = true;
+  }
+
+  // List all student groups information
+  rpc ListStudentGroup(ListStudentGroupRequest) returns (ListStudentGroupReply) {
+    option (google.api.http) = {get: "/student_groups"};
   }
 }
 
@@ -532,12 +538,12 @@ enum Language {
   English = 1;
 }
 
-message ListCampusRequest {
+message ListStudentGroupRequest {
   // Language of the student clubs and categories
   // Defaults to german
   optional Language language = 1;
 }
-message ListCampusReply {
+message ListStudentGroupReply {
   repeated StudentClubCollection student_clubs = 1;
   repeated StudentCouncilCollection student_councils = 2;
 }

diff --git a/server/api/tumdev/campus_backend.swagger.json b/server/api/tumdev/campus_backend.swagger.json
@@ -667,13 +667,50 @@
     },
     "/student_clubs": {
       "get": {
-        "summary": "List all information nessesary for the \"Campus\" tab",
+        "summary": "List all information necessary for the \"Campus\" tab",
         "operationId": "Campus_ListStudentClub",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/apiListCampusReply"
+              "$ref": "#/definitions/apiListStudentGroupReply"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/rpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "language",
+            "description": "Language of the student clubs and categories\nDefaults to german",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "enum": [
+              "German",
+              "English"
+            ],
+            "default": "German"
+          }
+        ],
+        "tags": [
+          "Campus"
+        ]
+      }
+    },
+    "/student_groups": {
+      "get": {
+        "summary": "List all student groups information",
+        "operationId": "Campus_ListStudentGroup",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/apiListStudentGroupReply"
             }
           },
           "default": {
@@ -1031,25 +1068,6 @@
         }
       }
     },
-    "apiListCampusReply": {
-      "type": "object",
-      "properties": {
-        "studentClubs": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "$ref": "#/definitions/apiStudentClubCollection"
-          }
-        },
-        "studentCouncils": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "$ref": "#/definitions/apiStudentCouncilCollection"
-          }
-        }
-      }
-    },
     "apiListCanteenRatingsReply": {
       "type": "object",
       "properties": {
@@ -1192,6 +1210,25 @@
         }
       }
     },
+    "apiListStudentGroupReply": {
+      "type": "object",
+      "properties": {
+        "studentClubs": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/apiStudentClubCollection"
+          }
+        },
+        "studentCouncils": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/apiStudentCouncilCollection"
+          }
+        }
+      }
+    },
     "apiMovie": {
       "type": "object",
       "properties": {
@@ -1477,19 +1514,19 @@
       "properties": {
         "name": {
           "type": "string",
-          "title": "The name of the club"
+          "title": "The name of the council"
         },
         "description": {
           "type": "string",
-          "title": "How the club describes itsself"
+          "title": "How the council describes itsself"
         },
         "linkUrl": {
           "type": "string",
-          "title": "Where the clubs main internet presence is"
+          "title": "Where the council main internet presence is"
         },
         "coverUrl": {
           "type": "string",
-          "title": "Where to find a image for this club"
+          "title": "Where to find a image for this council"
         }
       }
     },