Skip to content

feat: Updated OpenAPI spec #52

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.

Sign up for GitHub

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

Merged
github-actions merged 1 commit into from
Jun 23, 2026
Merged

feat: Updated OpenAPI spec #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 24 additions & 3 deletions src/libs/DeepL/Generated/DeepL.ITranslateDocumentsClient.TranslateDocument.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,15 @@ public partial interface ITranslateDocumentsClient
/// Example: prefer_more
/// </param>
/// <param name="glossaryId">
/// A unique ID assigned to a glossary.<br/>
/// A unique ID assigned to a glossary. To check glossary support for a language pair, call `GET /v3/languages?resource=translate_document` and verify the `glossary` feature key is present on both the source and target language.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translated document. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="styleId">
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand All @@ -105,6 +111,7 @@ public partial interface ITranslateDocumentsClient
string? outputFormat = default,
global::DeepL.Formality? formality = default,
string? glossaryId = default,
global::System.Collections.Generic.IList<string>? glossaryIds = default,
string? styleId = default,
global::System.Guid? translationMemoryId = default,
int? translationMemoryThreshold = default,
Expand Down Expand Up @@ -158,9 +165,15 @@ public partial interface ITranslateDocumentsClient
/// Example: prefer_more
/// </param>
/// <param name="glossaryId">
/// A unique ID assigned to a glossary.<br/>
/// A unique ID assigned to a glossary. To check glossary support for a language pair, call `GET /v3/languages?resource=translate_document` and verify the `glossary` feature key is present on both the source and target language.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translated document. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="styleId">
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand All @@ -186,6 +199,7 @@ public partial interface ITranslateDocumentsClient
string? outputFormat = default,
global::DeepL.Formality? formality = default,
string? glossaryId = default,
global::System.Collections.Generic.IList<string>? glossaryIds = default,
string? styleId = default,
global::System.Guid? translationMemoryId = default,
int? translationMemoryThreshold = default,
Expand Down Expand Up @@ -238,9 +252,15 @@ public partial interface ITranslateDocumentsClient
/// Example: prefer_more
/// </param>
/// <param name="glossaryId">
/// A unique ID assigned to a glossary.<br/>
/// A unique ID assigned to a glossary. To check glossary support for a language pair, call `GET /v3/languages?resource=translate_document` and verify the `glossary` feature key is present on both the source and target language.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translated document. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="styleId">
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand All @@ -266,6 +286,7 @@ public partial interface ITranslateDocumentsClient
string? outputFormat = default,
global::DeepL.Formality? formality = default,
string? glossaryId = default,
global::System.Collections.Generic.IList<string>? glossaryIds = default,
string? styleId = default,
global::System.Guid? translationMemoryId = default,
int? translationMemoryThreshold = default,
Expand Down
7 changes: 7 additions & 0 deletions src/libs/DeepL/Generated/DeepL.ITranslateTextClient.TranslateText.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,14 @@ public partial interface ITranslateTextClient
/// Specify the glossary to use for the translation. **Important:** This requires the `source_lang`<br/>
/// parameter to be set. The language pair of the glossary has to match the language pair of the<br/>
/// request.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Specify up to 5 glossaries to use for the translation, as an array of glossary IDs. Each glossary's matching terms are applied to the translation.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="styleId">
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand Down Expand Up @@ -155,6 +161,7 @@ public partial interface ITranslateTextClient
global::DeepL.Formality? formality = default,
global::DeepL.ModelType? modelType = default,
string? glossaryId = default,
global::System.Collections.Generic.IList<string>? glossaryIds = default,
string? styleId = default,
global::System.Guid? translationMemoryId = default,
int? translationMemoryThreshold = default,
Expand Down
21 changes: 19 additions & 2 deletions src/libs/DeepL/Generated/DeepL.Models.TranslateDocumentRequest.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,22 @@ public sealed partial class TranslateDocumentRequest
public global::DeepL.Formality? Formality { get; set; }

/// <summary>
/// A unique ID assigned to a glossary.<br/>
/// A unique ID assigned to a glossary. To check glossary support for a language pair, call `GET /v3/languages?resource=translate_document` and verify the `glossary` feature key is present on both the source and target language.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </summary>
/// <example>def3a26b-3e84-45b3-84ae-0c0aaf3525f7</example>
[global::System.Text.Json.Serialization.JsonPropertyName("glossary_id")]
public string? GlossaryId { get; set; }

/// <summary>
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translated document. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("glossary_ids")]
public global::System.Collections.Generic.IList<string>? GlossaryIds { get; set; }

