Skip to content

Commit e6154e1

Browse files
HavenDVgithub-actions[bot]
andauthored
feat: Updated OpenAPI spec (#44)
Co-authored-by: github-actions[bot] <dependabot@bot.com>
1 parent c685a9b commit e6154e1

3 files changed

Lines changed: 27 additions & 4 deletions

File tree

src/libs/DeepL/Generated/DeepL.Models.QualityEvaluationDone.g.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public sealed partial class QualityEvaluationDone
3232
public required global::System.Collections.Generic.IList<global::DeepL.QualityEvaluationSegment> Segments { get; set; }
3333

3434
/// <summary>
35-
/// Aggregate counts of issues across all segments.
35+
/// Aggregate quality results across all segments.
3636
/// </summary>
3737
[global::System.Text.Json.Serialization.JsonPropertyName("summary")]
3838
[global::System.Text.Json.Serialization.JsonRequired]
@@ -54,7 +54,7 @@ public sealed partial class QualityEvaluationDone
5454
/// One entry per submitted segment, in request order.
5555
/// </param>
5656
/// <param name="summary">
57-
/// Aggregate counts of issues across all segments.
57+
/// Aggregate quality results across all segments.
5858
/// </param>
5959
/// <param name="status">
6060
/// Example: done

src/libs/DeepL/Generated/DeepL.Models.QualityEvaluationDoneSummary.g.cs

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,19 @@
44
namespace DeepL
55
{
66
/// <summary>
7-
/// Aggregate counts of issues across all segments.
7+
/// Aggregate quality results across all segments.
88
/// </summary>
99
public sealed partial class QualityEvaluationDoneSummary
1010
{
11+
/// <summary>
12+
/// Overall translation quality, from 0 (lowest) to 100 (highest). See [Summary](/api-reference/quality-evaluation/poll#summary).<br/>
13+
/// Example: 72
14+
/// </summary>
15+
/// <example>72</example>
16+
[global::System.Text.Json.Serialization.JsonPropertyName("overall_score")]
17+
[global::System.Text.Json.Serialization.JsonRequired]
18+
public required int OverallScore { get; set; }
19+
1120
/// <summary>
1221
/// Nested counts keyed by `type`, then `sub_type`, then `severity`. Leaf values are integer counts.<br/>
1322
/// Example: {"Accuracy":{"Mistranslation":{"Critical":1,"Minor":1},"Omission":{"Major":1}}}
@@ -26,6 +35,10 @@ public sealed partial class QualityEvaluationDoneSummary
2635
/// <summary>
2736
/// Initializes a new instance of the <see cref="QualityEvaluationDoneSummary" /> class.
2837
/// </summary>
38+
/// <param name="overallScore">
39+
/// Overall translation quality, from 0 (lowest) to 100 (highest). See [Summary](/api-reference/quality-evaluation/poll#summary).<br/>
40+
/// Example: 72
41+
/// </param>
2942
/// <param name="granularCounts">
3043
/// Nested counts keyed by `type`, then `sub_type`, then `severity`. Leaf values are integer counts.<br/>
3144
/// Example: {"Accuracy":{"Mistranslation":{"Critical":1,"Minor":1},"Omission":{"Major":1}}}
@@ -34,8 +47,10 @@ public sealed partial class QualityEvaluationDoneSummary
3447
[global::System.Diagnostics.CodeAnalysis.SetsRequiredMembers]
3548
#endif
3649
public QualityEvaluationDoneSummary(
50+
int overallScore,
3751
object granularCounts)
3852
{
53+
this.OverallScore = overallScore;
3954
this.GranularCounts = granularCounts ?? throw new global::System.ArgumentNullException(nameof(granularCounts));
4055
}
4156

src/libs/DeepL/openapi.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3471,6 +3471,7 @@ paths:
34713471
- start: 38
34723472
end: 48
34733473
summary:
3474+
overall_score: 72
34743475
granular_counts:
34753476
Accuracy:
34763477
Mistranslation:
@@ -6428,9 +6429,16 @@ components:
64286429
summary:
64296430
type: object
64306431
required:
6432+
- overall_score
64316433
- granular_counts
6432-
description: Aggregate counts of issues across all segments.
6434+
description: Aggregate quality results across all segments.
64336435
properties:
6436+
overall_score:
6437+
type: integer
6438+
minimum: 0
6439+
maximum: 100
6440+
description: Overall translation quality, from 0 (lowest) to 100 (highest). See [Summary](/api-reference/quality-evaluation/poll#summary).
6441+
example: 72
64346442
granular_counts:
64356443
type: object
64366444
description: Nested counts keyed by `type`, then `sub_type`, then `severity`. Leaf values are integer counts.

0 commit comments

Comments
 (0)