Update video-clip schema with descriptions

apivideo · Oct 15, 2023 · ddf7057 · ddf7057
1 parent 831310d
commit ddf7057
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/docs/Model/VideoClip.md b/docs/Model/VideoClip.md
@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**startTimecode** | **string** |  | [optional]
-**endTimecode** | **string** |  | [optional]
+**startTimecode** | **string** | The timestamp that defines the beginning of the video clip you want to create. The value must follow the &#x60;HH:MM:SS&#x60; format. | [optional]
+**endTimecode** | **string** | The timestamp that defines the end of the video clip you want to create. The value must follow the &#x60;HH:MM:SS&#x60; format. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/src/Model/VideoClip.php b/src/Model/VideoClip.php
@@ -20,6 +20,7 @@
  * VideoClip Class Doc Comment
  *
  * @category Class
+ * @description Use this object to create a smaller clip from a video you upload.  - You can only create video clips in the same request where you create the video container. - You cannot update the starting or ending timestamps of a video clip after you created the video container. - When you upload a video file into a container where you defined a starting and ending timestamp, the API trims the video according to those timestamps to create a clip.
  * @package  ApiVideo\Client
  * @template TKey int|null
  * @template TValue mixed|null
@@ -123,7 +124,7 @@ public function getStartTimecode()
     /**
      * Sets startTimecode
      *
-     * @param string|null $startTimecode startTimecode
+     * @param string|null $startTimecode The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.
      *
      * @return self
      */
@@ -152,7 +153,7 @@ public function getEndTimecode()
     /**
      * Sets endTimecode
      *
-     * @param string|null $endTimecode endTimecode
+     * @param string|null $endTimecode The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.
      *
      * @return self
      */