Skip to content

feat: Updated OpenAPI spec #35

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
May 21, 2026
Merged

feat: Updated OpenAPI spec #35

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
14 changes: 14 additions & 0 deletions src/libs/DeepL/Generated/DeepL.Models.CustomTagUsageItem.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ public sealed partial class CustomTagUsageItem
[global::System.Text.Json.Serialization.JsonPropertyName("custom_tag")]
public string? CustomTag { get; set; }

/// <summary>
/// The day the usage was recorded. Only returned when `aggregate_by` is `day`.<br/>
/// Example: 2026-05-04T00:00:00Z
/// </summary>
/// <example>2026-05-04T00:00:00Z</example>
[global::System.Text.Json.Serialization.JsonPropertyName("usage_date")]
public global::System.DateTime? UsageDate { get; set; }

/// <summary>
/// Breakdown of character usage by category for a custom tag.
/// </summary>
Expand All @@ -35,6 +43,10 @@ public sealed partial class CustomTagUsageItem
/// The custom tag identifier.<br/>
/// Example: example-custom-tag
/// </param>
/// <param name="usageDate">
/// The day the usage was recorded. Only returned when `aggregate_by` is `day`.<br/>
/// Example: 2026-05-04T00:00:00Z
/// </param>
/// <param name="breakdown">
/// Breakdown of character usage by category for a custom tag.
/// </param>
Expand All @@ -43,9 +55,11 @@ public sealed partial class CustomTagUsageItem
#endif
public CustomTagUsageItem(
string? customTag,
global::System.DateTime? usageDate,
global::DeepL.CustomTagBreakdown? breakdown)
{
this.CustomTag = customTag;
this.UsageDate = usageDate;
this.Breakdown = breakdown;
}

Expand Down
2 changes: 1 addition & 1 deletion src/libs/DeepL/Generated/autosdk.generated-examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"Slug": "admingetcustomtaganalytics",
"Description": "Retrieve usage statistics broken down by custom tags within a specified date range.\nOptionally aggregate results by day or over the entire period.\nResults are paginated; use the \u0060page\u0060 parameter with the \u0060next_page\u0060 value from\na previous response to retrieve subsequent pages.",
"Language": "csharp",
"Code": "using var client = new DeepLClient(apiKey);\n\nvar response = await client.AdminApi.AdminGetCustomTagAnalyticsAsync(\n startDate: global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::System.DateTime\u003E(\n @\u0022\u0022\u00222026-05-17\u0022\u0022\u0022)!,\n endDate: global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::System.DateTime\u003E(\n @\u0022\u0022\u00222026-05-18\u0022\u0022\u0022)!,\n aggregateBy: global::DeepL.AdminGetCustomTagAnalyticsAggregateBy.Day,\n page: 2\n);\n\n// Example response:\n// {\n// \u0022custom_tag_usage_report\u0022: {\n// \u0022aggregate_by\u0022: \u0022day\u0022,\n// \u0022start_date\u0022: \u00222026-05-17T00:00:00\u0022,\n// \u0022end_date\u0022: \u00222026-05-18T00:00:00\u0022,\n// \u0022next_page\u0022: 2,\n// \u0022usage\u0022: [\n// {\n// \u0022custom_tag\u0022: \u0022example-custom-tag\u0022,\n// \u0022breakdown\u0022: {\n// \u0022total_characters\u0022: 190,\n// \u0022text_translation_characters\u0022: 190,\n// \u0022text_improvement_characters\u0022: 0\n// }\n// }\n// ]\n// }\n// }",
"Code": "using var client = new DeepLClient(apiKey);\n\nvar response = await client.AdminApi.AdminGetCustomTagAnalyticsAsync(\n startDate: global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::System.DateTime\u003E(\n @\u0022\u0022\u00222026-05-17\u0022\u0022\u0022)!,\n endDate: global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::System.DateTime\u003E(\n @\u0022\u0022\u00222026-05-18\u0022\u0022\u0022)!,\n aggregateBy: global::DeepL.AdminGetCustomTagAnalyticsAggregateBy.Day,\n page: 2\n);\n\n// Example response:\n// {\n// \u0022custom_tag_usage_report\u0022: {\n// \u0022aggregate_by\u0022: \u0022day\u0022,\n// \u0022start_date\u0022: \u00222026-05-03T00:00:00\u0022,\n// \u0022end_date\u0022: \u00222026-05-15T00:00:00\u0022,\n// \u0022next_page\u0022: \u0022openapi-json-null-sentinel-value-2BF93600-0FE4-4250-987A-E5DDB203E464\u0022,\n// \u0022usage\u0022: [\n// {\n// \u0022custom_tag\u0022: \u0022example-custom-tag\u0022,\n// \u0022usage_date\u0022: \u00222026-05-04T00:00:00Z\u0022,\n// \u0022breakdown\u0022: {\n// \u0022total_characters\u0022: 380,\n// \u0022text_translation_characters\u0022: 380,\n// \u0022text_improvement_characters\u0022: 0\n// }\n// },\n// {\n// \u0022custom_tag\u0022: \u0022example-custom-tag\u0022,\n// \u0022usage_date\u0022: \u00222026-05-11T00:00:00Z\u0022,\n// \u0022breakdown\u0022: {\n// \u0022total_characters\u0022: 595,\n// \u0022text_translation_characters\u0022: 595,\n// \u0022text_improvement_characters\u0022: 0\n// }\n// }\n// ]\n// }\n// }",
"Format": "sdk",
"OperationId": "adminGetCustomTagAnalytics",
"Setup": "This example assumes \u0060using DeepL;\u0060 is in scope and \u0060apiKey\u0060 contains the required credential."
Expand Down
22 changes: 17 additions & 5 deletions src/libs/DeepL/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,14 +293,21 @@ paths:
value:
custom_tag_usage_report:
aggregate_by: "day"
start_date: "2026-05-17T00:00:00"
end_date: "2026-05-18T00:00:00"
next_page: 2
start_date: "2026-05-03T00:00:00"
end_date: "2026-05-15T00:00:00"
next_page: null
usage:
- custom_tag: "example-custom-tag"
usage_date: "2026-05-04T00:00:00Z"
breakdown:
total_characters: 380
text_translation_characters: 380
text_improvement_characters: 0
- custom_tag: "example-custom-tag"
usage_date: "2026-05-11T00:00:00Z"
breakdown:
total_characters: 190
text_translation_characters: 190
total_characters: 595
text_translation_characters: 595
text_improvement_characters: 0
400:
description: Bad request. Please check error message and your parameters.
Expand Down Expand Up @@ -5695,6 +5702,11 @@ components:
type: string
description: The custom tag identifier.
example: "example-custom-tag"
usage_date:
type: string
format: date-time
description: The day the usage was recorded. Only returned when `aggregate_by` is `day`.
example: "2026-05-04T00:00:00Z"
breakdown:
$ref: '#/components/schemas/CustomTagBreakdown'
CustomTagBreakdown:
Expand Down