at-least-one-parameter-example
Overview
This rule belongs to the openapi-v3-agentic-tools-linting ruleset and states that:
Examples significantly improve agentic tools' ability to infer parameter usage, constraints, and expected values. Define at least one valid example for every parameter.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Error |
| Message | Parameter should include at least one example. |
| Code | OPENAPI3AGENTICTOOLS_L331 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Parameters |
| Products Impacted | Agentic Tools Generation, Developer Experience Portal |
| Tags | code generation AI Agentic tools mcp llm openapi3 openapi semantic linting apimatic parameter example |
Suggested Fixes
- Provide at least one example that matches the parameter schema.
- Use realistic values that reflect real-world usage.