From d93db4151b01a0346fd77c7eaa483d0987b6c01b Mon Sep 17 00:00:00 2001 From: szekelyzol Date: Sun, 15 Oct 2023 18:34:28 +0000 Subject: [PATCH] Update video-clip schema with descriptions --- api/openapi.yaml | 12 ++++++++++++ docs/VideoClip.md | 5 +++-- .../video/api/client/api/models/VideoClip.java | 16 +++++++++++----- 3 files changed, 26 insertions(+), 7 deletions(-) diff --git a/api/openapi.yaml b/api/openapi.yaml index 44fc837..709b328 100644 --- 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 index 3713887..daf5896 100644 --- 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 `HH:MM:SS` format. | [optional] +**endTimecode** | **String** | The timestamp that defines the end of the video clip you want to create. The value must follow the `HH:MM:SS` 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 index da39982..7e1c078 100644 --- 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 + * `HH:MM:SS` 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 + * `HH:MM:SS` 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;