From 77ebac08e645ea31973f0652c5c53df33f4b8157 Mon Sep 17 00:00:00 2001 From: szekelyzol Date: Wed, 9 Oct 2024 13:59:02 +0000 Subject: [PATCH] Add missing parameter description --- api/openapi.yaml | 2 ++ docs/CaptionsApi.md | 2 +- docs/CaptionsUpdatePayload.md | 2 +- .../video/api/client/api/models/CaptionsUpdatePayload.java | 4 ++-- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/api/openapi.yaml b/api/openapi.yaml index 436a8fd..d6343fe 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -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 diff --git a/docs/CaptionsApi.md b/docs/CaptionsApi.md index 711e8f7..92eb484 100644 --- a/docs/CaptionsApi.md +++ b/docs/CaptionsApi.md @@ -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 { diff --git a/docs/CaptionsUpdatePayload.md b/docs/CaptionsUpdatePayload.md index d6a014d..2dd12ae 100644 --- a/docs/CaptionsUpdatePayload.md +++ b/docs/CaptionsUpdatePayload.md @@ -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 diff --git a/src/main/java/video/api/client/api/models/CaptionsUpdatePayload.java b/src/main/java/video/api/client/api/models/CaptionsUpdatePayload.java index 3907a35..48bd321 100644 --- a/src/main/java/video/api/client/api/models/CaptionsUpdatePayload.java +++ b/src/main/java/video/api/client/api/models/CaptionsUpdatePayload.java @@ -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;