Requiring that all operational parameters type property meets the policy standards.
Parameter Types
Rules
OpenAPI Schema Properties Allowed Integer Format Error
Schema integer properties needs a format property with int32 or int64 applied
OpenAPI Schema Properties Allowed Number Format Error
Schema integer properties needs a format property with int32 or int64 applied
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
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
Strategies
Operations Must Be Useful and Consistent
Every API operation should do one thing and do it well. That is the Unix philosophy applied to APIs and it still holds up. When your operations follow common standards with consistent naming, clear...
API Parameters Are Well-Defined and Consistent
Parameters are part of the surface area that consumers interact with on every single call, and when they are inconsistent--different casing, unclear names, missing descriptions--it creates friction...