Skip to content

docs: omit deprecated checkout id from playground payload#332

Open
gaureshpai wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
gaureshpai:fix/playground-deprecated-id
Open

docs: omit deprecated checkout id from playground payload#332
gaureshpai wants to merge 1 commit intoUniversal-Commerce-Protocol:mainfrom
gaureshpai:fix/playground-deprecated-id

Conversation

@gaureshpai
Copy link
Copy Markdown
Contributor

Description

While reviewing the interactive playground script in docs/specification/playground.md, I noticed that the id property was still being passed inside the patch object for update requests. Since this field was recently marked as deprecated_required_to_omit (as it is provided via the URL path), the playground was inadvertently generating non-compliant payloads. This PR fixes the playground payload creation by properly initializing an empty patch object.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Pull Request Title

docs: omit deprecated checkout id from playground payload

@gaureshpai gaureshpai requested review from a team as code owners April 2, 2026 05:56
@gaureshpai gaureshpai force-pushed the fix/playground-deprecated-id branch 2 times, most recently from 5a4bacd to 5ccf830 Compare April 18, 2026 14:10
@gaureshpai gaureshpai force-pushed the fix/playground-deprecated-id branch 2 times, most recently from 1eeaa6a to 4700210 Compare April 20, 2026 19:49
Removes checkoutResponse.id from the update payload in playground.md. This field is marked as deprecated_required_to_omit for update requests (as the ID is now passed in the URL path). It was previously only commented as deprecated without actually removing the property from the payload object.
@gaureshpai gaureshpai force-pushed the fix/playground-deprecated-id branch from 4700210 to b35f926 Compare April 21, 2026 04:32
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.

1 participant