required-media-type-schema
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
Each media type object must have an associated schema defined. The schema defines the structure and data format for the content of the media type.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Required schema is missing from the media type object. |
Code | OPENAPI3APIMATIC_L400 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Media Types |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi apimatic semantic linting media type schema |
Suggested Fixes
- Ensure that a schema is defined within the media type object.
- Make sure the schema is properly formatted and matches the expected data structure and format for the media type.