Merge pull request #27 from AlphaKeks/master

Add descriptions to maps, courses, and filters
KZGlobalTeam · Jan 17, 2024 · c4687a2 · c4687a2
2 parents f27b931 + 1e86cd8
commit c4687a2
Show file tree

Hide file tree

Showing 11 changed files with 471 additions and 300 deletions.
diff --git a/.sqlx/query-0469229b1c8e4898800bacbc2c162fd11934393f2d7c04df0b5e964d285719a3.json b/.sqlx/query-0469229b1c8e4898800bacbc2c162fd11934393f2d7c04df0b5e964d285719a3.json
diff --git a/.sqlx/query-871a928bf174b2baa6142bad0a60bd767b813d6992b3f6dc68fece1aae512d68.json b/.sqlx/query-871a928bf174b2baa6142bad0a60bd767b813d6992b3f6dc68fece1aae512d68.json
diff --git a/.sqlx/query-cb2849edb6c2e89a50acb92b50f8f62f6f3986d7ae256d7275c5bc054561a881.json b/.sqlx/query-cb2849edb6c2e89a50acb92b50f8f62f6f3986d7ae256d7275c5bc054561a881.json
diff --git a/.sqlx/query-f2bb175d06be96538989c5550ef274a4419efa56a68b362c2a6a9a2cc6e874c7.json b/.sqlx/query-f2bb175d06be96538989c5550ef274a4419efa56a68b362c2a6a9a2cc6e874c7.json
diff --git a/api-spec.json b/api-spec.json
@@ -308,6 +308,11 @@
                     "global_status": {
                       "$ref": "#/components/schemas/GlobalStatus"
                     },
+                    "description": {
+                      "type": "string",
+                      "description": "The map's description.",
+                      "nullable": true
+                    },
                     "checksum": {
                       "type": "integer",
                       "format": "uint32",
@@ -477,6 +482,11 @@
                     "global_status": {
                       "$ref": "#/components/schemas/GlobalStatus"
                     },
+                    "description": {
+                      "type": "string",
+                      "description": "The map's description.",
+                      "nullable": true
+                    },
                     "checksum": {
                       "type": "integer",
                       "format": "uint32",
@@ -2065,6 +2075,16 @@
             "description": "The course's ID.",
             "minimum": 0
           },
+          "name": {
+            "type": "string",
+            "description": "The course's name.",
+            "nullable": true
+          },
+          "description": {
+            "type": "string",
+            "description": "The course's description.",
+            "nullable": true
+          },
           "stage": {
             "type": "integer",
             "format": "uint8",
@@ -2100,6 +2120,16 @@
             "description": "The course's [`id`].\n\n[`id`]: Course::id",
             "minimum": 0
           },
+          "name": {
+            "type": "string",
+            "description": "New [name] for the course.\n\n[name]: Course::name",
+            "nullable": true
+          },
+          "description": {
+            "type": "string",
+            "description": "New [description] for the course.\n\n[description]: Course::description",
+            "nullable": true
+          },
           "added_mappers": {
             "type": "array",
             "items": {
@@ -2207,6 +2237,11 @@
           },
           "ranked_status": {
             "$ref": "#/components/schemas/RankedStatus"
+          },
+          "notes": {
+            "type": "string",
+            "description": "Notes about this filter.",
+            "nullable": true
           }
         }
       },
@@ -2238,6 +2273,11 @@
               }
             ],
             "nullable": true
+          },
+          "notes": {
+            "type": "string",
+            "description": "New [notes] for the course.\n\n[notes]: Filter::notes",
+            "nullable": true
           }
         }
       },
@@ -2308,6 +2348,11 @@
           "global_status": {
             "$ref": "#/components/schemas/GlobalStatus"
           },
+          "description": {
+            "type": "string",
+            "description": "The map's description.",
+            "nullable": true
+          },
           "checksum": {
             "type": "integer",
             "format": "uint32",
@@ -2351,6 +2396,11 @@
             ],
             "nullable": true
           },
+          "description": {
+            "type": "string",
+            "description": "New description for the map.",
+            "nullable": true
+          },
           "workshop_id": {
             "type": "integer",
             "format": "uint32",
@@ -2453,6 +2503,11 @@
             "description": "The course's name.",
             "nullable": true
           },
+          "description": {
+            "type": "string",
+            "description": "Description of the course.",
+            "nullable": true
+          },
           "mappers": {
             "type": "array",
             "items": {
@@ -2490,6 +2545,11 @@
           },
           "ranked_status": {
             "$ref": "#/components/schemas/RankedStatus"
+          },
+          "notes": {
+            "type": "string",
+            "description": "Notes about the filter.",
+            "nullable": true
           }
         }
       },
@@ -2511,6 +2571,11 @@
           "global_status": {
             "$ref": "#/components/schemas/GlobalStatus"
           },
+          "description": {
+            "type": "string",
+            "description": "Description of the map.",
+            "nullable": true
+          },
           "mappers": {
             "type": "array",
             "items": {

diff --git a/database/migrations/20231110155336_maps.up.sql b/database/migrations/20231110155336_maps.up.sql
@@ -11,7 +11,8 @@ CREATE TABLE IF NOT EXISTS Maps (
   `name` VARCHAR(32) NOT NULL,
   `workshop_id` INT4 UNSIGNED NOT NULL,
   `checksum` INT4 UNSIGNED NOT NULL,
-  `global_status` INT1 NOT NULL,
+  `global_status` INT1 NOT NULL DEFAULT -1,
+  `description` TEXT,
   `created_on` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
   PRIMARY KEY (`id`)
 );

diff --git a/database/migrations/20231110155337_courses.up.sql b/database/migrations/20231110155337_courses.up.sql
@@ -6,6 +6,7 @@ CREATE TABLE IF NOT EXISTS Courses (
   `map_id` INT2 UNSIGNED NOT NULL,
   `map_stage` INT1 UNSIGNED NOT NULL,
   `name` VARCHAR(32),
+  `description` TEXT,
   PRIMARY KEY (`id`),
   FOREIGN KEY (`map_id`) REFERENCES Maps (`id`) ON DELETE CASCADE,
   UNIQUE (`map_id`, `map_stage`),
@@ -36,6 +37,7 @@ CREATE TABLE IF NOT EXISTS CourseFilters (
   `teleports` BOOLEAN NOT NULL,
   `tier` INT1 UNSIGNED NOT NULL,
   `ranked_status` INT1 NOT NULL,
+  `notes` TEXT,
   PRIMARY KEY (`id`),
   FOREIGN KEY (`course_id`) REFERENCES Courses (`id`) ON DELETE CASCADE,
   FOREIGN KEY (`mode_id`) REFERENCES Modes (`id`),