Skip to content

[api-v3] Update schema to v3.5.2 - #210

Merged
erayaydin merged 3 commits into
api-v3from
feat/update-schema-v3.5.2
Aug 5, 2026
Merged

[api-v3] Update schema to v3.5.2#210
erayaydin merged 3 commits into
api-v3from
feat/update-schema-v3.5.2

Conversation

@erayaydin

@erayaydin erayaydin commented Aug 3, 2026

Copy link
Copy Markdown
Member

Update Server API schema version to v3.5.2.

@erayaydin
erayaydin requested a review from Copilot August 3, 2026 14:02
@erayaydin erayaydin self-assigned this Aug 3, 2026
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
6276 5272 84% 0% 🟢

New Files

File Coverage Status
fingerprint_pro_server_api_sdk/models/labels.py 100% 🟢
fingerprint_pro_server_api_sdk/models/labels_inner.py 100% 🟢
fingerprint_pro_server_api_sdk/models/product_labels.py 93% 🟢
fingerprint_pro_server_api_sdk/models/product_rare_device.py 63% 🟢
fingerprint_pro_server_api_sdk/models/rare_device.py 55% 🟢
fingerprint_pro_server_api_sdk/models/webhook_rare_device.py 55% 🟢
TOTAL 78% 🟢

Modified Files

File Coverage Status
fingerprint_pro_server_api_sdk/init.py 100% 🟢
fingerprint_pro_server_api_sdk/api/fingerprint_api.py 91% 🟢
fingerprint_pro_server_api_sdk/models/init.py 100% 🟢
fingerprint_pro_server_api_sdk/models/developer_tools.py 95% 🟢
fingerprint_pro_server_api_sdk/models/products.py 99% 🟢
fingerprint_pro_server_api_sdk/models/proxy.py 96% 🟢
fingerprint_pro_server_api_sdk/models/proxy_details.py 94% 🟢
fingerprint_pro_server_api_sdk/models/vpn.py 90% 🟢
fingerprint_pro_server_api_sdk/models/vpn_methods.py 91% 🟢
fingerprint_pro_server_api_sdk/models/webhook.py 49% 🟢
fingerprint_pro_server_api_sdk/models/webhook_developer_tools.py 68% 🟢
fingerprint_pro_server_api_sdk/models/webhook_proxy.py 56% 🟢
fingerprint_pro_server_api_sdk/models/webhook_vpn.py 53% 🟢
TOTAL 83% 🟢

updated for commit: ed4ca07 by action🐍

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the bundled Server API v3 schema (api-v3) to v3.5.2 and regenerates the Python SDK models/docs to include newly added Smart Signals and ML-derived fields.

Changes:

  • Adds Rare Device Smart Signal support (schema, query filters, models, webhook support, docs).
  • Adds ML-based scoring fields for VPN/Proxy and a new VPN detection method flag (mlPrediction).
  • Introduces a new Labels Smart Signal schema and generated SDK surface/docs entries.

Reviewed changes

