Skip to content

[api-v3] Update Server API schema version v3.5.2 - #262

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

[api-v3] Update Server API schema version v3.5.2#262
erayaydin merged 5 commits into
api-v3from
feat/update-schema-v3.5.2

Conversation

@erayaydin

@erayaydin erayaydin commented Jul 31, 2026

Copy link
Copy Markdown
Member

Update the schema file to the Server API schema version 3.5.2.

@github-actions

Copy link
Copy Markdown
Contributor

🟢 Coverage increased by 34.66%

Code Coverage Report

Coverage Report

St. Category Percentage Covered / Total
🔴 Statements 34.66% 1884 / 5435
🔴 Functions 26.74% 675 / 2524
Files Coverage
St. File Methods Statements Total Coverage
🔴 src/Model/BotdBotResult.php 0.00% 0.00% 0.00%
🔴 src/Model/ErrorCode.php 0.00% 0.00% 0.00%
🔴 src/Model/ModelInterface.php 0.00% 0.00% 0.00%
🔴 src/Model/ProxyConfidence.php 0.00% 0.00% 0.00%
🔴 src/Model/VPNConfidence.php 0.00% 0.00% 0.00%

@erayaydin erayaydin changed the title Update Server API OAS schema to v3.5.2 [api-v3] Update Server API OAS schema to v3.5.2 Jul 31, 2026

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 embedded Fingerprint Server API v3 OpenAPI schema and regenerates the PHP SDK artifacts to match schema version v3.5.2, including new ML-based smart signals, a new Labels smart signal, and an expanded proxy type enum.

Changes:

  • Add ML-based fields: mlScore on VPN/Proxy (and webhook counterparts) and mlPrediction on VPNMethods.
  • Add unknown as an allowed ProxyDetails.proxyType value and update related docs.
  • Add Labels smart signal (Products.labels / ProductLabels) plus generator mapping/ignore updates and documentation updates.

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/Model/WebhookVPN.php Adds ml_score field + accessors for webhook VPN payloads.
src/Model/WebhookProxy.php Adds ml_score field + accessors for webhook proxy payloads.
src/Model/WebhookDeveloperTools.php Updates DevTools result description to include iOS.
src/Model/VPNMethods.php Adds ml_prediction field + accessors to VPN methods.
src/Model/VPN.php Adds ml_score field + accessors to VPN model.
src/Model/ProxyDetails.php Adds unknown proxy type and updates description.
src/Model/Proxy.php Adds ml_score field + accessors to proxy model.
src/Model/Products.php Adds labels product field wired to ProductLabels.
src/Model/ProductLabels.php Introduces new ProductLabels model (data + error wrapper).
src/Model/DeveloperTools.php Updates DevTools result description to include iOS.
scripts/generate.sh Updates codegen type mapping and README cleanup patterns for Labels.
res/fingerprint-server-api.yaml Schema updates for ML fields, Labels, proxy type enum, and DevTools copy.
README.md Adds ProductLabels to the documented model list.
docs/Model/WebhookVPN.md Documents ml_score on webhook VPN model.
docs/Model/WebhookProxy.md Documents ml_score on webhook proxy model.
docs/Model/WebhookDeveloperTools.md Updates DevTools description (Android/iOS).
docs/Model/VPNMethods.md Documents ml_prediction on VPNMethods.
docs/Model/VPN.md Documents ml_score on VPN model.
docs/Model/ProxyDetails.md Updates proxy type description (includes unknown).
docs/Model/Proxy.md Documents ml_score on Proxy model.
docs/Model/Products.md Documents new labels field on Products.
docs/Model/ProductLabels.md Adds documentation for ProductLabels.
docs/Model/DeveloperTools.md Updates DevTools description (Android/iOS).
.swagger-codegen-ignore Ignores generated Labels/LabelsInner docs/models (mapped to arrays).
.schema-version Bumps tracked schema version to v3.5.2.
.changeset/add-unknown-proxy-type.md Declares a minor release for the new proxy type enum value.
.changeset/add-ml-smart-signals.md Declares a minor release for new ML smart signals.
.changeset/add-labels-smart-signal.md Declares a minor release for Labels smart signal support.

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

Comment thread .schema-version
@erayaydin erayaydin changed the title [api-v3] Update Server API OAS schema to v3.5.2 [api-v3] Update Server API schema version v3.5.2 Jul 31, 2026
@erayaydin
erayaydin marked this pull request as ready for review July 31, 2026 19:31
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

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

fingerprint-pro-server-api-php-sdk@6.12.0

Minor Changes

  • Add the Labels Smart Signal. The Products response now exposes a labels field (ProductLabels) whose data is an array of label predictions (label, prediction, mlScore). (7564735)
  • Add machine learning-based Smart Signals from the Server API schema: mlScore on the VPN and Proxy results (and their webhook counterparts), and mlPrediction on VPNMethods. These signals are in beta and only available to select customers. (9253a67)
  • Add the unknown value to the ProxyDetails proxyType field. (c748eff)

@erayaydin
erayaydin merged commit d34b8cf into api-v3 Aug 4, 2026
18 checks passed
@erayaydin
erayaydin deleted the feat/update-schema-v3.5.2 branch August 4, 2026 13:53
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