pre-defined-server-for-default-server
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
The default server specified in the server configuration of the API must have a corresponding definition in all of the server configuration environment servers.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | The default server is undefined. |
Code | OPENAPI3APIMATIC_L102 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Servers |
Products Impacted | API Transformer, Code Generation |
Tags | openapi3 openapi apimatic semantic linting default server server configuration server configuration servers |
Suggested Fixes
- Define the server in the server configuration servers.
- Make sure the server name is not misspelled.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#server-object
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#server-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/