Skip to content

Add validation error details to ProblemDetailsModel #68

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
tiksn merged 1 commit into from
Jun 8, 2026
+72 −7
Merged

Add validation error details to ProblemDetailsModel #68

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
5 changes: 4 additions & 1 deletion src/Bridge/Models/ApiModels/SharedModels.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
namespace Fossa.Bridge.Models.ApiModels

open System
open System.Collections.Generic

[<CLIMutable>]
type ProblemDetailsModel =
{ Type: string | null
Title: string | null
Status: int
Detail: string | null
Instance: string | null }
Instance: string | null
Errors: Dictionary<string, string array>
TraceId: string | null }

[<CLIMutable>]
type AddressModel =
Expand Down
5 changes: 4 additions & 1 deletion tests/Bridge.Tests/ClientResultTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module ClientResultTests

open System.Collections.Generic
open Expecto
open Fossa.Bridge.Models.ApiModels
open Fossa.Bridge.Models.ApiModels.Helpers
Expand All @@ -9,7 +10,9 @@ let private problem =
Title = "Conflict"
Status = 409
Detail = "The requested change conflicts with current state."
Instance = "/companies/42" }
Instance = "/companies/42"
Errors = Unchecked.defaultof<Dictionary<string, string array>>
TraceId = null }

[<Tests>]
let tests =
Expand Down
5 changes: 4 additions & 1 deletion tests/Bridge.Tests/ClientUnitResultTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module ClientUnitResultTests

open System.Collections.Generic
open Expecto
open Fossa.Bridge.Models.ApiModels
open Fossa.Bridge.Models.ApiModels.Helpers
Expand All @@ -9,7 +10,9 @@ let private problem =
Title = "Conflict"
Status = 409
Detail = "The requested change conflicts with current state."
Instance = "/companies/42" }
Instance = "/companies/42"
Errors = Unchecked.defaultof<Dictionary<string, string array>>
TraceId = null }

[<Tests>]
let tests =
Expand Down
59 changes: 56 additions & 3 deletions tests/Bridge.Tests/JsonSerializerTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module JsonSerializerTests

open System
open System.Collections.Generic
open Expecto
open Fossa.Bridge.Models.ApiModels
open Fossa.Bridge.Services
Expand Down Expand Up @@ -85,7 +86,9 @@ let tests =
Title = "Conflict"
Status = 409
Detail = "The requested change conflicts with current state."
Instance = "/companies/42" }
Instance = "/companies/42"
Errors = Unchecked.defaultof<Dictionary<string, string array>>
TraceId = null }

let json = serializer.Serialize(model)

Expand All @@ -94,6 +97,8 @@ let tests =
Expect.isTrue (json.Contains("\"status\"")) "JSON should contain lowercase status"
Expect.isTrue (json.Contains("\"detail\"")) "JSON should contain lowercase detail"
Expect.isTrue (json.Contains("\"instance\"")) "JSON should contain lowercase instance"
Expect.isTrue (json.Contains("\"errors\"")) "JSON should contain lowercase errors"
Expect.isTrue (json.Contains("\"traceId\"")) "JSON should contain camelCase traceId"
Expect.isFalse (json.Contains("\"Type\"")) "JSON should not contain PascalCase Type"

testCase "ProblemDetailsModel serializes null core fields"
Expand All @@ -105,15 +110,40 @@ let tests =
Title = null
Status = 404
Detail = null
Instance = null }
Instance = null
Errors = Unchecked.defaultof<Dictionary<string, string array>>
TraceId = null }

let json = serializer.Serialize(model)

Expect.equal
json
"{\"type\":null,\"title\":null,\"status\":404,\"detail\":null,\"instance\":null}"
"{\"type\":null,\"title\":null,\"status\":404,\"detail\":null,\"instance\":null,\"errors\":null,\"traceId\":null}"
"Null core fields should be serialized"

testCase "ProblemDetailsModel serializes validation problem details"
<| fun _ ->
let serializer = JsonSerializer() :> IJsonSerializer
let errors = Dictionary<string, string array>()
errors.Add("Name", [| "The Name field is required." |])

let model =
{ Type = "https://tools.ietf.org/html/rfc7231#section-6.5.1"
Title = "One or more validation errors occurred."
Status = 400
Detail = null
Instance = null
Errors = errors
TraceId = "00-abc-123-00" }

let json = serializer.Serialize(model)

Expect.isTrue
(json.Contains("\"errors\":{\"Name\":[\"The Name field is required.\"]}"))
"Errors should serialize"

Expect.isTrue (json.Contains("\"traceId\":\"00-abc-123-00\"")) "TraceId should serialize"

testCase "ProblemDetailsModel deserializes known fields"
<| fun _ ->
let serializer = JsonSerializer() :> IJsonSerializer
Expand All @@ -129,6 +159,29 @@ let tests =
Expect.equal model.Detail "Missing." "Detail should deserialize"
Expect.equal model.Instance "/companies/99" "Instance should deserialize"

testCase "ProblemDetailsModel deserializes validation problem details"
<| fun _ ->
let serializer = JsonSerializer() :> IJsonSerializer

let json =
"{\"type\":\"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\"title\":\"One or more validation errors occurred.\",\"status\":400,\"errors\":{\"Name\":[\"The Name field is required.\"]},\"traceId\":\"00-abc-123-00\"}"

let model = serializer.Deserialize<ProblemDetailsModel>(json)

Expect.equal model.Type "https://tools.ietf.org/html/rfc7231#section-6.5.1" "Type should deserialize"
Expect.equal model.Title "One or more validation errors occurred." "Title should deserialize"
Expect.equal model.Status 400 "Status should deserialize"
Expect.isNull model.Detail "Missing detail should deserialize to null"
Expect.isNull model.Instance "Missing instance should deserialize to null"
Expect.isTrue (model.Errors.ContainsKey "Name") "Errors should contain Name"

Expect.sequenceEqual
model.Errors["Name"]
[| "The Name field is required." |]
"Name errors should deserialize"

Expect.equal model.TraceId "00-abc-123-00" "TraceId should deserialize"

testCase "ProblemDetailsModel deserializes missing status as default int"
<| fun _ ->
let serializer = JsonSerializer() :> IJsonSerializer
Expand Down
5 changes: 4 additions & 1 deletion tests/Bridge.Tests/StatusCodeHelpersTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module StatusCodeHelpersTests

open System.Collections.Generic
open Expecto
open Fossa.Bridge.Models.ApiModels
open Fossa.Bridge.Services.StatusCodeHelpers
Expand All @@ -9,7 +10,9 @@ let private problemWithStatus status =
Title = null
Status = status
Detail = null
Instance = null }
Instance = null
Errors = Unchecked.defaultof<Dictionary<string, string array>>
TraceId = null }

[<Tests>]
let tests =
Expand Down