Refactor HTTP request methods in documentation

[guibranco]

User description

Closes #

📑 Description

✅ Checks

• [X] My pull request adheres to the code style of this project
• [X] My code requires changes to the documentation
• [X] I have updated the documentation as required
• [X] All the tests have passed

☢️ Does this introduce a breaking change?

• [X] Yes
• [ ] No

ℹ Additional Information

---

Description

• Refactored the HTTP request methods in request.md to improve parameter clarity.
• Adjusted the order of parameters for post, put, and patch methods to place $headers first.
• This change enhances the documentation for better understanding of request handling.

---

Changes walkthrough 📝

	Relevant files
Enhancement	request.md Refactor HTTP request methods for better parameter clarity docs/user-guide/request.md Updated the order of parameters in HTTP request methods. Changed the position of $headers and payload in post, put, and patch methods. Improved clarity on how to use headers with requests. +6/-6

Summary by CodeRabbit

• Documentation
  • Updated the user guide for the Request class to reflect changes in method signatures for HTTP requests (POST, PUT, PATCH, DELETE).
  • Adjusted examples to illustrate the new parameter order: headers now precede the payload.

[coderabbitai[bot]]

[!WARNING]

Rate limit exceeded

@penify-dev[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 36 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

📥 Commits

Files that changed from the base of the PR and between 1c39b31e63e7773dda07cc5b5af55b5a9b48421a and 853503137635f6c5c5b9d16d01b2ce02ab6bf2d4.

Walkthrough

The changes in this pull request focus on updating the documentation for the Request class, specifically for the HTTP methods: POST, PUT, PATCH, and DELETE. The order of parameters in the method signatures has been modified to place headers as the second argument and payload as the third. This adjustment ensures consistency across the documentation while the GET, OPTIONS, and HEAD methods remain unchanged.

Changes

File	Change Summary
docs/user-guide/request.md	Updated method signatures for post, put, patch, and delete to change parameter order: headers now second, payload third.

Possibly related PRs

• 227: The changes in the Request class's method signatures for post, put, patch, and delete in this PR are directly related to the updates in the main PR, which also modifies the order of parameters in these methods.

Suggested labels

size/L

Suggested reviewers

• gstraccini

Poem

In the meadow, I hop and play,
Updating docs in a clever way.
Headers first, then payloads neat,
A change so sweet, it can't be beat!
With every method, clear and bright,
Our code will shine, oh what a sight! 🐇✨

---

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[deepsource-io[bot]]

Here's the code health analysis summary for commits 1c39b31..8535031. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Test coverage	✅ Success		View Check ↗
SQL	✅ Success		View Check ↗
Secrets	✅ Success		View Check ↗
PHP	✅ Success		View Check ↗
Docker	✅ Success		View Check ↗

Code Coverage Report

Metric	Aggregate	Php
Branch Coverage	100%	100%
Composite Coverage	95.3%	95.3%
Line Coverage	95.3%	95.3%

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[penify-dev[bot]]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and primarily involve reordering parameters in the documentation.
🧪 Relevant tests	No
⚡ Possible issues	No
🔒 Security concerns	No

[codacy-production[bot]]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
:white_check_mark: +0.00% (target: -1.00%)	:white_check_mark: ∅

Coverage variation details

| | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (1c39b31e63e7773dda07cc5b5af55b5a9b48421a) | 258 | 246 | 95.35% | | | Head commit (853503137635f6c5c5b9d16d01b2ce02ab6bf2d4) | 258 (+0) | 246 (+0) | 95.35% (**+0.00%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `

Diff coverage details

| | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#228) | 0 | 0 | **∅ (not applicable)** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[github-actions[bot]]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

```txt 6:21PM INF scanning for exposed secrets... 6:21PM INF 159 commits scanned. 6:21PM INF scan completed in 412ms 6:21PM INF no leaks found ```

[penify-dev[bot]]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Improve error handling for HTTP response status codes ___ **Consider checking if the statusCode is being handled correctly, especially for error responses, to ensure robustness.** [docs/user-guide/request.md [67-68]](https://github.com/guibranco/pancake/pull/228/files#diff-13387b9c8c5ed1c1731632207cedac69cefce8c3564859e1dc26702b10fc024dR67-R68) ```diff if ($response->statusCode >= 200 && $response->statusCode < 300) { + echo $response->body; +} else { + // Handle error response appropriately +} ``` Suggestion importance[1-10]: 5 Why: While the suggestion is valid in terms of improving error handling, the existing code does not handle errors, and the suggestion does not address the new code introduced in the PR.	5

[sonarcloud[bot]]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud