[bug] [2284] Doc & API mismatch request.AddCookie

[AugustinSeguin]

User description

Description

Solve little documentation missing here from this issue: #2284

Purpose

This pull request is a:

• to propose a documentation updated for RestRequestExtensions class AddCookie method

Checklist

• I have updated the documentation for RestRequestExtensions class AddCookie method

---

PR Type

Documentation

---

Description

• Update AddCookie method documentation with correct 4-parameter signature

• Replace incomplete 2-parameter example with accurate parameter names

• Align documentation across all versioned docs and main docs

---

Diagram Walkthrough

flowchart LR
  A["Documentation Files"] -- "Update AddCookie example" --> B["Correct 4-parameter signature"]
  B -- "name, value, path, domain" --> C["Aligned across versions"]

Loading

File Walkthrough

Relevant files

Documentation

request.md Update AddCookie example with correct parameters                  docs/docs/usage/request.md Updated AddCookie method example from 2-parameter to 4-parameter signature Changed example from request.AddCookie("foo", "bar") to request.AddCookie("name", "value", "path", "domain") +1/-1      request.md Update AddCookie example with correct parameters                  docs/versioned_docs/version-v111/usage/request.md Updated AddCookie method example from 2-parameter to 4-parameter signature Changed example from request.AddCookie("foo", "bar") to request.AddCookie("name", "value", "path", "domain") +1/-1      request.md Update AddCookie example with correct parameters                  docs/versioned_docs/version-v112/usage/request.md Updated AddCookie method example from 2-parameter to 4-parameter signature Changed example from request.AddCookie("foo", "bar") to request.AddCookie("name", "value", "path", "domain") +1/-1      request.md Fix frontmatter and update AddCookie parameters                    docs/versioned_docs/version-v113/usage/request.md Fixed YAML frontmatter delimiter from ---- to --- Updated AddCookie method example from 2-parameter to 4-parameter signature Changed example from request.AddCookie("foo", "bar") to request.AddCookie("name", "value", "path", "domain") +2/-2

---

[qodo-free-for-open-source-projects]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🔴	Malformed YAML frontmatter Description: The YAML frontmatter delimiter was changed from ---- to f---, which appears to be a typo that will break the markdown frontmatter parsing and potentially expose metadata or cause rendering issues. request.md [1-1] Referred Code f--- sidebar_position: 4
Ticket Compliance
🟢	🎫 #2284 🟢 Update documentation to reflect the correct 4-parameter signature for the AddCookie method Fix the discrepancy between documented 2-parameter method and actual 4-parameter implementation Ensure documentation matches the actual API implementation in RestRequestExtensions.cs
Codebase Duplication Compliance
🟢	No codebase code duplication found No new components were introduced in the PR code
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-free-for-open-source-projects]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	✅ Fix invalid YAML frontmatter delimiter Suggestion Impact: The commit directly implements the suggestion by correcting the typo in the YAML frontmatter delimiter from 'f---' to '---' on line 1 of the file code diff: -f--- +--- Correct the invalid YAML frontmatter delimiter f--- to --- to ensure the page's metadata is parsed correctly. docs/versioned_docs/version-v113/usage/request.md [1] -f--- +--- [Suggestion processed] Suggestion importance[1-10]: 9 __ Why: The suggestion correctly identifies a typo f--- introduced in the PR for a YAML frontmatter delimiter, which would break metadata parsing for the documentation page.	High
Update

[AugustinSeguin]

@dotnet-policy-service agree

@dotnet-policy-service agree

[AugustinSeguin]

It's small fix bug because it's my first open source project contributation.
The PR is OK for me. Give me feedback if needed. Thanks.