Skip to content
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

Respect API version when building URL to downstream swagger.json #301

Merged
merged 2 commits into from
Jul 15, 2024
Merged

Respect API version when building URL to downstream swagger.json #301

merged 2 commits into from
Jul 15, 2024

Conversation

satano
Copy link
Contributor

@satano satano commented Jul 9, 2024 •
edited by coderabbitai bot
Loading

Fixes #300

Summary by CodeRabbit

  • Refactor

    • Improved URI building logic to handle endpoint paths and API versions dynamically.

  • Tests

    • Added new test to validate Swagger URI generation with specific API version when not explicitly set.

@update-docs Update Docs
Copy link

update-docs bot commented Jul 9, 2024

Thanks for opening this pull request! If you have implemented new functions, write about them in the readme file.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 9, 2024 •
edited
Loading

Walkthrough

The recent changes improve the SwaggerService and SwaggerServiceDiscoveryProvider classes within the MMLib.SwaggerForOcelot project. These modifications enable the default path to the downstream Swagger JSON to respect the configured API version dynamically when it is not explicitly set. A new test method ensures this behavior is validated correctly.

Changes

File Change Summary
src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerService.cs Modified Path property to no longer have a default value.
src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerServiceDiscoveryProvider.cs Refactored imports and adjusted URI building logic to handle dynamic endpoint paths and versions.
tests/MMLib.SwaggerForOcelot.Tests/ServiceDiscovery/SwaggerServiceDiscoveryProviderShould.cs Added a new test method RespectApiVersionWhenUriIsNotExplicitlySet to check dynamic Swagger URI generation based on version.

Assessment against linked issues

Objective (Issue #300) Addressed Explanation
Ensure default path for Swagger JSON respects configured version ✅
Add test method to validate behavior ✅

Poem

In lines of code, our tale is spun,
Where paths and versions dance as one.
The Swagger routes now change their tune,
Reflecting APIs beneath the moon.
A test to guard this newfound grace,
Ensuring all is in its place.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

coderabbitai[bot]
coderabbitai bot reviewed Jul 9, 2024
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ecc9644 and 6ba0f74.

Files selected for processing (3)
  • src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerService.cs (1 hunks)
  • src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerServiceDiscoveryProvider.cs (3 hunks)
  • tests/MMLib.SwaggerForOcelot.Tests/ServiceDiscovery/SwaggerServiceDiscoveryProviderShould.cs (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerService.cs
Additional comments not posted (2)
src/MMLib.SwaggerForOcelot/ServiceDiscovery/SwaggerServiceDiscoveryProvider.cs (1)

109-118: LGTM! Ensure dynamic handling of API version is correct.

The changes dynamically handle the endpoint paths and API versions when constructing the URI. This addresses the issue of respecting the API version.

Please verify that all potential edge cases for API version handling are covered.

tests/MMLib.SwaggerForOcelot.Tests/ServiceDiscovery/SwaggerServiceDiscoveryProviderShould.cs (1)

52-66: LGTM! The test ensures correct handling of API version.

The new test method RespectApiVersionWhenUriIsNotExplicitlySet verifies that the SwaggerServiceDiscoveryProvider correctly generates a Swagger URI with a specified API version when the URI is not explicitly provided.

@Burgyn Burgyn merged commit b027617 into Burgyn:master Jul 15, 2024
3 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Oct 4, 2024
Merged
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

@Burgyn Burgyn Burgyn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Default path to downstream Swagger JSON does not respect service version
2 participants
@satano @Burgyn