Skip to content

fix: correcting resource id names#208

Open
pengying wants to merge 1 commit into02-18-feat_fixing_transaction_schemafrom
02-18-fix_correcting_resource_id_names
Open

fix: correcting resource id names#208
pengying wants to merge 1 commit into02-18-feat_fixing_transaction_schemafrom
02-18-fix_correcting_resource_id_names

Conversation

@pengying
Copy link
Contributor

@pengying pengying commented Feb 19, 2026

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:

  • Changed quoteId to id in the Quote schema
  • Changed jobId to id in the BulkCustomerImportJob schema
  • Changed webhookId to id in the BaseWebhook schema

These changes were applied to both the combined OpenAPI file and the individual component files.

How to test?

  1. Verify that the API documentation renders correctly with the updated field names
  2. Ensure that any client code using these schemas is updated to reference the new field names
  3. Confirm that API responses match the updated schema definitions

Why make this change?

This change standardizes our API response format by using consistent field naming conventions across all resources. Having a uniform id field instead of resource-specific identifiers (quoteId, jobId, webhookId) makes the API more intuitive and easier to work with for developers.

@pengying pengying marked this pull request as ready for review February 19, 2026 02:03
Copy link
Contributor Author

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.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions
Copy link

github-actions bot commented Feb 19, 2026

✱ Stainless preview builds

This PR will update the grid SDKs with the following commit messages.

kotlin

fix(api): rename jobId/quoteId/webhookId to id in quotes/webhooks/bulk

openapi

fix(types): rename quoteId/jobId/webhookId to id in Quote/BulkCustomerImportJob/Webhook

python

fix(types): rename quote_id/webhook_id/job_id to id across models

typescript

fix(api): rename ID fields to id in quotes, bulk status, and webhook events

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-openapi studio · code · diff

Your SDK built successfully.
generate ✅

grid-python studio · code · diff

Your SDK built successfully.
generate ✅build ✅lint ✅test ✅

pip install https://pkg.stainless.com/s/grid-python/c8100ecc5f38f0d5249613f3858cb0d6e490ee09/grid-0.0.1-py3-none-any.whl
grid-typescript studio · code · diff

Your SDK built successfully.
generate ✅build ✅lint ✅test ✅

npm install https://pkg.stainless.com/s/grid-typescript/ec4dd60b6b53ad1331eb53ca0e50f9b4b5755e14/dist.tar.gz
grid-kotlin studio · code · diff

Your SDK built successfully.
generate ✅build ✅lint ✅test ✅


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-02-19 02:09:56 UTC

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 19, 2026

Greptile Summary

Standardizes identifier field names from resource-specific names (quoteId, jobId, webhookId) to a uniform id field across three schema components: Quote, BulkCustomerImportJob, and BaseWebhook.

Key changes:

  • Updated schema definitions in component files and bundled OpenAPI specs
  • Makes API more intuitive by using consistent id field naming

Critical issue found:

  • All webhook example YAML files (7 files) still use webhookId in their example data instead of the new id field name, causing schema-example mismatch

Confidence Score: 2/5

  • This PR has incomplete schema changes that will cause validation errors
  • While the schema definitions were correctly updated in the component files and bundled specs, all 7 webhook example files still reference the old webhookId field name. This creates a mismatch between the schema (which expects id) and the examples (which show webhookId), which will cause validation failures and confusion for API consumers
  • All webhook files in openapi/webhooks/ directory require updating their example data to use id instead of webhookId

Important Files Changed

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

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 files reviewed, 10 comments

Edit Code Review Agent Settings | Greptile

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments