Merge pull request #64 from apivideo/update-player-logo-request-descr…

…iption Add player logo file contraints to API reference
apivideo · Sep 28, 2023 · 1c98925 · 1c98925
2 parents f425eb8 + 7ffec49
commit 1c98925
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-15641308b8635d4681dbd94d4931525c407a0a10b8e7487da2365559b4d4adf2
+99dd458f8a6d84027d6ea7d90cbc93b699c1c212f7f0e36f067326a87a068499
diff --git a/Sources/APIs/PlayerThemesAPI.swift b/Sources/APIs/PlayerThemesAPI.swift
@@ -307,7 +307,7 @@ open class PlayerThemesAPI {
     /**
      Upload a logo
      - POST /players/{playerId}/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. 
      - parameter playerId: (path) The unique identifier for the player. 
      - parameter file: (form) The name of the file you want to use for your logo. 
      - parameter link: (form) A public link that you want to advertise in your player. For example, you could add a link to your company. When a viewer clicks on your logo, they will be taken to this address. (optional)

diff --git a/docs/PlayerThemesAPI.md b/docs/PlayerThemesAPI.md
@@ -283,7 +283,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
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		15641308b8635d4681dbd94d4931525c407a0a10b8e7487da2365559b4d4adf2
		99dd458f8a6d84027d6ea7d90cbc93b699c1c212f7f0e36f067326a87a068499