server-parameter-cannot-be-map
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
Server URL parameters cannot be declared as maps. Only primitive types like string, number or string/number enumeration types are allowed.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Server URL parameter declared as a map which is not allowed. |
Code | OPENAPI3APIMATIC_L122 |
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 url |
Suggested Fixes
- Change the type to one of the supported types: string, number, enumeration.
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/