Requiring that all schema descriptions meets the policy standards.
Schema Descriptions
Rules
OpenAPI Schema Description Error
Schema needs descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected
OpenAPI Schema Description Info
Schema needs descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected
OpenAPI Schema Description Length Error
Schema needs a length limit applied, restricting how long schema descriptions can be, helping keep them concise and consistent
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...