chore: update v3 OpenAPI specs to v3.634.0#10
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
| format: email | ||
| description: Email address of the person submitting the report. | ||
| example: risk@partner.example | ||
| additionalProperties: true |
There was a problem hiding this comment.
Suggestion: Setting additionalProperties: true explicitly allows arbitrary fields in the request body, which could let clients send unexpected or malicious data that bypasses validation. This should likely be false to enforce a strict schema, consistent with the removed v3-block-user.yaml which used additionalProperties: false. [security, importance: 7]
| additionalProperties: true | |
| additionalProperties: false |
There was a problem hiding this comment.
Pull request overview
Updates the Smile Identity v3 OpenAPI reference to API version v3.634.0 by replacing the deprecated Block User spec with a new Report User Fraud endpoint and updating the rendered docs/index and changelog accordingly.
Changes:
- Added a new spec for
POST /v3/users/{user_id}/report_fraud(async202 Accepted) with structured fraud reporting fields. - Removed the
v3-block-userOpenAPI spec and updated the docs UI + README endpoint table to reflect the replacement. - Added a
v3.634.0entry to the changelog documenting the addition/removal.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
specs/v3/v3-report-user-fraud.yaml |
Adds the new “Report User Fraud” OpenAPI spec and endpoint definition. |
specs/v3/v3-block-user.yaml |
Deletes the deprecated “Block User” OpenAPI spec. |
README.md |
Updates the endpoints table to remove “Block User” and add “Report User Fraud”. |
docs/index.html |
Updates the Redoc spec picker list to remove the old spec and include the new one. |
CHANGELOG.md |
Adds a v3.634.0 changelog entry noting the spec update/removal. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The response is `202 Accepted` once the request has been validated | ||
| and handled. |
User description
Automated v3 OpenAPI spec update for v3.634.0.
PR Type
Enhancement
Description
Replace
v3-block-userAPI with newv3-report-user-fraudendpointNew endpoint at
POST /v3/users/{user_id}/report_fraudwith structured fraud reasonsAdds required fields:
is_fraud,reasonenum,reported_byemailReturns
202 Acceptedinstead of200 OKfor async processingDiagram Walkthrough
flowchart LR Old["v3-block-user (removed)"] New["v3-report-user-fraud (added)"] Endpoint["POST /v3/users/{user_id}/report_fraud"] Old -- "replaced by" --> New New -- "defines" --> EndpointFile Walkthrough
CHANGELOG.md
Add v3.634.0 changelog entryCHANGELOG.md
v3-report-user-fraudupdate andv3-block-userremovalREADME.md
Update API table with new endpointREADME.md
Block Userrow from API tableReport User Fraudrow with new endpoint path and descriptionindex.html
Update docs spec listdocs/index.html
v3-block-userfrom SPECS listv3-report-user-fraudto SPECS list for documentation UIv3-block-user.yaml
Remove Block User OpenAPI specspecs/v3/v3-block-user.yaml
specification
v3-report-user-fraud.yaml
Add Report User Fraud OpenAPI specspecs/v3/v3-report-user-fraud.yaml
POST /v3/users/{user_id}/report_fraudReportUserFraudRequestwith requiredis_fraud,reported_by,and conditional
reason/notesfieldsFIRST_PARTY_FRAUD,SYNTHETIC_IDENTITY,OTHER)202 AcceptedwithReportUserFraudAcceptedResponseschema