[Update] API Docs

- Updated openapi.json
Kurozora · Apr 19, 2024 · 2f9901f · 2f9901f
1 parent 38f9084
commit 2f9901f
Showing 1 changed file with 80 additions and 0 deletions.
diff --git a/public/openapi.json b/public/openapi.json
@@ -40,6 +40,10 @@
       "name": "schedule",
       "description": "Everything schedule related"
     },
+    {
+      "name": "images",
+      "description": "Everything image related"
+    },
     {
       "name": "cast",
       "description": "Everything cast related"
@@ -2545,6 +2549,56 @@
         }
       }
     },
+    "/images/random": {
+      "get": {
+        "tags": [
+          "images"
+        ],
+        "operationId": "getRandomImages",
+        "summary": "Random images.",
+        "description": "This endpoint will retrieve random images.",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "type",
+            "schema": {
+              "$ref": "#/components/schemas/MediaType"
+            },
+            "required": true,
+            "description": "The type of images to retrieve."
+          },
+          {
+            "in": "query",
+            "name": "collection",
+            "schema": {
+              "$ref": "#/components/schemas/MediaCollection"
+            },
+            "required": true,
+            "description": "The collection of images to retrieve."
+          },
+          {
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "type": "string",
+              "example": 12,
+              "minimum": 1,
+              "maximum": 25
+            },
+            "required": false,
+            "description": "The limit on the number of objects, or number of objects in the specified relationship, that are returned. The default value is 25 and the maximum value is 100."
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/GetCastSuccess"
+          },
+          "400": {
+            "$ref": "#/components/responses/JSONError"
+          }
+        }
+      }
+    },
     "/cast/{castID}": {
       "get": {
         "tags": [
@@ -5478,6 +5532,32 @@
         },
         "description": "The relations to include in the response."
       },
+      "MediaType": {
+        "type": "string",
+        "enum": [
+          "episodes",
+          "games",
+          "literatures",
+          "shows"
+        ],
+        "default": "shows",
+        "description": "The set of available media types."
+      },
+      "MediaCollection": {
+        "type": "string",
+        "enum": [
+          "default",
+          "artwork",
+          "banner",
+          "logo",
+          "poster",
+          "profile",
+          "screenshot",
+          "symbol"
+        ],
+        "default": "banner",
+        "description": "The set of available media collections."
+      },
       "ImportService": {
         "type": "integer",
         "enum": [