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-typescript studio · code · diff
✅ grid-python 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 SummaryRenamed identifier fields to standardize on Major issues found:
Confidence Score: 2/5
|
| Filename | Overview |
|---|---|
| openapi/components/schemas/quotes/Quote.yaml | Renamed quoteId to id in schema definition and required fields |
| openapi/components/schemas/customers/BulkCustomerImportJob.yaml | Renamed jobId to id in schema definition and required fields |
| openapi/components/schemas/webhooks/BaseWebhook.yaml | Renamed webhookId to id in schema definition and required fields |
| openapi.yaml | Applied all three ID field renamings in combined OpenAPI spec |
| mintlify/openapi.yaml | Applied all three ID field renamings in Mintlify OpenAPI spec |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Schema Components] --> B[Quote.yaml]
A --> C[BulkCustomerImportJob.yaml]
A --> D[BaseWebhook.yaml]
B --> E[quoteId → id]
C --> F[jobId → id]
D --> G[webhookId → id]
E --> H[openapi.yaml]
F --> H
G --> H
E --> I[mintlify/openapi.yaml]
F --> I
G --> I
H -.-> J[Webhook Examples]
I -.-> J
J --> K[bulk-upload.yaml]
J --> L[outgoing-payment.yaml]
J --> M[incoming-payment.yaml]
J --> N[Other webhook files]
K -.NOT UPDATED.-> O[Still uses jobId, webhookId]
L -.NOT UPDATED.-> P[Still uses quoteId, webhookId]
M -.NOT UPDATED.-> Q[Still uses webhookId]
N -.NOT UPDATED.-> R[Still uses webhookId]
style O fill:#f88
style P fill:#f88
style Q fill:#f88
style R fill:#f88
Last reviewed commit: 2d628a2
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
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.
pengying
force-pushed
the
02-18-feat_fixing_transaction_schema
branch
from
36ee105 to
c774ff0
Compare
pengying
force-pushed
the
02-18-fix_correcting_resource_id_names
branch
from
b804868 to
2cc78d7
Compare
![restamp-bot[bot]](https://avatars.githubusercontent.com/u/103385173?s=60&v=4){kind=small}
There was a problem hiding this comment.
needs to be id not quoteId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 72
Comment:
needs to be `id` not `quoteId`
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: 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 quoteId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 107
Comment:
needs to be `id` not `quoteId`
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 jobId
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 47
Comment:
needs to be `id` not `jobId`
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/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.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.
pengying
force-pushed
the
02-18-feat_fixing_transaction_schema
branch
from
c774ff0 to
eb98c72
Compare
pengying
force-pushed
the
02-18-fix_correcting_resource_id_names
branch
from
2cc78d7 to
dd4ab48
Compare
Additional Comments (21)
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 139
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 96
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/incoming-payment.yaml
Line: 177
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/account-status.yaml
Line: 88
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/test-webhook.yaml
Line: 69
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/kyc-status.yaml
Line: 81
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/invitation-claimed.yaml
Line: 90
Comment:
Update error description to reference `id` instead of `webhookId`
```suggestion
description: Conflict - Webhook has already been processed (duplicate id)
```
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 72
Comment:
Should be `id` not `quoteId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 86
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 107
Comment:
Should be `id` not `quoteId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 121
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 47
Comment:
Should be `id` not `jobId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 55
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 62
Comment:
Should be `id` not `jobId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 77
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/incoming-payment.yaml
Line: 100
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/incoming-payment.yaml
Line: 126
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/account-status.yaml
Line: 69
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/test-webhook.yaml
Line: 49
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/kyc-status.yaml
Line: 63
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/invitation-claimed.yaml
Line: 72
Comment:
Should be `id` not `webhookId`
How can I resolve this? If you propose a fix, please make it concise. |
pengying
force-pushed
the
02-18-feat_fixing_transaction_schema
branch
from
eb98c72 to
8ad3ce8
Compare
pengying
force-pushed
the
02-18-fix_correcting_resource_id_names
branch
from
dd4ab48 to
2d628a2
Compare
Additional Comments (14)
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 47
Comment:
needs to be `id` not `jobId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/bulk-upload.yaml
Line: 62
Comment:
needs to be `id` not `jobId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 72
Comment:
needs to be `id` not `quoteId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis is a comment left during a code review.
Path: openapi/webhooks/outgoing-payment.yaml
Line: 107
Comment:
needs to be `id` not `quoteId`
How can I resolve this? If you propose a fix, please make it concise.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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.
Prompt To Fix With AIThis 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. |
2 participants
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.