pre-defined-operation-server-in-server-configuration
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
Operation must use a pre-defined server from the API specification's server configuration.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Operation uses an undefined server. |
Code | OPENAPI3APIMATIC_L236 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Operations |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi apimatic semantic linting server operation server configuration |
Suggested Fixes
- Make sure the server linked in the operation is defined in the server configuration of the API.
For More Information
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#server-configuration-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/