Copilot reviewed 38 out of 38 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
res/fingerprint-server-api.yaml Updates OpenAPI schema with RareDevice/Labels, new filters, and ML score fields.
README.md Adds new model documentation links for Labels/RareDevice-related types.
fingerprint_pro_server_api_sdk/models/webhook.py Exposes rare_device on the Webhook model.
fingerprint_pro_server_api_sdk/models/webhook_vpn.py Adds ml_score to webhook VPN payload model.
fingerprint_pro_server_api_sdk/models/webhook_rare_device.py New webhook model for Rare Device payload.
fingerprint_pro_server_api_sdk/models/webhook_proxy.py Adds ml_score to webhook proxy payload model.
fingerprint_pro_server_api_sdk/models/webhook_developer_tools.py Updates Developer Tools description text.
fingerprint_pro_server_api_sdk/models/vpn.py Adds ml_score to VPN model.
fingerprint_pro_server_api_sdk/models/vpn_methods.py Adds ml_prediction to VPNMethods model.
fingerprint_pro_server_api_sdk/models/rare_device.py New model for Rare Device data returned in Products.
fingerprint_pro_server_api_sdk/models/proxy.py Adds ml_score to Proxy model.
fingerprint_pro_server_api_sdk/models/proxy_details.py Adds unknown proxy type and updates description/validation.
fingerprint_pro_server_api_sdk/models/products.py Adds rare_device and labels to Products model.
fingerprint_pro_server_api_sdk/models/product_rare_device.py New wrapper model for Rare Device product (data/error).
fingerprint_pro_server_api_sdk/models/product_labels.py New wrapper model for Labels product (data/error).
fingerprint_pro_server_api_sdk/models/labels.py New model placeholder representing Labels array schema.
fingerprint_pro_server_api_sdk/models/labels_inner.py New model for individual label entries (label/prediction/ml_score).
fingerprint_pro_server_api_sdk/models/developer_tools.py Updates Developer Tools description text.
fingerprint_pro_server_api_sdk/models/init.py Exports new models (Labels, RareDevice, Product* additions, webhook rare device).
fingerprint_pro_server_api_sdk/api/fingerprint_api.py Adds search filters for rare device and percentile bucket to API client.
fingerprint_pro_server_api_sdk/init.py Exports new models at package root.
docs/WebhookVPN.md Documents ml_score on WebhookVPN.
docs/WebhookRareDevice.md New docs for WebhookRareDevice model.
docs/WebhookProxy.md Documents ml_score on WebhookProxy.
docs/WebhookDeveloperTools.md Updates Developer Tools description in docs.
docs/Webhook.md Adds rare_device to Webhook model docs.
docs/VPNMethods.md Documents ml_prediction on VPNMethods.
docs/VPN.md Documents ml_score on VPN.
docs/RareDevice.md New docs for RareDevice model.
docs/ProxyDetails.md Updates ProxyDetails description to mention unknown.
docs/Proxy.md Documents ml_score on Proxy.
docs/Products.md Adds rare_device and labels to Products docs.
docs/ProductRareDevice.md New docs for ProductRareDevice wrapper model.
docs/ProductLabels.md New docs for ProductLabels wrapper model.
docs/LabelsInner.md New docs for LabelsInner item model.
docs/Labels.md New docs placeholder for Labels array schema.
docs/FingerprintApi.md Documents new search filters for rare device and percentile bucket.
docs/DeveloperTools.md Updates Developer Tools description in docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread res/fingerprint-server-api.yaml
Comment thread res/fingerprint-server-api.yaml
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

🚀 Following releases will be created using changesets from this PR:

fingerprint-pro-server-api-python-sdk@8.14.0

Minor Changes

  • Update Server API schema to v3.5.2:

    • events: Add labels field with machine learning based predictions for specific use cases (beta).
    • events: Add rareDevice Smart Signal with result and percentileBucket.
    • events-search: Add rare_device and rare_device_percentile_bucket filters.
    • events: Add mlScore fields to the VPN and Proxy signals, and mlPrediction to VPNMethods (beta).
    • events: Add the unknown value to the ProxyDetails proxyType field for proxies detected solely by the ML model.
    • Clarify the DeveloperTools signal description to note it also covers Android/iOS devices. (ed4ca07)

Patch Changes

  • events: Fix parsing of GeolocationSubdivisions so subdivisions returns a typed list of GeolocationSubdivision (8dd9ef4)

@erayaydin
erayaydin requested a review from Copilot August 5, 2026 08:12
@erayaydin
erayaydin marked this pull request as ready for review August 5, 2026 08:12

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 41 out of 41 changed files in this pull request and generated no new comments.

Suppressed comments (3)

docs/WebhookRareDevice.md:6

  • > appears mid-sentence in the Markdown table cell (likely leaked from the OpenAPI blockquote formatting), which can render oddly inside tables. Consider removing the > so the description reads normally.
**result** | **bool** | `true` if the device is considered rare based on its combination of hardware and software attributes.  A device is classified as rare if it falls within the top 99.9 percentile (lowest-frequency segment) of observed traffic,  or if its configuration has not been previously seen (`not_seen`). > This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).  | [optional] 

test/test_fingerprint_api.py:298

  • This test adds coverage for products.labels, but other newly introduced schema fields in this PR (e.g., products.rareDevice, vpn.mlScore, proxy.mlScore, and VPNMethods.mlPrediction) are not exercised by the mocks/assertions. Consider extending the existing get_event_200 mock + assertions here to validate deserialization and to_dict() output for those fields as well.
    fingerprint_pro_server_api_sdk/api/fingerprint_api.py:731
  • New rare_device / rare_device_percentile_bucket query params were added to search_events, but there’s no unit test asserting that these parameters are serialized with the correct names/values (similar to how other filters are covered in test_search_events_full_params). Adding them to the existing full-params test would catch regressions in query param naming/encoding.
        if 'rare_device' in params:
            query_params.append(('rare_device', params['rare_device']))  # noqa: E501
        if 'rare_device_percentile_bucket' in params:
            query_params.append(('rare_device_percentile_bucket', params['rare_device_percentile_bucket']))  # noqa: E501

@erayaydin
erayaydin merged commit f4dd2df into api-v3 Aug 5, 2026
23 checks passed
@erayaydin
erayaydin deleted the feat/update-schema-v3.5.2 branch August 5, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants