[API] Fix prevent overwriting modifications for shared paths with multiple methods by nicolalazzaro · Pull Request #17858 · Sylius/Sylius

nicolalazzaro · 2025-04-09T09:19:54Z

Q	A
Branch?	2.1
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Related tickets	fixes #17857
License	MIT

Summary by CodeRabbit

Bug Fixes
- Improved the accuracy of API documentation for language-specific features by ensuring that operations are consistently assigned without duplication.

coderabbitai · 2025-04-09T09:20:01Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request updates the documentation modifier for the Accept-Language header. The change introduces a conditional check to ensure that a path item is added only if it is not already present in the path items array. Additionally, it adjusts the assignment logic so that operations are applied to the correct instance of a path item. No public APIs or exported entities have been modified.

Changes

File	Change Summary
src/Sylius/.../AcceptLanguageHeaderDocumentationModifier.php	Added a conditional check to prevent overwriting existing path items and modified the assignment to ensure the operation is applied to the correct instance.

Sequence Diagram(s)

sequenceDiagram
    participant Modifier as AcceptLanguageHeaderDocumentationModifier
    participant PathItems as PathItems Array
    Modifier->>PathItems: Iterate through each path
    alt Path key not set
      Modifier->>PathItems: Add new path item with header documentation
    else Path key exists
      Modifier->>PathItems: Update existing path item with additional operation
    end

Assessment against linked issues

Objective	Addressed	Explanation
Add Accept-Language header documentation for endpoints sharing the same path (#17857)	✅

Poem

Hopping through the code, I found a splendid fix,
A gentle tweak ensured no path is in a mix.
Each header now shines clear and bright,
With careful checks, our docs take flight.
From a tiny rabbit, cheers to code done right!

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-04-09T09:21:17Z

❌ Preview Environment deleted from Bunnyshell

Available commands:

🚀 /bns:deploy to redeploy the environment

GSadee · 2025-04-09T13:46:27Z

The base of this pull-request was changed, you need fetch and reset your local branch
if you want to add new commits to this pull request. Reset before you pull, else commits
may become messed-up.

Unless you added new commits (to this branch) locally that you did not push yet,
execute git fetch origin && git reset "issue_17857" to update your local branch.

Feel free to ask for assistance when you get stuck 👍

Wojdylak · 2025-04-11T12:23:56Z

After merging this PR, @GSadee will rebase to fix actions.

… methods

GSadee · 2025-04-23T11:26:00Z

Thank you @nicolalazzaro! 🎉

nicolalazzaro requested review from a team as code owners April 9, 2025 09:19

probot-autolabeler bot added the API APIs related issues and PRs. label Apr 9, 2025

GSadee changed the base branch from 2.1 to 2.0 April 9, 2025 13:46

GSadee force-pushed the issue_17857 branch from 43b3145 to bce7e22 Compare April 9, 2025 13:46

GSadee approved these changes Apr 9, 2025

View reviewed changes

GSadee added the Bug Confirmed bugs or bugfixes. label Apr 9, 2025

GSadee changed the title ~~[2.1][API] Fix prevent overwriting modifications for shared paths with multiple methods~~ [API] Fix prevent overwriting modifications for shared paths with multiple methods Apr 10, 2025

fix: prevent overwriting modifications for shared paths with multiple…

8623aed

… methods

GSadee force-pushed the issue_17857 branch from bce7e22 to 8623aed Compare April 23, 2025 10:36

GSadee approved these changes Apr 23, 2025

View reviewed changes

GSadee merged commit 17907a4 into Sylius:2.0 Apr 23, 2025
27 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[API] Fix prevent overwriting modifications for shared paths with multiple methods#17858

[API] Fix prevent overwriting modifications for shared paths with multiple methods#17858
GSadee merged 1 commit intoSylius:2.0from
nicolalazzaro:issue_17857

nicolalazzaro commented Apr 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 9, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

github-actions bot commented Apr 9, 2025 •

edited

Loading

Uh oh!

GSadee commented Apr 9, 2025

Uh oh!

Wojdylak commented Apr 11, 2025

Uh oh!

Uh oh!

GSadee commented Apr 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

nicolalazzaro commented Apr 9, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Preview Environment deleted from Bunnyshell

Uh oh!

GSadee commented Apr 9, 2025

Uh oh!

Wojdylak commented Apr 11, 2025

Uh oh!

Uh oh!

GSadee commented Apr 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nicolalazzaro commented Apr 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 9, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Apr 9, 2025 •

edited

Loading