feat: added description schema

[shubhranshu-dash]

Issue: https://linear.app/requestly/issue/ENGG-4809/adding-descriptions-in-headers-and-query-params

Summary by CodeRabbit

• New Features
  • Key-value pairs now support an optional description field, enabling users to add contextual information to stored data entries for improved clarity and organization.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[linear]

ENGG-4809 Adding descriptions in headers and query params

[coderabbitai]

Walkthrough

A single optional description field of type Type.String() has been added to the KeyValuePair schema in src/renderer/actions/local-sync/schemas.ts. The schema now includes this additional property without modifications to existing fields, control flow, or business logic.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single-file change affecting only schema definition
• Addition of one optional field with no logic implications
• No control flow or behavior modifications
• Straightforward, repetitive pattern (schema extension)

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding a description field to the schema in the local-sync module.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ENGG-4809-description-schema

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 00d00da and 84b9a73.

📒 Files selected for processing (1)

• src/renderer/actions/local-sync/schemas.ts (1 hunks)

🔇 Additional comments (1)

src/renderer/actions/local-sync/schemas.ts (1)

50-57: Optional description on KeyValuePair is consistent and backward‑compatible

Adding an optional description: Type.Optional(Type.String()) here matches how PathVariable already uses description and should remain non‑breaking for existing payloads that omit this field. Looks good.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}