server-variable-exists-in-server-url-template
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
Server variables defined in the server's variables object must be referenced in the server URL.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Unused server variable found. |
Code | OPENAPI3APIMATIC_L115 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Servers |
Products Impacted | API Transformer, Code Generation |
Tags | openapi3 openapi apimatic semantic linting server variable url template |
Suggested Fixes
- Reference all server variables in the server URL.
For More Information
- https://www.apimatic.io/
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-variable-object
- https://docs.apimatic.io/rulesets/overview/