API Evangelist API Evangelist
API Learnings
Toolbox
API Evangelist LLC

Parameter Schema

Requiring that all operational parameters schema meets the policy standards.

Rules

OpenAPI Components Parameters Schema Error

Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what needs to be passed in

OpenAPI Components Parameters Schema Info

Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what needs to be passed in

OpenAPI Components Parameters Schema Ref Error

Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library

OpenAPI Components Parameters Schema Ref Info

Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library

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...