How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us

OpenAPI Parameters Description Info

Every parameter needs a description. A named parameter with no description leaves a consumer, and any agent reading the contract as a tool definition, to infer meaning from the name alone.

#OpenAPI #Parameters #Descriptions
← Back to all Rules
Rule Details
Severity info
Given $.paths.*.*.parameters.*
Slug openapi-parameters-description-info
Explore more

Navigate related API building blocks.

All Rules Policies Guidance Schemas
Discover APIs
apis.io — API Search

Search across thousands of APIs on apis.io →

Work with this as data

Every rule here is available over the API and to AI agents over MCP.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

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-description-info"
Full body (Pro) 
curl "https://api.apievangelist.com/v1/rules/openapi-parameters-description-info?include=content" \
  -H "x-api-key: $AE_KEY"
Related across the network 
curl "https://api.apievangelist.com/v1/rules/openapi-parameters-description-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.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account