Skip to content

[UI][Swagger] Fix uri variables by adding slug#17740

Merged
Wojdylak merged 1 commit intoSylius:2.0from
nicolalazzaro:issue_17739
Apr 17, 2025
Merged

[UI][Swagger] Fix uri variables by adding slug#17740
Wojdylak merged 1 commit intoSylius:2.0from
nicolalazzaro:issue_17739

Conversation

@nicolalazzaro
Copy link
Copy Markdown
Contributor

@nicolalazzaro nicolalazzaro commented Mar 12, 2025

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

Summary by CodeRabbit

  • New Features
    • Enhanced the shop product API endpoint to now explicitly accept and process a slug parameter, improving the handling of product requests.

@nicolalazzaro nicolalazzaro requested review from a team as code owners March 12, 2025 07:37
@probot-autolabeler probot-autolabeler bot added the API APIs related issues and PRs. label Mar 12, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 12, 2025

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 API configuration for the product endpoint. It adds a new <uriVariables> section within the <operation> element for the sylius_api_shop_product_get_by_slug operation in the Product.xml file. This new section explicitly defines a <uriVariable> for the "slug" parameter linked to the product model, clarifying how the slug is extracted from the request URI.

Changes

File(s) Summary
src/Sylius/Bundle/ApiBundle/.../shop/Product.xml Added a <uriVariables> section with a <uriVariable parameterName="slug" fromClass="%sylius.model.product.class%" /> to the sylius_api_shop_product_get_by_slug operation.

Sequence Diagram(s)

sequenceDiagram
  participant Client as C
  participant API as API Server
  participant Router as R
  participant Controller as Product Controller

  Client->>API: GET /shop/products/{slug}
  API->>Router: Resolve route (sylius_api_shop_product_get_by_slug)
  Router-->>API: Extract slug via <uriVariables>
  API->>Controller: Process request with slug parameter
  Controller-->>API: Return product details
  API-->>Client: Respond with product data
Loading

Poem

I’m a bunny in a code-filled glen,
Hopping through XML again and again.
A slug now finds its rightful way,
With <uriVariables> lighting the day.
Ears perked up, I cheer with glee,
For cleaner routes in our API! 🐰


🪧 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 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
Copy link
Copy Markdown

github-actions bot commented Mar 12, 2025

❌ Preview Environment deleted from Bunnyshell

Available commands:

  • 🚀 /bns:deploy to redeploy the environment

@nicolalazzaro nicolalazzaro changed the title [API] Fix uri variables by adding slug [UI][Swagger] Fix uri variables by adding slug Mar 12, 2025
@Wojdylak Wojdylak added the Bug Confirmed bugs or bugfixes. label Apr 11, 2025
@Wojdylak
Copy link
Copy Markdown
Member

After merging this PR, I will rebase to fix actions.

@Wojdylak Wojdylak changed the base branch from 2.1 to 2.0 April 17, 2025 06:50
@probot-autolabeler probot-autolabeler bot added Admin AdminBundle related issues and PRs. Maintenance CI configurations, READMEs, releases, etc. labels Apr 17, 2025
@Wojdylak Wojdylak merged commit 09b3d31 into Sylius:2.0 Apr 17, 2025
27 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Apr 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Admin AdminBundle related issues and PRs. API APIs related issues and PRs. Bug Confirmed bugs or bugfixes. Maintenance CI configurations, READMEs, releases, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[2.0][UI][Swagger] The URI variable slug not interpreted by Open API web interface

3 participants