optional-template-path-parameters

Overview

This rule belongs to the apimatic-preliminary-linting ruleset and states that:

Path/template parameters used in the endpoint relative path/route should not be defined as optional parameters in the endpoint.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Beware! Endpoint contains a template parameter declared as optional.
Code	APIMATICPRE_L042
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

• Set template parameter as a required endpoint parameter.

For More Information

• https://docs.apimatic.io/api-editor/endpoints/#format
• https://docs.apimatic.io/rulesets/overview/