required-server-parameter-name
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
Server parameter definition in the server configuration of the API must specify a non-empty non-null name.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Server parameter name is missing or empty. |
| Code | OPENAPI3APIMATIC_L118 |
| 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 name |
Suggested Fixes
- Set a name for each server parameter.
- Assign a code-friendly and user-friendly name.
- Avoid using special characters in the name.
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/