[ADD] FiveM's schema for request information on server (in progress)

Author: BliTz037

src/fivem/fivem.controller.ts

@@ -5,7 +5,7 @@ import { ApiOkResponse, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagg
 import { Cache } from 'cache-manager';
 import ServerTrackedDto from 'src/dto/serverTrackedDto';
 import ServerCfxDto from 'src/dto/serverCfxDto';
-import { fivemPlayersResponse, fivemResponse } from './fivem.schema';
+import { fivemCfxResponse, fivemPlayersResponse, fivemResponse } from './fivem.schema';
 
 /*
 CODE CacheKey
@@ -47,15 +47,11 @@ export class FivemController {
     @Get('/cfx/:code')
     @ApiOperation({
         summary: "Track a FiveM Server by his cfx code",
-        description: "Return a JSON response",
+        description: "Return a JSON response with information about the server from FiveM's API",
     })
-    @ApiResponse({
-        status: 200,
-        schema: {
-            example: {
-                message: "Todo"
-            }
-        }
+    @ApiOkResponse({
+        description: 'Server information',
+        schema: fivemCfxResponse
     })
     async trackServerByCfx(@Param() code: ServerCfxDto): Promise<any> {
         const cache: any = await this.cacheManager.get(`FMCFX:${code.code}`);

src/fivem/fivem.schema.ts

@@ -108,7 +108,100 @@ const fivemPlayersResponse: SchemaObject & Partial<ReferenceObject> = {
     }
 };
 
+const fivemCfxResponse: SchemaObject & Partial<ReferenceObject> = {
+    type: 'object',
+    properties: {
+        cfx: { type: 'string', description: "Server's CFX code" },
+        online: { type: 'boolean', description: "Server's status. If the bool is true, the server is online" },
+        EndPoint: { type: 'string', description: "Server's CFX code used as an Endpoint" },
+        Data: { type: 'object', description: "Server's Data" },
+        cacheTime: { type: 'number', description: "UNIX timestamp when the response was cached" },
+        cacheExpire: { type: 'number', description: "UNIX timestamp when the response will be remove from cache. Around 5 minutes." }
+    },
+    required: [
+        "cfx",
+        "online",
+        "EndPoint",
+        "Data",
+        "cacheTime",
+        "cacheExpire"
+    ],
+    example: {
+        "cfx": "45yo89",
+        "online": true,
+        "EndPoint": "45yo89",
+        "Data": {
+          "clients": 51,
+          "gametype": "Minigames, Races, and Free Mode",
+          "hostname": "^5Mega's Games (US): ^5Minigames ^9|^4 Sumo ^9|^1 Races ^9|^3 Freeroam",
+          "mapname": "Various",
+          "sv_maxclients": 2048,
+          "enhancedHostSupport": true,
+          "requestSteamTicket": "off",
+          "resources": [
+            "hardcap",
+            "_cfx_internal",
+            "ivpack"
+          ],
+          "server": "FXServer-master SERVER v1.0.0.6228 win32",
+          "vars": {
+            "gamename": "gta5",
+            "locale": "en-US",
+            "onesync_enabled": "true",
+            "sv_enforceGameBuild": "2802",
+          },
+          "selfReportedClients": 51,
+          "players": [
+            {
+              "endpoint": "127.0.0.1:1234",
+              "id": 82,
+              "identifiers": [
+                "license:9b510e4fd9ea81065ff5ff95dbec0f5cbbf9a70a",
+                "discord:855375608708464651",
+                "fivem:3966756",
+                "license2:9b510e4fd9ea81065ff5ff95dbec0f5cbbf9a70a"
+              ],
+              "name": "qwetti",
+              "ping": 246
+            },
+            {
+              "endpoint": "127.0.0.1:1234",
+              "id": 106,
+              "identifiers": [
+                "license:b0b4d13aadbb79f8f4ab557aea934a9cd14c89ec",
+                "xbl:2535435310984194",
+                "live:1055518852711614",
+                "discord:412397129638739978",
+                "fivem:5839602",
+                "license2:88ff199d67171af80acb08c04ce12115b8a45763"
+              ],
+              "name": "ur cooked",
+              "ping": 87
+            }
+          ],
+          "ownerID": 46512,
+          "private": false,
+          "fallback": false,
+          "connectEndPoints": [
+            "192.223.26.51:15000"
+          ],
+          "upvotePower": 168,
+          "burstPower": 0,
+          "support_status": "supported",
+          "svMaxclients": 2048,
+          "ownerName": "MegaGTAVMaster",
+          "ownerProfile": "https://forum.cfx.re/u/MegaGTAVMaster",
+          "ownerAvatar": "https://forum.cfx.re/user_avatar/forum.cfx.re/megagtavmaster/128/2049360_2.png",
+          "lastSeen": "2023-03-01T07:49:41.9488692Z",
+          "iconVersion": -1146343723
+        },
+        "cacheTime": 1677657024,
+        "cacheExpire": 1677657324
+      }
+}
+
 export {
     fivemResponse,
-    fivemPlayersResponse
+    fivemPlayersResponse,
+    fivemCfxResponse
 };