Update video-clip schema with descriptions

apivideo · Oct 15, 2023 · d93db41 · d93db41
1 parent c1559db
commit d93db41
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 7 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -11538,11 +11538,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
@@ -2,12 +2,13 @@
 
 # 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
 ------------ | ------------- | ------------- | -------------
-**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]
 
 
 ## Implemented Interfaces

diff --git a/src/main/java/video/api/client/api/models/VideoClip.java b/src/main/java/video/api/client/api/models/VideoClip.java
@@ -24,8 +24,12 @@
 import java.io.Serializable;
 
 /**
- * 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.
  */
+@ApiModel(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.")
 
 public class VideoClip implements Serializable {
     private static final long serialVersionUID = 1L;
@@ -44,12 +48,13 @@ public VideoClip startTimecode(String startTimecode) {
     }
 
     /**
-     * Get startTimecode
+     * 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.
      * 
      * @return startTimecode
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "")
+    @ApiModelProperty(example = "00:01:15", value = "The timestamp that defines the beginning of the video clip you want to create. The value must follow the `HH:MM:SS` format.")
 
     public String getStartTimecode() {
         return startTimecode;
@@ -65,12 +70,13 @@ public VideoClip endTimecode(String endTimecode) {
     }
 
     /**
-     * Get endTimecode
+     * 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.
      * 
      * @return endTimecode
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "")
+    @ApiModelProperty(example = "00:02:33", value = "The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` format.")
 
     public String getEndTimecode() {
         return endTimecode;