pre-defined-server-parameter-for-server-url-template-expression
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
A parameter referenced by a server (a path or template parameter) must have a corresponding definition in the server configuration for server url template expression.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Server parameter has a missing definition. |
| Code | OPENAPI3APIMATIC_L112 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Servers |
| Products Impacted | API Transformer, Code Generation |
| Tags | openapi3 openapi apimatic semantic linting parameter server url path parameter template |
Suggested Fixes
- Explicitly define all parameters used by the server in the server configuration parameters.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#server-object
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#parameter-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/