NRL-1285 Replace root in diagnostics for DocumentReference

axelkrastek1-nhs · axelkrastek1-nhs · commit 21677677419a · 2025-04-29T14:17:45.000+01:00
diff --git a/api/producer/createDocumentReference/tests/test_create_document_reference.py b/api/producer/createDocumentReference/tests/test_create_document_reference.py
@@ -421,8 +421,8 @@ def test_create_document_reference_empty_fields_in_body():
                         }
                     ],
                 },
-                "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: text, author, custodian.reference, custodian.identifier, category[0].coding[0].system, category[0].coding[0].code)",
-                "expression": ["root"],
+                "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: text, author, custodian.reference, custodian.identifier, category[0].coding[0].system, category[0].coding[0].code)",
+                "expression": ["DocumentReference"],
             }
         ],
     }
@@ -859,8 +859,8 @@ def test_create_document_reference_no_relatesto_target():
                         }
                     ],
                 },
-                "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: relatesTo[0].target)",
-                "expression": ["root"],
+                "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: relatesTo[0].target)",
+                "expression": ["DocumentReference"],
             }
         ],
     }
diff --git a/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py b/api/producer/upsertDocumentReference/tests/test_upsert_document_reference.py
@@ -782,8 +782,8 @@ def test_upsert_document_reference_no_relatesto_target():
                         }
                     ],
                 },
-                "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: relatesTo[0].target)",
-                "expression": ["root"],
+                "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: relatesTo[0].target)",
+                "expression": ["DocumentReference"],
             }
         ],
     }
diff --git a/layer/nrlf/core/errors.py b/layer/nrlf/core/errors.py
@@ -35,13 +35,13 @@ def append_value_set_url(loc_string: str) -> str:
 
 def diag_for_error(error: ErrorDetails) -> str:
     loc_string = format_error_location(error["loc"])
-    msg = f"{loc_string or 'root'}: {error['msg']}"
+    msg = f"{loc_string or 'DocumentReference'}: {error['msg']}"
     msg += append_value_set_url(loc_string)
     return msg
 
 
 def expression_for_error(error: ErrorDetails) -> Optional[str]:
-    return format_error_location(error["loc"]) or "root"
+    return format_error_location(error["loc"]) or "DocumentReference"
 
 
 class OperationOutcomeError(Exception):
diff --git a/layer/nrlf/core/tests/test_request.py b/layer/nrlf/core/tests/test_request.py
@@ -245,8 +245,8 @@ def test_parse_body_invalid_docref_json():
                         }
                     ],
                 },
-                "diagnostics": "Request body could not be parsed (root: Invalid JSON: control character (\\u0000-\\u001F) found while parsing a string at line 72 column 0)",
-                "expression": ["root"],
+                "diagnostics": "Request body could not be parsed (DocumentReference: Invalid JSON: control character (\\u0000-\\u001F) found while parsing a string at line 72 column 0)",
+                "expression": ["DocumentReference"],
             }
         ],
     }
@@ -403,8 +403,8 @@ def test_parse_body_not_json():
                         }
                     ]
                 },
-                "diagnostics": "Request body could not be parsed (root: Invalid JSON: expected value at line 1 column 1)",
-                "expression": ["root"],
+                "diagnostics": "Request body could not be parsed (DocumentReference: Invalid JSON: expected value at line 1 column 1)",
+                "expression": ["DocumentReference"],
             }
         ],
     }
diff --git a/tests/features/producer/createDocumentReference-failure.feature b/tests/features/producer/createDocumentReference-failure.feature
@@ -744,9 +744,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)",
         "expression": [
-            "root"
+            "DocumentReference"
         ]
       }
       """
@@ -802,9 +802,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content[0].attachment.contentType)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)",
         "expression": [
-          "root"
+          "DocumentReference"
         ]
       }
       """
