valid-server-parameter-type
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Valid types for a server parameter include: String, Number and a String/Number enumeration. No other types must be used.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Server parameter type is invalid. |
| Code | OPENAPI3APIMATIC_L120 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Servers |
| Products Impacted | API Transformer, Code Generation |
| Tags | openapi3 openapi apimatic semantic linting server parameter server configuration type |
Suggested Fixes
- Make sure the server parameter uses a string or number type only.
- Object or array types are not allowed for server parameters.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#server-configuration-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/