/// <summary>
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand Down Expand Up @@ -172,9 +181,15 @@ public sealed partial class TranslateDocumentRequest
/// Example: prefer_more
/// </param>
/// <param name="glossaryId">
/// A unique ID assigned to a glossary.<br/>
/// A unique ID assigned to a glossary. To check glossary support for a language pair, call `GET /v3/languages?resource=translate_document` and verify the `glossary` feature key is present on both the source and target language.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translated document. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="styleId">
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand All @@ -200,6 +215,7 @@ public TranslateDocumentRequest(
string? outputFormat,
global::DeepL.Formality? formality,
string? glossaryId,
global::System.Collections.Generic.IList<string>? glossaryIds,
string? styleId,
global::System.Guid? translationMemoryId,
int? translationMemoryThreshold)
Expand All @@ -211,6 +227,7 @@ public TranslateDocumentRequest(
this.OutputFormat = outputFormat;
this.Formality = formality;
this.GlossaryId = glossaryId;
this.GlossaryIds = glossaryIds;
this.StyleId = styleId;
this.TranslationMemoryId = translationMemoryId;
this.TranslationMemoryThreshold = translationMemoryThreshold;
Expand Down
17 changes: 17 additions & 0 deletions src/libs/DeepL/Generated/DeepL.Models.TranslateTextRequest.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,21 @@ public sealed partial class TranslateTextRequest
/// Specify the glossary to use for the translation. **Important:** This requires the `source_lang`<br/>
/// parameter to be set. The language pair of the glossary has to match the language pair of the<br/>
/// request.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </summary>
/// <example>def3a26b-3e84-45b3-84ae-0c0aaf3525f7</example>
[global::System.Text.Json.Serialization.JsonPropertyName("glossary_id")]
public string? GlossaryId { get; set; }

/// <summary>
/// Specify up to 5 glossaries to use for the translation, as an array of glossary IDs. Each glossary's matching terms are applied to the translation.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("glossary_ids")]
public global::System.Collections.Generic.IList<string>? GlossaryIds { get; set; }

/// <summary>
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand Down Expand Up @@ -273,8 +282,14 @@ public sealed partial class TranslateTextRequest
/// Specify the glossary to use for the translation. **Important:** This requires the `source_lang`<br/>
/// parameter to be set. The language pair of the glossary has to match the language pair of the<br/>
/// request.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Specify up to 5 glossaries to use for the translation, as an array of glossary IDs. Each glossary's matching terms are applied to the translation.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="styleId">
/// Specify the [style rule list](/api-reference/style-rules) to use for the translation.<br/>
/// **Important:** The target language has to match the language of the style rule list.<br/>
Expand Down Expand Up @@ -334,6 +349,7 @@ public TranslateTextRequest(
global::DeepL.Formality? formality,
global::DeepL.ModelType? modelType,
string? glossaryId,
global::System.Collections.Generic.IList<string>? glossaryIds,
string? styleId,
global::System.Guid? translationMemoryId,
int? translationMemoryThreshold,
Expand All @@ -355,6 +371,7 @@ public TranslateTextRequest(
this.Formality = formality;
this.ModelType = modelType;
this.GlossaryId = glossaryId;
this.GlossaryIds = glossaryIds;
this.StyleId = styleId;
this.TranslationMemoryId = translationMemoryId;
this.TranslationMemoryThreshold = translationMemoryThreshold;
Expand Down
17 changes: 17 additions & 0 deletions src/libs/DeepL/Generated/DeepL.Models.TranslateTextRequest2.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,21 @@ public sealed partial class TranslateTextRequest2
/// Specify the glossary to use for the translation. **Important:** This requires the `source_lang`<br/>
/// parameter to be set. The language pair of the glossary has to match the language pair of the<br/>
/// request.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </summary>
/// <example>def3a26b-3e84-45b3-84ae-0c0aaf3525f7</example>
[global::System.Text.Json.Serialization.JsonPropertyName("glossary_id")]
public string? GlossaryId { get; set; }

/// <summary>
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translation. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("glossary_ids")]
public global::System.Collections.Generic.IList<string>? GlossaryIds { get; set; }

/// <summary>
/// A unique ID assigned to a translation memory.<br/>
/// Example: a74d88fb-ed2a-4943-a664-a4512398b994
Expand Down Expand Up @@ -243,8 +252,14 @@ public sealed partial class TranslateTextRequest2
/// Specify the glossary to use for the translation. **Important:** This requires the `source_lang`<br/>
/// parameter to be set. The language pair of the glossary has to match the language pair of the<br/>
/// request.<br/>
/// Cannot be used together with `glossary_ids`.<br/>
/// Example: def3a26b-3e84-45b3-84ae-0c0aaf3525f7
/// </param>
/// <param name="glossaryIds">
/// Comma-separated list of up to 5 glossary IDs to use for the translation. Each glossary's matching terms are applied to the translation. May also be sent as a repeated parameter.<br/>
/// **Important:** This requires the `source_lang` parameter to be set. Every listed glossary must contain a dictionary for the requested language pair.<br/>
/// Cannot be used together with `glossary_id`.
/// </param>
/// <param name="translationMemoryId">
/// A unique ID assigned to a translation memory.<br/>
/// Example: a74d88fb-ed2a-4943-a664-a4512398b994
Expand Down Expand Up @@ -289,6 +304,7 @@ public TranslateTextRequest2(
global::DeepL.Formality? formality,
global::DeepL.ModelType? modelType,
string? glossaryId,
global::System.Collections.Generic.IList<string>? glossaryIds,
global::System.Guid? translationMemoryId,
int? translationMemoryThreshold,
global::DeepL.TagHandlingOption? tagHandling,
Expand All @@ -307,6 +323,7 @@ public TranslateTextRequest2(
this.Formality = formality;
this.ModelType = modelType;
this.GlossaryId = glossaryId;
this.GlossaryIds = glossaryIds;
this.TranslationMemoryId = translationMemoryId;
this.TranslationMemoryThreshold = translationMemoryThreshold;
this.TagHandling = tagHandling;
Expand Down
Loading