feat: cleaning up webhooks #212
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| type: string | ||
| enum: | ||
| - TRANSACTIONS_INCOMING_PAYMENT | ||
| - TRANSACTIONS_OUTGOING_PAYMENT | ||
| - TEST | ||
| - BULK_UPLOAD | ||
| - UMA_INVITATION_CLAIMED | ||
| - CUSTOMERS_KYC_UPDATE | ||
| - INTERNAL_ACCOUNTS_BALANCE_UPDATE | ||
|
Comment on lines
1
to
+9
Contributor
There was a problem hiding this comment. Webhook endpoint example payloads still use old type names. These files need updating:
After running Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/components/schemas/webhooks/WebhookType.yaml
Line: 1-9
Comment:
Webhook endpoint example payloads still use old type names. These files need updating:
- `openapi/webhooks/incoming-payment.yaml` lines 101, 127: `type: INCOMING_PAYMENT`
- `openapi/webhooks/outgoing-payment.yaml` lines 87, 122: `type: OUTGOING_PAYMENT`
- `openapi/webhooks/invitation-claimed.yaml` line 73: `type: INVITATION_CLAIMED`
- `openapi/webhooks/kyc-status.yaml` line 61: `type: KYC_STATUS`
- `openapi/webhooks/account-status.yaml` line 70: `type: ACCOUNT_STATUS`
After running `make build`, these will propagate to the bundled spec.
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
1
to
+9
Contributor
There was a problem hiding this comment. Documentation in Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/components/schemas/webhooks/WebhookType.yaml
Line: 1-9
Comment:
Documentation in `mintlify/ramps/platform-tools/webhooks.mdx` still references old webhook type names (`OUTGOING_PAYMENT`, `ACCOUNT_STATUS`, `KYC_STATUS`) in code examples on lines 17, 41, 50, 66, 75, and 81. These need updating to match the new naming convention.
How can I resolve this? If you propose a fix, please make it concise.
Comment on lines
1
to
+9
Contributor
There was a problem hiding this comment. This is a breaking change for existing webhook consumers. Verify that backend services parsing the Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/components/schemas/webhooks/WebhookType.yaml
Line: 1-9
Comment:
This is a breaking change for existing webhook consumers. Verify that backend services parsing the `type` field are updated to handle new names, and check if a migration path exists for existing webhook subscriptions.
How can I resolve this? If you propose a fix, please make it concise. |
||
| description: >- | ||
| Type of webhook event, used by the receiver to identify which webhook is being | ||
| received | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The enum values have been renamed but the examples in webhook schema files still reference old names. This creates inconsistency:
openapi/components/schemas/webhooks/IncomingPaymentWebhook.yaml:12hasexample: INCOMING_PAYMENTopenapi/components/schemas/webhooks/OutgoingPaymentWebhook.yaml:12hasexample: OUTGOING_PAYMENTopenapi/components/schemas/webhooks/InvitationClaimedWebhook.yaml:11hasenum: [INVITATION_CLAIMED]These must be updated to match the new enum values or the OpenAPI spec will be invalid.
Prompt To Fix With AI