server-parameter-exists-in-server-url-template
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
Template parameters defined in the server configuration must be referenced by at least one or more server URLs.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Unused server template parameter found. |
Code | OPENAPI3APIMATIC_L116 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Servers |
Products Impacted | API Transformer, Code Generation |
Tags | openapi3 openapi apimatic semantic linting server parameter url template server configuration |
Suggested Fixes
- Explicitly define all server parameters in the server url template.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#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/