Updated naming to suit convention (#626)

sillsdev · Feb 13, 2025 · e024561 · e024561
1 parent ffd8a1e
commit e024561
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 35 deletions.
diff --git a/src/Serval/src/Serval.Client/Client.g.cs b/src/Serval/src/Serval.Client/Client.g.cs
@@ -2213,7 +2213,7 @@ public partial interface ITranslationEnginesClient
         /// <param name="id">The translation engine id</param>
         /// <returns>The engine language was successfully updated.</returns>
         /// <exception cref="ServalApiException">A server side error occurred.</exception>
-        System.Threading.Tasks.Task UpdateLanguagesAsync(string id, UpdateLanguagesRequest request, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
+        System.Threading.Tasks.Task UpdateAsync(string id, TranslationEngineUpdateConfig request, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
 
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
         /// <summary>
@@ -3080,7 +3080,7 @@ public string BaseUrl
         /// <param name="id">The translation engine id</param>
         /// <returns>The engine language was successfully updated.</returns>
         /// <exception cref="ServalApiException">A server side error occurred.</exception>
-        public virtual async System.Threading.Tasks.Task UpdateLanguagesAsync(string id, UpdateLanguagesRequest request, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
+        public virtual async System.Threading.Tasks.Task UpdateAsync(string id, TranslationEngineUpdateConfig request, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
         {
             if (id == null)
                 throw new System.ArgumentNullException("id");
@@ -7370,7 +7370,7 @@ public partial class TranslationEngineConfig
     }
 
     [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "14.1.0.0 (NJsonSchema v11.0.2.0 (Newtonsoft.Json v13.0.0.0))")]
-    public partial class UpdateLanguagesRequest
+    public partial class TranslationEngineUpdateConfig
     {
         [Newtonsoft.Json.JsonProperty("sourceLanguage", Required = Newtonsoft.Json.Required.Always)]
         [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)]

diff --git a/src/Serval/src/Serval.Translation/Contracts/TranslationEngineUpdateConfigDto.cs b/src/Serval/src/Serval.Translation/Contracts/TranslationEngineUpdateConfigDto.cs
@@ -0,0 +1,8 @@
+namespace Serval.Translation.Contracts;
+
+public class TranslationEngineUpdateConfigDto
+{
+    public string SourceLanguage { get; init; } = string.Empty;
+
+    public string TargetLanguage { get; init; } = string.Empty;
+}
diff --git a/src/Serval/src/Serval.Translation/Contracts/UpdateLanguagesRequestDto.cs b/src/Serval/src/Serval.Translation/Contracts/UpdateLanguagesRequestDto.cs
diff --git a/src/Serval/src/Serval.Translation/Controllers/TranslationEnginesController.cs b/src/Serval/src/Serval.Translation/Controllers/TranslationEnginesController.cs
@@ -185,9 +185,9 @@ public async Task<ActionResult> DeleteAsync([NotNull] string id, CancellationTok
     [ProducesResponseType(typeof(void), StatusCodes.Status403Forbidden)]
     [ProducesResponseType(typeof(void), StatusCodes.Status404NotFound)]
     [ProducesResponseType(typeof(void), StatusCodes.Status503ServiceUnavailable)]
-    public async Task<ActionResult> UpdateLanguagesAsync(
+    public async Task<ActionResult> UpdateAsync(
         [FromRoute] string id,
-        [FromBody] UpdateLanguagesRequestDto request,
+        [FromBody] TranslationEngineUpdateConfigDto request,
         CancellationToken cancellationToken = default
     )
     {
@@ -201,12 +201,7 @@ request is null
             return BadRequest("sourceLanguage or targetLanguage is required.");
         }
 
-        await _engineService.UpdateLanguagesAsync(
-            id,
-            request.SourceLanguage,
-            request.TargetLanguage,
-            cancellationToken
-        );
+        await _engineService.UpdateAsync(id, request.SourceLanguage, request.TargetLanguage, cancellationToken);
 
         return Ok();
     }

diff --git a/src/Serval/src/Serval.Translation/Models/Engine.cs b/src/Serval/src/Serval.Translation/Models/Engine.cs
@@ -5,8 +5,8 @@ public record Engine : IOwnedEntity, IInitializableEntity
     public string Id { get; set; } = "";
     public int Revision { get; set; } = 1;
     public string? Name { get; init; }
-    public required string SourceLanguage { get; set; }
-    public required string TargetLanguage { get; set; }
+    public required string SourceLanguage { get; init; }
+    public required string TargetLanguage { get; init; }
     public required string Type { get; init; }
     public required string Owner { get; init; }
     public IReadOnlyList<Corpus> Corpora { get; init; } = new List<Corpus>();

diff --git a/src/Serval/src/Serval.Translation/Services/EngineService.cs b/src/Serval/src/Serval.Translation/Services/EngineService.cs
@@ -195,7 +195,7 @@ await Entities.UpdateAsync(
         return engine;
     }
 
-    public async Task UpdateLanguagesAsync(
+    public async Task UpdateAsync(
         string engineId,
         string sourceLanguage = "",
         string targetLanguage = "",

diff --git a/src/Serval/src/Serval.Translation/Services/IEngineService.cs b/src/Serval/src/Serval.Translation/Services/IEngineService.cs
@@ -7,7 +7,7 @@ public interface IEngineService
 
     Task<Engine> CreateAsync(Engine engine, CancellationToken cancellationToken = default);
 
-    Task UpdateLanguagesAsync(
+    Task UpdateAsync(
         string engineId,
         string sourceLanguage,
         string targetLanguage,

diff --git a/src/Serval/test/Serval.Translation.Tests/Services/EngineServiceTests.cs b/src/Serval/test/Serval.Translation.Tests/Services/EngineServiceTests.cs
@@ -1967,14 +1967,14 @@ public async Task UpdateCorpusAsync()
     }
 
     [Test]
-    public async Task UpdateLanguagesAsync_ShouldUpdateLanguages_WhenRequestIsValid()
+    public async Task UpdateAsync_ShouldUpdateLanguages_WhenRequestIsValid()
     {
         var env = new TestEnvironment();
         var engine = await env.CreateEngineWithTextFilesAsync();
 
-        var request = new UpdateLanguagesRequestDto { SourceLanguage = "en", TargetLanguage = "fr" };
+        var request = new TranslationEngineUpdateConfigDto { SourceLanguage = "en", TargetLanguage = "fr" };
 
-        await env.Service.UpdateLanguagesAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
+        await env.Service.UpdateAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
 
         engine = await env.Engines.GetAsync(engine.Id);
 
@@ -1986,14 +1986,14 @@ public async Task UpdateLanguagesAsync_ShouldUpdateLanguages_WhenRequestIsValid(
     }
 
     [Test]
-    public async Task UpdateLanguagesAsync_ShouldNotUpdateSourceLanguage_WhenSourceLanguageNotProvided()
+    public async Task UpdateAsync_ShouldNotUpdateSourceLanguage_WhenSourceLanguageNotProvided()
     {
         var env = new TestEnvironment();
         var engine = await env.CreateEngineWithTextFilesAsync();
 
-        var request = new UpdateLanguagesRequestDto { SourceLanguage = "", TargetLanguage = "fr" };
+        var request = new TranslationEngineUpdateConfigDto { SourceLanguage = "", TargetLanguage = "fr" };
 
-        await env.Service.UpdateLanguagesAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
+        await env.Service.UpdateAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
 
         var updatedEngine = await env.Engines.GetAsync(engine.Id);
 
@@ -2005,14 +2005,14 @@ public async Task UpdateLanguagesAsync_ShouldNotUpdateSourceLanguage_WhenSourceL
     }
 
     [Test]
-    public async Task UpdateLanguagesAsync_ShouldNotUpdateTargetLanguage_WhenTargetLanguageNotProvided()
+    public async Task UpdateAsync_ShouldNotUpdateTargetLanguage_WhenTargetLanguageNotProvided()
     {
         var env = new TestEnvironment();
         var engine = await env.CreateEngineWithTextFilesAsync();
 
-        var request = new UpdateLanguagesRequestDto { SourceLanguage = "en", TargetLanguage = "" };
+        var request = new TranslationEngineUpdateConfigDto { SourceLanguage = "en", TargetLanguage = "" };
 
-        await env.Service.UpdateLanguagesAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
+        await env.Service.UpdateAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
 
         var updatedEngine = await env.Engines.GetAsync(engine.Id);
 
@@ -2024,14 +2024,14 @@ public async Task UpdateLanguagesAsync_ShouldNotUpdateTargetLanguage_WhenTargetL
     }
 
     [Test]
-    public async Task UpdateLanguagesAsync_ShouldNotUpdate_WhenSourceAndTargetLanguagesNotProvided()
+    public async Task UpdateAsync_ShouldNotUpdate_WhenSourceAndTargetLanguagesNotProvided()
     {
         var env = new TestEnvironment();
         var engine = await env.CreateEngineWithTextFilesAsync();
 
-        var request = new UpdateLanguagesRequestDto { SourceLanguage = "", TargetLanguage = "" };
+        var request = new TranslationEngineUpdateConfigDto { SourceLanguage = "", TargetLanguage = "" };
 
-        await env.Service.UpdateLanguagesAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
+        await env.Service.UpdateAsync(engine.Id, request.SourceLanguage, request.TargetLanguage);
 
         var updatedEngine = await env.Engines.GetAsync(engine.Id);