Merge pull request #134 from apivideo/update-summary-request-attribute-description

Add missing description

Author: bot-api-video

api/openapi.yaml

@@ -16781,7 +16781,8 @@ components:
         transcriptSummaryAttributes:
           description: Use this parameter to define the elements of a summary that
             you want to generate. If you do not define this parameter, the API generates
-            a full summary with all attributes.
+            a full summary with all attributes. The possible values are `abstract`
+            and `takeaways`.
           items:
             enum:
             - abstract
@@ -16812,7 +16813,8 @@ components:
         attributes:
           description: Use this parameter to define the elements of a summary that
             you want to generate. If you do not define this parameter, the API generates
-            a full summary with all attributes.
+            a full summary with all attributes. The possible values are `abstract`
+            and `takeaways`.
           items:
             enum:
             - abstract
@@ -17159,7 +17161,8 @@ components:
         transcriptSummaryAttributes:
           description: Use this parameter to define the elements of a summary that
             you want to generate. If you do not define this parameter, the API generates
-            a full summary with all attributes.
+            a full summary with all attributes. The possible values are `abstract`
+            and `takeaways`.
           items:
             enum:
             - abstract

docs/SummariesApi.md

@@ -45,7 +45,7 @@ public class Example {
 If you do not set this parameter, **the API will not generate a summary automatically**.
 
 In this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation.
-    summaryCreationPayload.setAttributes(); // Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.
+    summaryCreationPayload.setAttributes(); // Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.
 
 
     try {

docs/SummaryCreationPayload.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **videoId** | **String** | Create a summary of a video using the video ID. | 
 **origin** | [**OriginEnum**](#OriginEnum) | Use this parameter to define how the API generates the summary. The only allowed value is `auto`, which means that the API generates a summary automatically.  If you do not set this parameter, **the API will not generate a summary automatically**.  In this case, `sourceStatus` will return `missing`, and you have to manually add a summary using the `PATCH /summaries/{summaryId}/source` endpoint operation. |  [optional]
-**attributes** | [**List<AttributesEnum>**](#List<AttributesEnum>) | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. |  [optional]
+**attributes** | [**List<AttributesEnum>**](#List<AttributesEnum>) | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`. |  [optional]
 
 
 

docs/VideoCreationPayload.md

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **language** | [**LanguageEnum**](#LanguageEnum) | Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.  `language` is a permanent attribute of the video. You can update it to another language using the [`PATCH /videos/{videoId}`](https://docs.api.video/reference/api/Videos#update-a-video-object) operation. This triggers the API to generate a new transcript using a different language. |  [optional]
 **transcript** | **Boolean** | Use this parameter to enable transcription.   - When `true`, the API generates a transcript for the video. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video.  - When the API generates a transcript, it will be available as a caption for the video. |  [optional]
 **transcriptSummary** | **Boolean** | Use this parameter to enable summarization. We recommend using this parameter together with `transcript: true`.  - When `true`, the API generates a summary for the video, based on the transcription. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video. |  [optional]
-**transcriptSummaryAttributes** | [**List<TranscriptSummaryAttributesEnum>**](#List<TranscriptSummaryAttributesEnum>) | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. |  [optional]
+**transcriptSummaryAttributes** | [**List<TranscriptSummaryAttributesEnum>**](#List<TranscriptSummaryAttributesEnum>) | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`. |  [optional]
 
 
 

docs/VideoUpdatePayload.md

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **language** | [**LanguageEnum**](#LanguageEnum) | Use this parameter to set the language of the video. When this parameter is set, the API creates a transcript of the video using the language you specify. You must use the [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.  `language` is a permanent attribute of the video. You can update it to another language using the [`PATCH /videos/{videoId}`](https://docs.api.video/reference/api/Videos#update-a-video-object) operation. This triggers the API to generate a new transcript using a different language. |  [optional]
 **transcript** | **Boolean** | Use this parameter to enable transcription.   - When `true`, the API generates a transcript for the video. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to transcribe the video. If you do not define a language, the API detects it based on the video.  - When the API generates a transcript, it will be available as a caption for the video. |  [optional]
 **transcriptSummary** | **Boolean** | Use this parameter to enable summarization.   - When `true`, the API generates a summary for the video, based on the transcription. - The default value is `false`. - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video. |  [optional]
-**transcriptSummaryAttributes** | [**List<TranscriptSummaryAttributesEnum>**](#List<TranscriptSummaryAttributesEnum>) | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. |  [optional]
+**transcriptSummaryAttributes** | [**List<TranscriptSummaryAttributesEnum>**](#List<TranscriptSummaryAttributesEnum>) | Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`. |  [optional]
 
 
 

docs/VideosApi.md

@@ -72,7 +72,7 @@ public class Example {
 - When `true`, the API generates a summary for the video, based on the transcription.
 - The default value is `false`.
 - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video.
-    videoCreationPayload.setTranscriptSummaryAttributes(); // Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.
+    videoCreationPayload.setTranscriptSummaryAttributes(); // Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.
 
 
     try {
@@ -459,7 +459,7 @@ public class Example {
 - When `true`, the API generates a summary for the video, based on the transcription.
 - The default value is `false`.
 - If you define a video language using the `language` parameter, the API uses that language to summarize the video. If you do not define a language, the API detects it based on the video.
-    videoUpdatePayload.setTranscriptSummaryAttributes(); // Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.
+    videoUpdatePayload.setTranscriptSummaryAttributes(); // Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.
 
 
     try {

src/main/java/video/api/client/api/models/SummaryCreationPayload.java

@@ -198,12 +198,13 @@ public SummaryCreationPayload addAttributesItem(AttributesEnum attributesItem) {
 
     /**
      * Use this parameter to define the elements of a summary that you want to generate. If you do not define this
-     * parameter, the API generates a full summary with all attributes.
+     * parameter, the API generates a full summary with all attributes. The possible values are `abstract` and
+     * `takeaways`.
      * 
      * @return attributes
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.")
+    @ApiModelProperty(value = "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.")
 
     public List<AttributesEnum> getAttributes() {
         return attributes;

src/main/java/video/api/client/api/models/VideoCreationPayload.java

@@ -599,12 +599,13 @@ public VideoCreationPayload addTranscriptSummaryAttributesItem(
 
     /**
      * Use this parameter to define the elements of a summary that you want to generate. If you do not define this
-     * parameter, the API generates a full summary with all attributes.
+     * parameter, the API generates a full summary with all attributes. The possible values are `abstract` and
+     * `takeaways`.
      * 
      * @return transcriptSummaryAttributes
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.")
+    @ApiModelProperty(value = "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.")
 
     public List<TranscriptSummaryAttributesEnum> getTranscriptSummaryAttributes() {
         return transcriptSummaryAttributes;

src/main/java/video/api/client/api/models/VideoUpdatePayload.java

@@ -528,12 +528,13 @@ public VideoUpdatePayload addTranscriptSummaryAttributesItem(
 
     /**
      * Use this parameter to define the elements of a summary that you want to generate. If you do not define this
-     * parameter, the API generates a full summary with all attributes.
+     * parameter, the API generates a full summary with all attributes. The possible values are `abstract` and
+     * `takeaways`.
      * 
      * @return transcriptSummaryAttributes
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes.")
+    @ApiModelProperty(value = "Use this parameter to define the elements of a summary that you want to generate. If you do not define this parameter, the API generates a full summary with all attributes. The possible values are `abstract` and `takeaways`.")
 
     public List<TranscriptSummaryAttributesEnum> getTranscriptSummaryAttributes() {
         return transcriptSummaryAttributes;