Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[API][PaymentRequest] Rename payment request operations for shop context #18568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
GSadee merged 2 commits into from
Dec 10, 2025
Merged

[API][PaymentRequest] Rename payment request operations for shop context #18568

GSadee merged 2 commits into from
Dec 10, 2025

Conversation

@Rafikooo
Copy link
Contributor

@Rafikooo Rafikooo commented Nov 24, 2025 •
edited
Loading

This PR renames payment request API operations to follow the shop API naming convention.

Changes:

  • Renamed sylius_api_show_payment_request_get to sylius_api_shop_payment_request_get
  • Renamed sylius_api_show_payment_request_post to sylius_api_shop_payment_request_post
  • Renamed sylius_api_show_payment_request_put to sylius_api_shop_payment_request_put
  • Added upgrade documentation for route changes

This standardizes the naming convention for shop context payment request operations. Since the PaymentRequest component is experimental, these route renames are considered acceptable.

Ref: #18439

@Rafikooo Rafikooo requested review from a team as code owners November 24, 2025 15:44
@probot-autolabeler probot-autolabeler bot added API APIs related issues and PRs. Maintenance CI configurations, READMEs, releases, etc. labels Nov 24, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 24, 2025 •
edited
Loading

Walkthrough

Payment request API operation identifiers were renamed from generic "show" to shop-specific "shop" names and an upgrade note for 2.1.8 documenting the mapping was added to upgrade documentation. No behavioral or payload changes were introduced.

Changes

Cohort / File(s) Summary
Upgrade Documentation
UPGRADE-API-2.1.md		 Added upgrade section for v2.1.8 documenting renamed payment request routes to shop-specific operation names and an explicit mapping table.
API Configuration
src/Sylius/Bundle/ApiBundle/Resources/config/api_platform/resources/shop/PaymentRequest.xml		 Renamed operation identifiers: sylius_api_show_payment_request_get → sylius_api_shop_payment_request_get, sylius_api_show_payment_request_post → sylius_api_shop_payment_request_post, sylius_api_show_payment_request_put → sylius_api_shop_payment_request_put. No other attribute changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Check for any remaining references to the old operation names across the codebase and docs.
  • Verify the upgrade note correctly and clearly maps old → new route names.

Suggested labels

Documentation

Suggested reviewers

  • GSadee
  • NoResponseMate

Poem

🐰 I hopped through routes both old and new,
I nudged three names and said "adieu",
A tiny note now guides the way,
Shop names brighten up the day,
Hop on—this update's light and true!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly summarizes the main change: renaming payment request operations to follow shop API naming convention, which aligns with the PR's core objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link

github-actions bot commented Nov 24, 2025 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands:

  • 🚀 /bns:deploy to redeploy the environment

@Rafikooo Rafikooo mentioned this pull request Nov 24, 2025
Closed
coderabbitai[bot]
coderabbitai bot reviewed Nov 24, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8275ac3 and 7324747.

📒 Files selected for processing (2)
  • UPGRADE-API-2.1.md (1 hunks)
  • src/Sylius/Bundle/ApiBundle/Resources/config/api_platform/resources/shop/PaymentRequest.xml (3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
UPGRADE-API-2.1.md

3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🔇 Additional comments (4)
src/Sylius/Bundle/ApiBundle/Resources/config/api_platform/resources/shop/PaymentRequest.xml (3)

22-24: Clean rename of GET operation to shop naming convention.

The operation identifier correctly follows the shop API naming pattern. All other operation metadata (URI template, normalization context) remains unchanged.

38-40: Clean rename of POST operation to shop naming convention.

The operation identifier is correctly updated. The operation's URI template, input command, and normalization/denormalization contexts remain intact.

79-81: Clean rename of PUT operation to shop naming convention.

The operation identifier is correctly updated to the shop naming pattern. The provider, input command, and all context groups remain unchanged.

UPGRADE-API-2.1.md (1)

7-11: Migration table accurately documents the renamed routes.

The old→new route mappings correctly correspond to the operation name changes in PaymentRequest.xml (lines 22, 38, 79). The table format is clear and follows the upgrade documentation convention.

Prometee
Prometee previously approved these changes Nov 24, 2025
View reviewed changes
GSadee
GSadee reviewed Nov 25, 2025
View reviewed changes
Copy link
Member

@GSadee GSadee left a comment

Choose a reason for hiding this comment

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

Payment requests are still experimental, so I believe we can change this without breaking BC Policy, but I would be in favour of doing that in version 2.2, because it is a change that may affect the end application. Wdyt?

@Rafikooo Rafikooo changed the base branch from 2.1 to 2.2 November 29, 2025 20:57
@Rafikooo Rafikooo dismissed Prometee’s stale review November 29, 2025 20:57

The base branch was changed.

GSadee
GSadee reviewed Dec 8, 2025
View reviewed changes
@GSadee GSadee merged commit a34d944 into Sylius:2.2 Dec 10, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@GSadee GSadee GSadee approved these changes

@Prometee Prometee Prometee left review comments

Assignees

No one assigned

Labels

API APIs related issues and PRs. Maintenance CI configurations, READMEs, releases, etc.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Rafikooo @Prometee @GSadee