Requiring that all schema property descriptions meets the policy standards.
Schema Property Descriptions
Rules
OpenAPI Schema Properties Descriptions Error
Schema properties needs descriptions that provide a narrative of the property contains, and how it can be used
OpenAPI Schema Properties Descriptions Info
Schema properties needs descriptions that provide a narrative of the property contains, and how it can be used
OpenAPI Schema Properties Descriptions Length Error
Schema property descriptions needs a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs
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...