feat(byos): change public API field name

corenting · corenting · commit 8a9531d57c07 · 2025-08-11T11:56:52.000+02:00
This is not a breaking change: the API does still support the old
`document_identifier` name.
diff --git a/pygitguardian/client.py b/pygitguardian/client.py
@@ -584,7 +584,7 @@ def scan_and_create_incidents(
             "source_uuid": source_uuid,
             "documents": [
                 {
-                    "document_identifier": document["filename"],
+                    "filename": document["filename"],
                     "document": document["document"],
                 }
                 for document in request_obj
diff --git a/tests/test_client.py b/tests/test_client.py
@@ -667,7 +667,7 @@ def test_scan_and_create_incidents_payload_structure(client: GGClient):
         "documents": [
             {
                 "document": DOCUMENT,
-                "document_identifier": FILENAME,
+                "filename": FILENAME,
             }
         ],
         "source_uuid": source_uuid,

Original file line number	Diff line number	Diff line change
`@@ -584,7 +584,7 @@ def scan_and_create_incidents(`
`584`	`584`	`"source_uuid": source_uuid,`
`585`	`585`	`"documents": [`
`586`	`586`	`{`
`587`		`- "document_identifier": document["filename"],`
	`587`	`+ "filename": document["filename"],`
`588`	`588`	`"document": document["document"],`
`589`	`589`	`}`
`590`	`590`	`for document in request_obj`
Original file line number	Diff line number	Diff line change
`@@ -667,7 +667,7 @@ def test_scan_and_create_incidents_payload_structure(client: GGClient):`
`667`	`667`	`"documents": [`
`668`	`668`	`{`
`669`	`669`	`"document": DOCUMENT,`
`670`		`- "document_identifier": FILENAME,`
	`670`	`+ "filename": FILENAME,`
`671`	`671`	`}`
`672`	`672`	`],`
`673`	`673`	`"source_uuid": source_uuid,`