Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update video-clip schema with descriptions #104

Merged
merged 1 commit into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions docs/VideoClip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 11 additions & 5 deletions src/main/java/video/api/client/api/models/VideoClip.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand All @@ -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;
Expand Down
Loading