[SPIKE option C] Flatten Event; additive /edge (INTER-2457) by JuroUhlar · Pull Request #225 · fingerprintjs/python-sdk

JuroUhlar · 2026-08-31T16:08:45Z

SPIKE. Do not merge. Option C: Event stays a single model. Generated from openapi#465. Not the earlier all-SDK union spike (#224), which wraps Event in actual_instance.

Event is still one class: identification optional, source: Optional[EventSource].
Additive analyze_request_for_automation_intelligence → EventEdge, plus EdgeRequest.
sync.sh defaults to fingerprint-server-api-v4-flat.yaml (404 until the OpenAPI package publishes that file).

Known: Event field order

Generated field order follows flattened EventDevice (source moved down). Keyword construction and JSON are unchanged. Positional Event("id", 123, ...) would shift; almost all usage is keywords.

Huge Event.py diff

Mostly reorder plus /edge models. Getter/field names are the same set as main.

INTER-2457 option C. Event stays a single model; EventEdge is additive for POST /edge.

github-actions · 2026-08-31T17:58:06Z

☂️ Code Coverage

current status: ✅

Overall Coverage

Statements	Covered	Coverage	Threshold	Status
3446	2439	71%	0%	🟢

New Files

File	Coverage	Status
fingerprint_server_sdk/models/edge_request.py	58%	🟢
fingerprint_server_sdk/models/edge_request_headers_inner.py	61%	🟢
fingerprint_server_sdk/models/event_edge.py	66%	🟢
TOTAL	62%	🟢

Modified Files

File	Coverage	Status
fingerprint_server_sdk/init.py	100%	🟢
fingerprint_server_sdk/api/fingerprint_api.py	76%	🟢
fingerprint_server_sdk/models/init.py	100%	🟢
fingerprint_server_sdk/models/event.py	73%	🟢
TOTAL	87%	🟢

updated for commit: c93a704 by action🐍

Copilot

Pull request overview

This SPIKE regenerates the SDK from a flattened Event schema (single Event model with optional source) while adding an additive Automation Intelligence /edge endpoint with new request/response models and updated docs/schema.

Changes:

Added POST /edge endpoint (analyze_request_for_automation_intelligence) and new models EdgeRequest, EdgeRequestHeadersInner, and EventEdge.
Updated Event model ordering/fields to accommodate edge-derived data (e.g., ip_info, bot_info, vpn_methods) while keeping Event as one class.
Updated OpenAPI schema snapshot and generated documentation/README references; adjusted search_events query parameter ordering.

Reviewed changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
test/test_fingerprint_api.py	Keeps URL param serialization expectations aligned with updated query param ordering.
sync.sh	Switches default schema URL to the flattened Event spec (now points to `v4-flat`).
res/fingerprint-server-api.yaml	Adds `/edge` path + `EdgeRequest`/`EventEdge` schemas; updates docs links and query param ordering.
README.pypi.md	Documents the new `/edge` endpoint and new models.
README.md	Documents the new `/edge` endpoint and new models.
fingerprint_server_sdk/models/event.py	Reorders/extends flattened `Event` fields and serialization for edge-related nested models.
fingerprint_server_sdk/models/event_edge.py	Adds `EventEdge` response model for `/edge`.
fingerprint_server_sdk/models/edge_request.py	Adds `EdgeRequest` request model for `/edge`.
fingerprint_server_sdk/models/edge_request_headers_inner.py	Adds header-entry model used by `EdgeRequest.headers`.
fingerprint_server_sdk/models/init.py	Exports newly generated models.
fingerprint_server_sdk/api/fingerprint_api.py	Adds `/edge` client method and updates docstrings/query param ordering.
fingerprint_server_sdk/init.py	Re-exports newly generated models at package top level.
docs/FingerprintApi.md	Documents `/edge` endpoint; updates `get_event` and `search_events` docs.
docs/EventEdge.md	Adds documentation for `EventEdge`.
docs/Event.md	Updates flattened `Event` documentation to reflect edge-vs-device semantics.
docs/EdgeRequestHeadersInner.md	Adds documentation for header entry model.
docs/EdgeRequest.md	Adds documentation for `EdgeRequest`.
.openapi-generator/FILES	Includes the newly generated files in the generator manifest.

Suppressed comments (3)

fingerprint_server_sdk/api/fingerprint_api.py:635

EventDevice is referenced in this docstring, but the SDK does not define an EventDevice model. The method returns Event.

        Get a detailed analysis of an individual event, including Smart Signals.  Use `event_id` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `event_id`.  Returns `EventDevice` when `source` is `device`, and `EventEdge` when `source` is `edge`.

docs/FingerprintApi.md:212

This section says get_event returns EventDevice, but the SDK provides Event (single model) and does not define EventDevice.

Returns `EventDevice` when `source` is `device`, and `EventEdge` when `source` is `edge`.

fingerprint_server_sdk/api/fingerprint_api.py:710

EventDevice is referenced in this docstring, but the SDK does not define an EventDevice model. The method returns Event.

        Get a detailed analysis of an individual event, including Smart Signals.  Use `event_id` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `event_id`.  Returns `EventDevice` when `source` is `device`, and `EventEdge` when `source` is `edge`.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+# Create an instance of the API class