@@ -1008,9 +1008,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: context.practiceSetting.coding[0].display)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: context.practiceSetting.coding[0].display)",
         "expression": [
-          "root"
+          "DocumentReference"
         ]
       }
       """
@@ -1040,7 +1040,7 @@ Feature: Producer - createDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: author)",
-        "expression": ["root"]
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: author)",
+        "expression": ["DocumentReference"]
       }
       """
diff --git a/tests/features/producer/updateDocumentReference-failure.feature b/tests/features/producer/updateDocumentReference-failure.feature
@@ -87,9 +87,9 @@ Feature: Producer - updateDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)",
         "expression": [
-            "root"
+            "DocumentReference"
         ]
       }
       """
@@ -158,9 +158,9 @@ Feature: Producer - updateDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content[0].attachment.contentType)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)",
         "expression": [
-          "root"
+          "DocumentReference"
         ]
       }
       """
diff --git a/tests/features/producer/upsertDocumentReference-failure.feature b/tests/features/producer/upsertDocumentReference-failure.feature
@@ -265,9 +265,9 @@ Feature: Producer - upsertDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)",
         "expression": [
-            "root"
+            "DocumentReference"
         ]
       }
       """
@@ -323,9 +323,9 @@ Feature: Producer - upsertDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content[0].attachment.contentType)",
+        "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)",
         "expression": [
-          "root"
+          "DocumentReference"
         ]
       }
       """

Original file line number	Diff line number	Diff line change
`@@ -421,8 +421,8 @@ def test_create_document_reference_empty_fields_in_body():`
`421`	`421`	`}`
`422`	`422`	`],`
`423`	`423`	`},`
`424`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: text, author, custodian.reference, custodian.identifier, category[0].coding[0].system, category[0].coding[0].code)",`
`425`		`- "expression": ["root"],`
	`424`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: text, author, custodian.reference, custodian.identifier, category[0].coding[0].system, category[0].coding[0].code)",`
	`425`	`+ "expression": ["DocumentReference"],`
`426`	`426`	`}`
`427`	`427`	`],`
`428`	`428`	`}`
`@@ -859,8 +859,8 @@ def test_create_document_reference_no_relatesto_target():`
`859`	`859`	`}`
`860`	`860`	`],`
`861`	`861`	`},`
`862`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: relatesTo[0].target)",`
`863`		`- "expression": ["root"],`
	`862`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: relatesTo[0].target)",`
	`863`	`+ "expression": ["DocumentReference"],`
`864`	`864`	`}`
`865`	`865`	`],`
`866`	`866`	`}`
Original file line number	Diff line number	Diff line change
`@@ -782,8 +782,8 @@ def test_upsert_document_reference_no_relatesto_target():`
`782`	`782`	`}`
`783`	`783`	`],`
`784`	`784`	`},`
`785`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: relatesTo[0].target)",`
`786`		`- "expression": ["root"],`
	`785`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: relatesTo[0].target)",`
	`786`	`+ "expression": ["DocumentReference"],`
`787`	`787`	`}`
`788`	`788`	`],`
`789`	`789`	`}`
Original file line number	Diff line number	Diff line change
`@@ -245,8 +245,8 @@ def test_parse_body_invalid_docref_json():`
`245`	`245`	`}`
`246`	`246`	`],`
`247`	`247`	`},`
`248`		`- "diagnostics": "Request body could not be parsed (root: Invalid JSON: control character (\\u0000-\\u001F) found while parsing a string at line 72 column 0)",`
`249`		`- "expression": ["root"],`
	`248`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Invalid JSON: control character (\\u0000-\\u001F) found while parsing a string at line 72 column 0)",`
	`249`	`+ "expression": ["DocumentReference"],`
`250`	`250`	`}`
`251`	`251`	`],`
`252`	`252`	`}`
`@@ -403,8 +403,8 @@ def test_parse_body_not_json():`
`403`	`403`	`}`
`404`	`404`	`]`
`405`	`405`	`},`
`406`		`- "diagnostics": "Request body could not be parsed (root: Invalid JSON: expected value at line 1 column 1)",`
`407`		`- "expression": ["root"],`
	`406`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Invalid JSON: expected value at line 1 column 1)",`
	`407`	`+ "expression": ["DocumentReference"],`
