fix: correcting resource id names#208
fix: correcting resource id names#208pengying wants to merge 1 commit into02-18-feat_fixing_transaction_schemafrom
Conversation
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
✱ Stainless preview buildsThis PR will update the kotlin openapi python typescript Edit this comment to update them. They will appear in their respective SDK's changelogs. ✅ grid-python studio · code · diff
✅ grid-typescript studio · code · diff
✅ grid-kotlin studio · code · diff
This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push. |
Greptile SummaryStandardizes identifier field names from resource-specific names ( Key changes:
Critical issue found:
Confidence Score: 2/5
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/quotes/Quote.yaml | Renamed quoteId to id for consistency with API naming conventions |
| openapi/components/schemas/customers/BulkCustomerImportJob.yaml | Renamed jobId to id to standardize identifier field naming |
| openapi/components/schemas/webhooks/BaseWebhook.yaml | Renamed webhookId to id for uniform resource identification pattern |
| openapi/webhooks/outgoing-payment.yaml | Webhook examples still use old webhookId field name instead of id |
| openapi/webhooks/test-webhook.yaml | Webhook example still uses old webhookId field name instead of id |
| openapi/webhooks/kyc-status.yaml | Webhook example still uses old webhookId field name instead of id |
| openapi/webhooks/invitation-claimed.yaml | Webhook example still uses old webhookId field name instead of id |
| openapi/webhooks/incoming-payment.yaml | Webhook examples still use old webhookId field name instead of id |
| openapi/webhooks/bulk-upload.yaml | Webhook examples still use old webhookId field name instead of id |
| openapi/webhooks/account-status.yaml | Webhook example still uses old webhookId field name instead of id |
Last reviewed commit: b804868
There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 86
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 121
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/test-webhook.yaml
Line: 49
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/kyc-status.yaml
Line: 63
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/invitation-claimed.yaml
Line: 72
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/incoming-payment.yaml
Line: 100
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/incoming-payment.yaml
Line: 126
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 55
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 77
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
needs to be id not webhookId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/account-status.yaml
Line: 69
Comment:
needs to be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
TL;DR
Standardized ID field names across API schemas by renaming specific identifier fields to simply
id.What changed?
Renamed identifier fields in three schema components to follow a consistent naming pattern:
quoteIdtoidin the Quote schemajobIdtoidin the BulkCustomerImportJob schemawebhookIdtoidin the BaseWebhook schemaThese changes were applied to both the combined OpenAPI file and the individual component files.
How to test?
Why make this change?
This change standardizes our API response format by using consistent field naming conventions across all resources. Having a uniform
idfield instead of resource-specific identifiers (quoteId,jobId,webhookId) makes the API more intuitive and easier to work with for developers.