feat: add example parameter to Action::param method

[ChiragAgg5k]

Summary by CodeRabbit

• New Features
  • You can now add example values to action parameters. These examples are included in parameter configuration and can be displayed in UIs or documentation to guide users.
  • Fully backward compatible; existing configurations continue to work without changes.

[coderabbitai]

Walkthrough

Introduces an optional $example string parameter to Action::param in src/Platform/Action.php, stores it alongside existing param metadata, and exposes it through the public options array. Docblock updated. No control flow changes; return type and chaining behavior remain the same.

Changes

Cohort / File(s)	Change summary
Action param example support src/Platform/Action.php	Extend Action::param signature with string $example = ''; include 'example' => $example in internal param data and in $this->options; update method docblock accordingly; maintain backward compatibility and return self.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A whisker twitch, a tiny tweak,
I stash examples when you speak.
In fields of params, neatly sown,
A hint of usage now is shown.
Thump-thump! I hop, my change is small—
Yet clearer burrows help us all. 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add-example

---

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

🪧 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>, please review it.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Platform/Action.php (2)

171-173: Docblock: add a concise description for $example.

Clarify intent for readers/tools, e.g., “Example value used for documentation and SDK generation.”

- * @param  string  $example
+ * @param  string  $example Example value used for documentation and SDK generation.

---

174-174: Widen $example to mixed|null

- public function param(string $key, mixed $default, Validator|callable $validator, string $description = '', bool $optional = false, array $injections = [], bool $skipValidation = false, bool $deprecated = false, string $example = ''): self
+ public function param(string $key, mixed $default, Validator|callable $validator, string $description = '', bool $optional = false, array $injections = [], bool $skipValidation = false, bool $deprecated = false, mixed $example = null): self

Allows non-string examples (numbers, arrays, etc.) without casting; no param() overrides found.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1e33b7c and 1490b60.

📒 Files selected for processing (1)

• src/Platform/Action.php (2 hunks)

🔇 Additional comments (1)

src/Platform/Action.php (1)

176-185: LGTM: example is correctly persisted into params and options.

The new field is included consistently in both $this->params[$key] and $this->options['param:'.$key].