Add missing parameter description

apivideo · Oct 9, 2024 · 77ebac0 · 77ebac0
1 parent ff994ef
commit 77ebac0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git 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
@@ -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 &#x60;true&#x60; to define a caption as the default for a video.
 
 
     try {

diff --git 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 &#x60;true&#x60; 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
@@ -40,12 +40,12 @@ public CaptionsUpdatePayload _default(Boolean _default) {
     }
 
     /**
-     * Get _default
+     * Set this parameter to &#x60;true&#x60; 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;