Merge pull request #83 from apivideo/Add-clip-object-timecode-descrip…

…tions Update video-clip schema with descriptions
apivideo · Oct 16, 2023 · 43c86ef · 43c86ef
2 parents aaa63fb + b9c84fd
commit 43c86ef
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/apivideo/model/video_clip.py b/apivideo/model/video_clip.py
@@ -141,8 +141,8 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            start_timecode (str): [optional]  # noqa: E501
-            end_timecode (str): [optional]  # noqa: E501
+            start_timecode (str): The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.. [optional]  # noqa: E501
+            end_timecode (str): The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

diff --git a/docs/VideoClip.md b/docs/VideoClip.md
@@ -1,10 +1,11 @@
 # VideoClip
 
+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.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**start_timecode** | **str** |  | [optional] 
-**end_timecode** | **str** |  | [optional] 
+**start_timecode** | **str** | 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] 
+**end_timecode** | **str** | 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#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/docs/VideosApi.md b/docs/VideosApi.md
@@ -53,8 +53,8 @@ with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
             ),
         ],
         clip=VideoClip(
-            start_timecode="8072",
-            end_timecode="8072",
+            start_timecode="00:01:15",
+            end_timecode="00:02:33",
         ),
         watermark=VideoWatermark(
             id="watermark_1BWr2L5MTQwxGkuxKjzh6i",

diff --git a/test/test_videos_api.py b/test/test_videos_api.py
@@ -65,8 +65,8 @@ def test_create(self):
             ),
         ],
         clip=VideoClip(
-            start_timecode="8072",
-            end_timecode="8072",
+            start_timecode="00:01:15",
+            end_timecode="00:02:33",
         ),
         watermark=VideoWatermark(
             id="watermark_1BWr2L5MTQwxGkuxKjzh6i",