Update api reference

Syriiin · Nov 12, 2024 · c01663c · c01663c
1 parent 84038c9
commit c01663c
Show file tree

Hide file tree

Showing 4 changed files with 120 additions and 32 deletions.
diff --git a/docs/docs/api-reference/difficalcy-catch.json b/docs/docs/api-reference/difficalcy-catch.json
@@ -82,10 +82,10 @@
             "name": "Mods",
             "in": "query",
             "schema": {
-              "maximum": 2147483647,
-              "minimum": 0,
-              "type": "integer",
-              "format": "int32"
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Mod"
+              }
             }
           }
         ],
@@ -217,10 +217,11 @@
             "type": "string"
           },
           "mods": {
-            "maximum": 2147483647,
-            "minimum": 0,
-            "type": "integer",
-            "format": "int32"
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Mod"
+            },
+            "nullable": true
           },
           "combo": {
             "maximum": 2147483647,
@@ -251,6 +252,27 @@
           }
         },
         "additionalProperties": false
+      },
+      "Mod": {
+        "required": [
+          "acronym"
+        ],
+        "type": "object",
+        "properties": {
+          "acronym": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "settings": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "nullable": true
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
       }
     }
   }

diff --git a/docs/docs/api-reference/difficalcy-mania.json b/docs/docs/api-reference/difficalcy-mania.json
@@ -92,10 +92,10 @@
             "name": "Mods",
             "in": "query",
             "schema": {
-              "maximum": 2147483647,
-              "minimum": 0,
-              "type": "integer",
-              "format": "int32"
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Mod"
+              }
             }
           }
         ],
@@ -227,10 +227,11 @@
             "type": "string"
           },
           "mods": {
-            "maximum": 2147483647,
-            "minimum": 0,
-            "type": "integer",
-            "format": "int32"
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Mod"
+            },
+            "nullable": true
           },
           "misses": {
             "maximum": 2147483647,
@@ -264,6 +265,27 @@
           }
         },
         "additionalProperties": false
+      },
+      "Mod": {
+        "required": [
+          "acronym"
+        ],
+        "type": "object",
+        "properties": {
+          "acronym": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "settings": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "nullable": true
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
       }
     }
   }

diff --git a/docs/docs/api-reference/difficalcy-osu.json b/docs/docs/api-reference/difficalcy-osu.json
@@ -82,10 +82,10 @@
             "name": "Mods",
             "in": "query",
             "schema": {
-              "maximum": 2147483647,
-              "minimum": 0,
-              "type": "integer",
-              "format": "int32"
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Mod"
+              }
             }
           }
         ],
@@ -166,6 +166,27 @@
         },
         "additionalProperties": false
       },
+      "Mod": {
+        "required": [
+          "acronym"
+        ],
+        "type": "object",
+        "properties": {
+          "acronym": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "settings": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "nullable": true
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "OsuCalculation": {
         "type": "object",
         "properties": {
@@ -245,10 +266,11 @@
             "type": "string"
           },
           "mods": {
-            "maximum": 2147483647,
-            "minimum": 0,
-            "type": "integer",
-            "format": "int32"
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Mod"
+            },
+            "nullable": true
           },
           "combo": {
             "maximum": 2147483647,

diff --git a/docs/docs/api-reference/difficalcy-taiko.json b/docs/docs/api-reference/difficalcy-taiko.json
@@ -72,10 +72,10 @@
             "name": "Mods",
             "in": "query",
             "schema": {
-              "maximum": 2147483647,
-              "minimum": 0,
-              "type": "integer",
-              "format": "int32"
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Mod"
+              }
             }
           }
         ],
@@ -156,6 +156,27 @@
         },
         "additionalProperties": false
       },
+      "Mod": {
+        "required": [
+          "acronym"
+        ],
+        "type": "object",
+        "properties": {
+          "acronym": {
+            "minLength": 1,
+            "type": "string"
+          },
+          "settings": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "nullable": true
+            },
+            "nullable": true
+          }
+        },
+        "additionalProperties": false
+      },
       "TaikoCalculation": {
         "type": "object",
         "properties": {
@@ -227,10 +248,11 @@
             "type": "string"
           },
           "mods": {
-            "maximum": 2147483647,
-            "minimum": 0,
-            "type": "integer",
-            "format": "int32"
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Mod"
+            },
+            "nullable": true
           },
           "combo": {
             "maximum": 2147483647,