Add player logo file contraints to API reference

apivideo · Sep 27, 2023 · 59b8448 · 59b8448
1 parent 4308a02
commit 59b8448
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 5 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -7625,7 +7625,11 @@ paths:
             // Documentation: https://github.com/apivideo/api.video-ios-client/blob/main/docs/PlayerThemesAPI.md#deleteLogo
       x-accepts: application/json
     post:
-      description: Upload an image logo for a player.
+      description: |
+        Upload an image file as a logo for your player. The image should fit within these constraints:
+        - The image mime type must be `image/jpeg` or `image/png`. api.video recommends using `png` images with transparent background.
+        - The image size should be a maximum of 200px width x 100px.
+        - The file size should be a maximum of 100 KiB.
       operationId: POST_players-playerId-logo
       parameters:
       - description: The unique identifier for the player.

diff --git a/docs/PlayerThemesApi.md b/docs/PlayerThemesApi.md
@@ -399,7 +399,7 @@ Name | Type | Description  | Notes
 
 Upload a logo
 
-Upload an image logo for a player.
+Upload an image file as a logo for your player. The image should fit within these constraints: - The image mime type must be `image/jpeg` or `image/png`. api.video recommends using `png` images with transparent background. - The image size should be a maximum of 200px width x 100px. - The file size should be a maximum of 100 KiB. 
 
 ### Example
 ```java

diff --git a/src/main/java/video/api/client/api/clients/PlayerThemesApi.java b/src/main/java/video/api/client/api/clients/PlayerThemesApi.java
@@ -1287,7 +1287,10 @@ private okhttp3.Call uploadLogoValidateBeforeCall(String playerId, File file, St
     /**
      * Upload a logo
      *
-     * Upload an image logo for a player.
+     * Upload an image file as a logo for your player. The image should fit within these constraints: - The image mime
+     * type must be &#x60;image/jpeg&#x60; or &#x60;image/png&#x60;. api.video recommends using &#x60;png&#x60; images
+     * with transparent background. - The image size should be a maximum of 200px width x 100px. - The file size should
+     * be a maximum of 100 KiB.
      * 
      * @param playerId
      *            The unique identifier for the player. (required)
@@ -1334,7 +1337,10 @@ public PlayerTheme uploadLogo(String playerId, File file, String link) throws Ap
     /**
      * Upload a logo
      *
-     * Upload an image logo for a player.
+     * Upload an image file as a logo for your player. The image should fit within these constraints: - The image mime
+     * type must be &#x60;image/jpeg&#x60; or &#x60;image/png&#x60;. api.video recommends using &#x60;png&#x60; images
+     * with transparent background. - The image size should be a maximum of 200px width x 100px. - The file size should
+     * be a maximum of 100 KiB.
      * 
      * @param playerId
      *            The unique identifier for the player. (required)
@@ -1382,7 +1388,10 @@ public ApiResponse<PlayerTheme> uploadLogoWithHttpInfo(String playerId, File fil
     }
 
     /**
-     * Upload a logo (asynchronously) Upload an image logo for a player.
+     * Upload a logo (asynchronously) Upload an image file as a logo for your player. The image should fit within these
+     * constraints: - The image mime type must be &#x60;image/jpeg&#x60; or &#x60;image/png&#x60;. api.video recommends
+     * using &#x60;png&#x60; images with transparent background. - The image size should be a maximum of 200px width x
+     * 100px. - The file size should be a maximum of 100 KiB.
      * 
      * @param playerId
      *            The unique identifier for the player. (required)