Build options is an arbitrary json object rather than a string

[Enkidu93]

Fixes #180. I've verified that arbitrary JSON can be passed without error and parsed properly. It can also continue to be passed as a string.

---

This change is 

[codecov-commenter]

Codecov Report

All modified lines are covered by tests ✅

Files	Coverage Δ
src/Serval.Client/Client.g.cs	70.60% <100.00%> (ø)
...Translation/Contracts/TranslationBuildConfigDto.cs	100.00% <100.00%> (ø)
...erval.Translation/Contracts/TranslationBuildDto.cs	100.00% <100.00%> (ø)
...lation/Controllers/TranslationEnginesController.cs	91.43% <100.00%> (ø)

📢 Thoughts on this report? Let us know!.

[ddaspit]

You forgot to update the Options property on TranslationBuildDto.

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @Enkidu93 and @johnml1135)

---

src/Serval.Translation/Contracts/TranslationBuildConfigDto.cs line 8 at r1 (raw file):

    public IList<PretranslateCorpusConfigDto>? Pretranslate { get; set; }

    public object? Options { get; set; }

The Swagger docs show an invalid example for this property. Specifically, it shows a string value, which will result in a 400 status code. We should specify a valid example using code documentation. For example:

/// <example>
/// {
///   "property": "value"
/// }
/// </example>

[Enkidu93]

I had intentionally not done that, but I suppose there's no good reason not to. It would make the presentation cleaner and more consistent to the user when they request an existing builds information.

[ddaspit]

Yeah, we want it to be consistent.

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @Enkidu93 and @johnml1135)

[Enkidu93]

src/Serval.Translation/Contracts/TranslationBuildConfigDto.cs line 8 at r1 (raw file):

Previously, ddaspit (Damien Daspit) wrote…

The Swagger docs show an invalid example for this property. Specifically, it shows a string value, which will result in a 400 status code. We should specify a valid example using code documentation. For example:

/// <example>
/// {
///   "property": "value"
/// }
/// </example>

OK, good call: I wasn't familiar with how to do that properly, but I wondered the same thing.

[Enkidu93]

Done.

Reviewable status: 0 of 4 files reviewed, 1 unresolved discussion (waiting on @ddaspit and @johnml1135)

---

src/Serval.Translation/Contracts/TranslationBuildConfigDto.cs line 8 at r1 (raw file):

Previously, Enkidu93 (Eli C. Lowry) wrote…

OK, good call: I wasn't familiar with how to do that properly, but I wondered the same thing.

Done.

[ddaspit]

Reviewed 4 of 4 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @Enkidu93 and @johnml1135)

---

src/Serval.Translation/Contracts/TranslationBuildDto.cs line 22 at r2 (raw file):

    public JobState State { get; set; }
    public DateTime? DateFinished { get; set; }
    public object? Options { get; set; }

You should add the example here as well.

[Enkidu93]

src/Serval.Translation/Contracts/TranslationBuildDto.cs line 22 at r2 (raw file):

Previously, ddaspit (Damien Daspit) wrote…

You should add the example here as well.

Done.

[ddaspit]

Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @johnml1135)