+api_instance = fingerprint_server_sdk.FingerprintApi(configuration)
+
+edge_request: EdgeRequest = fingerprint_server_sdk.EdgeRequest() # 


+    )
+    vpn_confidence: Optional[VpnConfidence] = None
+    vpn_methods: Optional[VpnMethods] = None
+    source: EventSource


+    @validate_call
+    def analyze_request_for_automation_intelligence(
+        self,
+        edge_request: EdgeRequest,
+        _request_timeout: Union[


+    ipv4_address: Optional[StrictStr] = Field(
+        default=None, description='Client IPv4 address observed by your server.'
+    )
+    ipv6_address: Optional[StrictStr] = Field(
+        default=None, description='Client IPv6 address observed by your server.'
+    )
+    linked_id: Optional[StrictStr] = Field(
+        default=None, description='A customer-provided id that was sent with the request.'
+    )
+    tags: Optional[dict[str, Any]] = Field(
+        default=None,
+        description='A customer-provided value or an object that was sent with the identification request or updated later.',
+    )
+    __properties: ClassVar[list[str]] = [


+schemaUrl="${1:-$defaultBaseUrl/schemas/fingerprint-server-api-v4-flat.yaml}"
 examplesBaseUrl="${2:-$defaultBaseUrl/examples}"


github-actions · 2026-08-31T18:25:56Z

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm exec changeset

to create a changeset.

JuroUhlar · 2026-08-31T18:29:59Z

@copilot review

…idation, sync.sh fallback, /edge tests Co-authored-by: JuroUhlar <11249993+JuroUhlar@users.noreply.github.com>

Copilot · 2026-08-31T18:37:00Z

@copilot review

Addressed the remaining unresolved review items in ecf38fc:

EventEdge.source is now Literal['edge'] matching the spec's const: edge, instead of the full EventSource enum.
EdgeRequest now validates that at least one of ipv4_address/ipv6_address is set.
sync.sh falls back to the existing v4 schema when the default flat schema URL 404s (only when no explicit URL argument is passed).
Added /edge unit tests (happy path + 400 error) with a mock response fixture.
Updated docs/EventEdge.md for the source field change.

Left the docs/FingerprintApi.md example calling EdgeRequest() without required args as-is, since it follows the same generated-doc pattern used for every other required-body model in that file (e.g. EventUpdate()), so it's a pre-existing generator limitation rather than something specific to this change.

JuroUhlar added 2 commits August 31, 2026 15:51

chore: generate flattened Event with optional source

a5a6d23

INTER-2457 option C. Event stays a single model; EventEdge is additive for POST /edge.

chore: sync from v4-flat schema

905e0b1

JuroUhlar mentioned this pull request Aug 31, 2026

[SPIKE option C] EventDevice | EventEdge union; flatten Event for most SDKs (INTER-2457) fingerprintjs/fingerprint-pro-server-api-openapi#465

Draft

JuroUhlar added 2 commits August 31, 2026 17:24

chore: sync schema with Event flatten x-platforms

3059ae4

test: match searchEvents query param order to generated SDK

04a4ab6

JuroUhlar requested a lite review from Copilot August 31, 2026 18:02

Copilot started reviewing on behalf of JuroUhlar August 31, 2026 18:02 View session

Copilot AI reviewed Aug 31, 2026

View reviewed changes

chore: sync schema get-event copy and EdgeRequest example

c93a704

Copilot started work on behalf of JuroUhlar August 31, 2026 18:30 View session

Address review feedback: EventEdge.source literal, EdgeRequest IP val…

ecf38fc

…idation, sync.sh fallback, /edge tests Co-authored-by: JuroUhlar <11249993+JuroUhlar@users.noreply.github.com>

Copilot finished work on behalf of JuroUhlar August 31, 2026 18:37

Navigation Menu

Uh oh!

[SPIKE option C] Flatten Event; additive /edge (INTER-2457) - #225

[SPIKE option C] Flatten Event; additive /edge (INTER-2457)#225
JuroUhlar wants to merge 6 commits into
mainfrom
spike/INTER-2457-option-c

JuroUhlar commented Aug 31, 2026 •

edited

Loading

github-actions Bot commented Aug 31, 2026 •

edited

Loading

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 31, 2026

JuroUhlar commented Aug 31, 2026

Copilot AI commented Aug 31, 2026

Labels

3 participants

		schemaUrl="${1:-$defaultBaseUrl/schemas/fingerprint-server-api-v4-flat.yaml}"
		examplesBaseUrl="${2:-$defaultBaseUrl/examples}"

Uh oh!

Conversation

JuroUhlar commented Aug 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Known: Event field order

Huge Event.py diff

github-actions Bot commented Aug 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☂️ Code Coverage

Overall Coverage

New Files

Modified Files

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Aug 31, 2026

JuroUhlar commented Aug 31, 2026

Copilot AI commented Aug 31, 2026

Labels

3 participants

JuroUhlar commented Aug 31, 2026 •

edited

Loading

github-actions Bot commented Aug 31, 2026 •

edited

Loading