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.

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

📚 Doc: Update example in middleware/cors to v3 #3116

Merged
merged 4 commits into from
Aug 31, 2024

Conversation

AuroraTea
Copy link
Contributor

Description

There is an example in middleware/cors still uses the v2 syntax.

Fixes #3115

Changes introduced

  • Documentation Update: Update the syntax of an example to v3 changed file.

Type of change

  • Documentation update (changes to documentation)

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

@AuroraTea AuroraTea requested a review from a team as a code owner August 30, 2024 13:03
@AuroraTea AuroraTea requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team August 30, 2024 13:03
Copy link

welcome bot commented Aug 30, 2024

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Copy link
Contributor

coderabbitai bot commented Aug 30, 2024

Walkthrough

The changes involve updating the CORS middleware configuration in a Go application. The AllowOrigins and AllowHeaders fields have been modified from string literals to slices of strings, enhancing the structure and clarity of the configuration. Additionally, a correction was made to the spelling of "Origin" in the AllowHeaders field.

Changes

Files Change Summary
docs/middleware/cors.md Updated AllowOrigins from string to slice of strings; corrected "Origi" to "Origin" in AllowHeaders.

Assessment against linked issues

Objective Addressed Explanation
There is an example in middleware/cors still uses the v2 syntax. (#3115)

Poem

In the meadow, I hop with glee,
CORS is fixed, oh joy for me!
Origins now in neat little rows,
Headers corrected, how the wind blows!
With each change, the code does sing,
A brighter future, let’s all spring! 🐇✨


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

@AuroraTea AuroraTea changed the title 📚 Doc: Update examples to v3 in middleware/cors 📚 Doc: Update an example to v3 in middleware/cors Aug 30, 2024
Copy link
Contributor

@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

Commits

Files that changed from the base of the PR and between 4b1ee0b and cc18d39.

Files selected for processing (1)
  • docs/middleware/cors.md (1 hunks)
Additional comments not posted (1)
docs/middleware/cors.md (1)

52-52: Approved: Updated AllowOrigins syntax to v3.

The change from a string to a slice of strings for AllowOrigins enhances clarity and maintainability of the configuration, aligning with Fiber v3 standards.

docs/middleware/cors.md Outdated Show resolved Hide resolved
@gaby gaby changed the title 📚 Doc: Update an example to v3 in middleware/cors 📚 Doc: Update example in middleware/cors to v3 Aug 30, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@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 cc18d39 and 2d813c3.

Files selected for processing (1)
  • docs/middleware/cors.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • docs/middleware/cors.md

@efectn efectn merged commit 4acdc60 into gofiber:main Aug 31, 2024
1 check passed
Copy link

welcome bot commented Aug 31, 2024

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you! If you need help or want to chat with us, join us on Discord https://gofiber.io/discord

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🐛 [Bug]: There is an example in middleware/cors still uses the v2 syntax.
4 participants