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

Add missing parameter description #126

Merged
merged 1 commit into from
Oct 9, 2024
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
2 changes: 2 additions & 0 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16423,6 +16423,8 @@ components:
captions-update-payload:
properties:
default:
description: Set this parameter to `true` to define a caption as the default
for a video.
type: boolean
title: CaptionsUpdatePayload
type: object
Expand Down
2 changes: 1 addition & 1 deletion docs/CaptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ public class Example {
String videoId = "vi4k0jvEUuaTdRAEjQ4Prklg"; // The unique identifier for the video you want to have automatic captions for.
String language = "en"; // A valid language identifier using IETF language tags. You can use primary subtags like `en` (English), extended subtags like `fr-CA` (French, Canada), or region subtags like `zh-Hans-CN` (Simplified Chinese used in the PRC). - This parameter **only accepts dashes for separators**, for example `fr-CA`. If you use a different separator in your request, the API returns an error. - When the value in your request does not match any covered language, the API returns an error. - You can find the list of supported tags [here](https://docs.api.video/vod/add-captions#supported-caption-language-tags).
CaptionsUpdatePayload captionsUpdatePayload = new CaptionsUpdatePayload(); //
captionsUpdatePayload.setDefault(); //
captionsUpdatePayload.setDefault(); // Set this parameter to `true` to define a caption as the default for a video.


try {
Expand Down
2 changes: 1 addition & 1 deletion docs/CaptionsUpdatePayload.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_default** | **Boolean** | | [optional]
**_default** | **Boolean** | Set this parameter to `true` to define a caption as the default for a video. | [optional]


## Implemented Interfaces
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ public CaptionsUpdatePayload _default(Boolean _default) {
}

/**
* Get _default
* Set this parameter to `true` to define a caption as the default for a video.
*
* @return _default
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@ApiModelProperty(value = "Set this parameter to `true` to define a caption as the default for a video.")

public Boolean getDefault() {
return _default;
Expand Down
Loading