Add example values for properties in your OpenAPI file, to help API consumers better understand and configure valid API requests ![]()
Examples are also useful for tools like API Scan to auto-generate API tests. ![]()
ToolTip: API Audit verifies if your example matches the property schema.
If your example doesn’t match, it may confuse API consumers. Or, worse again, it might be a bug in your property definition that creates an API vulnerability. So it’s worth double-checking to make sure your examples are correct and up to date.
You’ll find these issues by filtering the Audit results for “info” severity…