`408`	`408`	`}`
`409`	`409`	`],`
`410`	`410`	`}`
Original file line number	Diff line number	Diff line change
`@@ -744,9 +744,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios`
`744`	`744`	`}`
`745`	`745`	`]`
`746`	`746`	`},`
`747`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content)",`
	`747`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)",`
`748`	`748`	`"expression": [`
`749`		`- "root"`
	`749`	`+ "DocumentReference"`
`750`	`750`	`]`
`751`	`751`	`}`
`752`	`752`	`"""`
`@@ -802,9 +802,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios`
`802`	`802`	`}`
`803`	`803`	`]`
`804`	`804`	`},`
`805`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content[0].attachment.contentType)",`
	`805`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)",`
`806`	`806`	`"expression": [`
`807`		`- "root"`
	`807`	`+ "DocumentReference"`
`808`	`808`	`]`
`809`	`809`	`}`
`810`	`810`	`"""`
`@@ -1008,9 +1008,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios`
`1008`	`1008`	`}`
`1009`	`1009`	`]`
`1010`	`1010`	`},`
`1011`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: context.practiceSetting.coding[0].display)",`
	`1011`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: context.practiceSetting.coding[0].display)",`
`1012`	`1012`	`"expression": [`
`1013`		`- "root"`
	`1013`	`+ "DocumentReference"`
`1014`	`1014`	`]`
`1015`	`1015`	`}`
`1016`	`1016`	`"""`
`@@ -1040,7 +1040,7 @@ Feature: Producer - createDocumentReference - Failure Scenarios`
`1040`	`1040`	`}`
`1041`	`1041`	`]`
`1042`	`1042`	`},`
`1043`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: author)",`
`1044`		`- "expression": ["root"]`
	`1043`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: author)",`
	`1044`	`+ "expression": ["DocumentReference"]`
`1045`	`1045`	`}`
`1046`	`1046`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -87,9 +87,9 @@ Feature: Producer - updateDocumentReference - Failure Scenarios`
`87`	`87`	`}`
`88`	`88`	`]`
`89`	`89`	`},`
`90`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content)",`
	`90`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)",`
`91`	`91`	`"expression": [`
`92`		`- "root"`
	`92`	`+ "DocumentReference"`
`93`	`93`	`]`
`94`	`94`	`}`
`95`	`95`	`"""`
`@@ -158,9 +158,9 @@ Feature: Producer - updateDocumentReference - Failure Scenarios`
`158`	`158`	`}`
`159`	`159`	`]`
`160`	`160`	`},`
`161`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content[0].attachment.contentType)",`
	`161`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)",`
`162`	`162`	`"expression": [`
`163`		`- "root"`
	`163`	`+ "DocumentReference"`
`164`	`164`	`]`
`165`	`165`	`}`
`166`	`166`	`"""`
Original file line number	Diff line number	Diff line change
`@@ -265,9 +265,9 @@ Feature: Producer - upsertDocumentReference - Failure Scenarios`
`265`	`265`	`}`
`266`	`266`	`]`
`267`	`267`	`},`
`268`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content)",`
	`268`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content)",`
`269`	`269`	`"expression": [`
`270`		`- "root"`
	`270`	`+ "DocumentReference"`
`271`	`271`	`]`
`272`	`272`	`}`
`273`	`273`	`"""`
`@@ -323,9 +323,9 @@ Feature: Producer - upsertDocumentReference - Failure Scenarios`
`323`	`323`	`}`
`324`	`324`	`]`
`325`	`325`	`},`
`326`		`- "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: content[0].attachment.contentType)",`
	`326`	`+ "diagnostics": "Request body could not be parsed (DocumentReference: Value error, The following fields are empty: content[0].attachment.contentType)",`
`327`	`327`	`"expression": [`
`328`		`- "root"`
	`328`	`+ "DocumentReference"`
`329`	`329`	`]`
`330`	`330`	`}`
`331`	`331`	`"""`