atleast-one-template-parameter-reference
Overview
This rule belongs to the apimatic-preliminary-linting ruleset and states that:
If a template parameter is defined in an endpoint, it must also be part of one or more path segments of the endpoint's relative path/route.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Endpoint has an unused template parameter. |
| Code | APIMATICPRE_L043 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Endpoints |
| Products Impacted | Code Generation, Developer Experience Portal, API Transformer |
| Tags | preliminary checks linting apimatic parameter template path endpoint |
Suggested Fixes
- Did you forget to use the template parameter in the endpoint route?
- Make sure that the parameter is used in the endpoint route and is surrounded by curly braces e.g. /message/{id}.
- Remove the template parameter definition from endpoint parameters.