valid-server-name
Overview
This rule belongs to the openapi-v3-codegen-syntax-linting ruleset and states that:
For successful Code Generation, the server name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Server name is invalid. |
| Code | OPENAPI3CODEGENSYNTAX_L091 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI Servers |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi syntax linting apimatic server name x-server-configuration |
Suggested Fixes
- Make sure the name of the server does not contain any forbidden characters.
- Use only letters, numbers, underscores and dashes.
- Remove any trailing/leading white-space characters, if present.