chore: update v3 OpenAPI specs to v3.638.0#14
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Smile Identity v3 OpenAPI spec set to v3.638.0 by removing the legacy Block User spec and introducing the new Report User Fraud endpoint, plus adding a missingCallbackUrl 400-error example across several verification specs.
Changes:
- Remove
v3-block-userspec and replace it with the newv3-report-user-fraudspec/endpoint. - Add
missingCallbackUrlexample to 400 responses in multiple verification-related specs. - Update rendered docs and README endpoint table to reflect the new spec set.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| CHANGELOG.md | Adds v3.638.0 entry documenting spec changes/removal (needs a small correction re: “Added” vs “Changed”). |
| README.md | Updates endpoint/spec table to replace Block User with Report User Fraud. |
| docs/index.html | Updates Redoc spec list to remove Block User and add Report User Fraud. |
| specs/v3/v3-biometric-authentication-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-biometric-enrollment-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-biometric-kyc-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-document-verification-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-enhanced-document-verification-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-enhanced-kyc-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-smart-selfie-compare-entry.yaml | Adds missingCallbackUrl 400-response example. |
| specs/v3/v3-report-user-fraud.yaml | Introduces the new fraud reporting endpoint/specification. |
| specs/v3/v3-block-user.yaml | Removes the legacy Block User API specification. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Changed | ||
| - Updated `v3-biometric-authentication-entry` | ||
| - Updated `v3-biometric-enrollment-entry` | ||
| - Updated `v3-biometric-kyc-entry` | ||
| - Updated `v3-document-verification-entry` | ||
| - Updated `v3-enhanced-document-verification-entry` | ||
| - Updated `v3-enhanced-kyc-entry` | ||
| - Updated `v3-report-user-fraud` | ||
| - Updated `v3-smart-selfie-compare-entry` | ||
|
|
||
| ### Removed | ||
| - `v3-block-user` |
| missingNotesOnUnblock: | ||
| summary: Missing notes when clearing | ||
| value: |
User description
Automated v3 OpenAPI spec update for v3.638.0.
PR Type
Enhancement
Description
Replace
v3-block-userAPI with newv3-report-user-fraudendpointAdd
missingCallbackUrlerror example to multiple verification specsNew fraud reporting supports structured reasons and email-based attribution
Diagram Walkthrough
File Walkthrough
3 files
Add v3.638.0 changelog with updated and removed specsReplace Block User with Report User Fraud in API tableUpdate spec list: remove block-user, add report-user-fraud9 files
Add missingCallbackUrl error example to 400 responseAdd missingCallbackUrl error example to 400 responseAdd missingCallbackUrl error example to 400 responseRemove entire Block User API specificationAdd missingCallbackUrl error example to 400 responseAdd missingCallbackUrl error example to 400 responseAdd missingCallbackUrl error example to 400 responseAdd new Report User Fraud API specificationAdd missingCallbackUrl error example to 400 response