OpenAPI Request Bodies Description Info

It is helpful to provide a description for request bodies, providing a simple explanation of what can be configured as part of the request payload

Message: Request Bodies Have a Description

Policies

Requiring that all operational request bodies meets the policy standards.

#OpenAPI #Request Bodies #Metadata

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.

curl for this page

This rule

curl "https://api.apievangelist.com/v1/rules/openapi-request-bodies-description-info"

Full body (Pro)

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

Related across the network

curl "https://api.apievangelist.com/v1/rules/openapi-request-bodies-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.