chore(vtex): regenerate client from current upstream schemas - #524
Closed
guitavano wants to merge 1 commit into
Closed
chore(vtex): regenerate client from current upstream schemas#524guitavano wants to merge 1 commit into
guitavano wants to merge 1 commit into
Conversation
Regenerates the hey-api client from the latest VTEX OpenAPI schemas.
Upstream renamed several operations and removed two; this reconciles the
tool registry so no tool references a now-undefined SDK export.
Renamed operations (registry references updated):
- punchout: {get,post}ApiAuthenticatorPunchout* -> *V1Punchout*
- vtex-id: postApiAuthenticatorStorefrontUsers -> *V1StorefrontUsers
- delivery-promise-notification: {put,patch}DeliveryPromisesExternalSellers*
-> {put,patch}ApiDeliveryPromisesExternalSellers*
Removed tools (endpoints no longer in upstream schemas):
- VTEX_GET_ROLES_BY_USER2 (getRolesbyUser2) — alternate endpoint dropped;
VTEX_GET_ROLES_BY_USER (getRolesbyUser) remains.
- VTEX_ORDER_CHANGES_POST_CHANGE (postOrderChanges) — removed from the
pick-and-pack-order-changes schema.
Prereq for enabling zod metadata (param descriptions): doing that regen on
top of a current client yields a description-only diff. Build is warning-free;
all 104 tests pass. metadata stays false here (no bundle change).
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Author
|
Consolidado no #525 (PR único). O commit de sync do client está incluído lá. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Regenerates the hey-api client from the current VTEX OpenAPI schemas. The committed client had drifted from upstream; regenerating surfaced 8 operations that VTEX renamed or removed. This reconciles the tool registry so no tool points at a now-undefined SDK export.
Why now
This is the prerequisite for enabling Zod metadata (param descriptions — the actual goal). Doing the
metadata: trueregen on top of an already-current client produces a clean, description-only diff instead of mixing in this schema drift. So: sync first (this PR), flip metadata second (follow-up PR).Changes
Renamed operations (registry references updated, pure renames):
punchout:{get,post}ApiAuthenticatorPunchout*→*V1Punchout*vtex-id:postApiAuthenticatorStorefrontUsers→postApiAuthenticatorV1StorefrontUsersdelivery-promise-notification:{put,patch}DeliveryPromisesExternalSellers*→{put,patch}ApiDeliveryPromisesExternalSellers*Removed tools (endpoints no longer present upstream):
VTEX_GET_ROLES_BY_USER2(getRolesbyUser2) — the alternate endpoint was dropped;VTEX_GET_ROLES_BY_USER(getRolesbyUser) stays.VTEX_ORDER_CHANGES_POST_CHANGE(postOrderChanges) — removed from thepick-and-pack-order-changesschema.Also pulls in new upstream modules (b2b-addresses, bulk-pricing, etc.) as generated code.
Verification
metadatastaysfalsehere → bundle unchanged (~4.70 MB). The +301 KB gzip cost lands in the follow-up metadata PR.🤖 Generated with Claude Code
Summary by cubic
Regenerated the VTEX SDK from the latest upstream OpenAPI schemas to remove drift, update renamed endpoints, and add new modules. This unblocks enabling Zod metadata next, removes old build warnings, keeps tests green, and leaves the bundle size unchanged.
Refactors
{get,post}ApiAuthenticatorPunchout*→*V1Punchout*postApiAuthenticatorStorefrontUsers→postApiAuthenticatorV1StorefrontUsers{put,patch}DeliveryPromisesExternalSellers*→{put,patch}ApiDeliveryPromisesExternalSellers*assortmentIds(replacescollectionIds).Migration
VTEX_GET_ROLES_BY_USER2,VTEX_ORDER_CHANGES_POST_CHANGE.PUTrequest body is now an array of items; base URL no longer includes/apiif using a custom client.collectionIdswithassortmentIdsin request/response handling.Written for commit c57c19b. Summary will update on new commits.