API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Schema Property Shapes

Requiring that all schema property shapes meets the policy standards.

Rules

OpenAPI Schema Properties String Maxlength Error

Schema properties that are of the string type have the max length applied defining the shape of the property

OpenAPI Schema Properties String Maxlength Info

Schema properties that are of the string type have the max length applied defining the shape of the property

OpenAPI Schema Properties String Minlength Error

Schema properties that are of the string type have the min length applied defining the shape of the property

OpenAPI Schema Properties String Minlength Info

Schema properties that are of the string type have the min length applied defining the shape of the property

OpenAPI Schema Properties Array Items Error

Schema properties that are of the type array must have an items property defined

OpenAPI Schema Properties Array Items Info

Schema properties that are of the type array must have an items property defined

OpenAPI Schema Properties Array Maxitems Error

Schema properties that are of the type array needs a max items property defined

OpenAPI Schema Properties Array Maxitems Info

Schema properties that are of the type array needs a max items property defined

OpenAPI Schema Properties Array Minitems Error

Schema properties that are of the type array needs a min items property defined

OpenAPI Schema Properties Array Minitems Info

Schema properties that are of the type array needs a min items property defined

OpenAPI Schema Properties Define Number Maximum Error

Schema properties that are of the type number needs a maximum property defined

OpenAPI Schema Properties Define Number Minimum Error

Schema properties that are of the type number needs a minimum property defined

Strategies

Data Should Be Well-Defined and Validated

The schema behind your APIs is where the rubber meets the road. If your data does not have a well-known shape, if it is not validated on the way in and out, you are setting consumers up for surpris...