valid-server-parameter-schema-default
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The schema default value specified in the server parameter definition must be valid according to the type definition of this parameter.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Default schema value of server parameter is invalid. |
| Code | OPENAPI3APIMATIC_L126 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Servers |
| Products Impacted | API Transformer, Code Generation |
| Tags | openapi3 openapi apimatic semantic linting server parameter default schema schema object |
Suggested Fixes
- Make sure that the default value corresponds with the type definition of the server parameter.
- Default value must not be null or empty.
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/#parameter-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://docs.apimatic.io/rulesets/overview/