OpenAPI Parameters Optional Examples

Optional parameters should include examples to support API mocking, testing, and documentation. While not strictly required, examples help consumers understand the range of acceptable values.

Message: Optional parameters SHOULD include examples.

#OpenAPI #Parameters #Examples #Mocking

← Back to all Rules

MCP tools for rules

6 tools reach this content

find_building_blocksBrowse every rules entry — call it with type="rules".
get_building_blockOne rules entry in full; add include=content for the body (Pro).
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.

All tools & prompts

Call it yourself

curl for this page

This rule

curl "https://api.apievangelist.com/v1/rules/openapi-parameters-optional-examples-info"

Full body (Pro)

curl "https://api.apievangelist.com/v1/rules/openapi-parameters-optional-examples-info?include=content" \
  -H "x-api-key: $AE_KEY"

Related across the network

curl "https://api.apievangelist.com/v1/rules/openapi-parameters-optional-examples-info/related"

All rules

curl "https://api.apievangelist.com/v1/rules?limit=25"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

OpenAPI Parameters Optional Examples

Rule Details

Explore more

Discover APIs

Work with this as data

MCP tools for rules

Call it yourself

Get an API key