From 06480108d50bca58a2ff18cdade1f651f3aade49 Mon Sep 17 00:00:00 2001 From: szekelyzol Date: Fri, 8 Nov 2024 13:37:31 +0000 Subject: [PATCH] Add missing description --- api/openapi.yaml | 9 ++++++--- docs/SummariesApi.md | 2 +- docs/SummaryCreationPayload.md | 2 +- docs/VideoCreationPayload.md | 2 +- docs/VideoUpdatePayload.md | 2 +- docs/VideosApi.md | 4 ++-- .../api/client/api/models/SummaryCreationPayload.java | 5 +++-- .../api/client/api/models/VideoCreationPayload.java | 5 +++-- .../video/api/client/api/models/VideoUpdatePayload.java | 5 +++-- 9 files changed, 21 insertions(+), 15 deletions(-) diff --git a/api/openapi.yaml b/api/openapi.yaml index 887003c..6c80620 100644 --- a/api/openapi.yaml +++ b/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 diff --git a/docs/SummariesApi.md b/docs/SummariesApi.md index 01d2bf2..5f6b5c6 100644 --- a/docs/SummariesApi.md +++ b/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 { diff --git a/docs/SummaryCreationPayload.md b/docs/SummaryCreationPayload.md index e372c24..a0313ed 100644 --- a/docs/SummaryCreationPayload.md +++ b/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] diff --git a/docs/VideoCreationPayload.md b/docs/VideoCreationPayload.md index 57318ab..3e12d92 100644 --- a/docs/VideoCreationPayload.md +++ b/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] diff --git a/docs/VideoUpdatePayload.md b/docs/VideoUpdatePayload.md index 7b2b000..e3729d7 100644 --- a/docs/VideoUpdatePayload.md +++ b/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] diff --git a/docs/VideosApi.md b/docs/VideosApi.md index 67fb982..dc8709b 100644 --- a/docs/VideosApi.md +++ b/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 { diff --git a/src/main/java/video/api/client/api/models/SummaryCreationPayload.java b/src/main/java/video/api/client/api/models/SummaryCreationPayload.java index 9078cd2..151ac37 100644 --- a/src/main/java/video/api/client/api/models/SummaryCreationPayload.java +++ b/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 getAttributes() { return attributes; diff --git a/src/main/java/video/api/client/api/models/VideoCreationPayload.java b/src/main/java/video/api/client/api/models/VideoCreationPayload.java index 731c146..a8fc83a 100644 --- a/src/main/java/video/api/client/api/models/VideoCreationPayload.java +++ b/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 getTranscriptSummaryAttributes() { return transcriptSummaryAttributes; diff --git a/src/main/java/video/api/client/api/models/VideoUpdatePayload.java b/src/main/java/video/api/client/api/models/VideoUpdatePayload.java index 4fd3165..cabec2b 100644 --- a/src/main/java/video/api/client/api/models/VideoUpdatePayload.java +++ b/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 getTranscriptSummaryAttributes() { return transcriptSummaryAttributes;