server-configuration-extension-used
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
In OpenAPI v3.0.x, the Info Object can be extended with additional properties through the use of specification extensions (i.e., properties that begin with x-). One such vendor extension is x-server-configuration, which allows users to define API server configurations in more detail. It is essential to include the x-server-configuration extension in the Info Object, as it should not be missing.
| Property | Value |
|---|---|
| Enabled | No |
| Maximum Severity | Warning |
| Message | Server configuration extension is missing in the info object. |
| Code | OPENAPI3APIMATIC_L100 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Servers |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting server server configuration info object info |
Suggested Fixes
- Add extension within the
infoobject by using the propertyx-server-configuration.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#info-object
- https://docs.apimatic.io/specification-extensions/swagger-server-configuration-extensions/#server-configuration-extension
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/