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

…tions Update video-clip schema with descriptions
apivideo · Oct 16, 2023 · 0593de7 · 0593de7
2 parents 068c76f + b148c99
commit 0593de7
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -11470,11 +11470,23 @@ components:
           type: string
       type: object
     video-clip:
+      description: "Use this object to create a smaller clip from a video you upload.\
+        \ \n- You can only create video clips in the same request where you create\
+        \ the video container.\n- You cannot update the starting or ending timestamps\
+        \ of a video clip after you created the video container.\n- 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:
         startTimecode:
+          description: The timestamp that defines the beginning of the video clip
+            you want to create. The value must follow the `HH:MM:SS` format.
+          example: 00:01:15
           pattern: ^(?:\d{2,3}:[0-5]\d:[0-5]\d(?:\.\d{1,3}|\:\d{1,2})?|\d{1,7})$
           type: string
         endTimecode:
+          description: The timestamp that defines the end of the video clip you want
+            to create. The value must follow the `HH:MM:SS` format.
+          example: 00:02:33
           pattern: ^(?:\d{2,3}:[0-5]\d:[0-5]\d(?:\.\d{1,3}|\:\d{1,2})?|\d{1,7})$
           type: string
       type: object

diff --git a/docs/VideoClip.md b/docs/VideoClip.md
@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**StartTimecode** | Pointer to **string** |  | [optional] 
-**EndTimecode** | Pointer to **string** |  | [optional] 
+**StartTimecode** | Pointer to **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** | Pointer to **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] 
 
 ## Methods
 

diff --git a/model_video_clip.go b/model_video_clip.go