Requiring that all operational parameters type property meets the policy standards.
Parameter Types
Rules
OpenAPI Schema Properties Allowed Integer Format Error
Schema integer properties should have a format property with int32 or int64 applied
OpenAPI Schema Properties Allowed Number Format Error
Schema integer properties should have 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 should have a max items property defined
OpenAPI Schema Properties Array Maxitems Info
Schema properties that are of the type array should have a max items property defined
OpenAPI Schema Properties Array Minitems Error
Schema properties that are of the type array should have a min items property defined
OpenAPI Schema Properties Array Minitems Info
Schema properties that are of the type array should have a min items property defined
OpenAPI Schema Properties Define Number Maximum Error
Schema properties that are of the type number should have a maximum property defined
OpenAPI Schema Properties Define Number Minimum Error
Schema properties that are of the type number should have 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
API Parameters Are Well-Defined and Consistent
All API parameters must have clear names, descriptions, types, and constraints following consistent casing and naming conventions, with reusable parameters centralized in OpenAPI components to redu...
Operations Must Be Useful and Consistent
All individual API operations must be useful and follow consistent Internet, industry, and enterprise standards, providing a simple and relevant HTTP API operation that does one thing and does it w...
Lifecycle
design_services Design Design
Design is where the human experience of an API is won or lost. I work design-first, shaping the paths, schema, errors, and naming in the contract before development begins, so that consistency is b...
