required-schema-properties-with-object-type
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
In an OpenAPI document, if a schema object has the type 'object', it must also contain a 'properties' property that defines the object's properties. This is required to accurately describe the structure of the object and enable proper validation.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Object schema must define properties. |
| Code | OPENAPI3CODEGEN_L618 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic properties schema |
Suggested Fixes
- Add a 'properties' property to the schema object with type 'object'.
- Ensure that schema 'properties' property is not empty.
- Ensure that schema 'properties' property is not null.