APIs.json Overlay Info

APIs should declare an OpenAPI Overlay so consumers can discover documented, reusable modifications applied to the API's OpenAPI definition. Declaring a property of type OpenAPIOverlay in the APIs.json properties array publishes this artifact as part of the API's discoverable index.

Message: Declares an OpenAPI Overlay.

Policies

OpenAPI Overlays Used

Require that consistent, cross-cutting changes to OpenAPI definitions be applied through OpenAPI Overlays rather than by hand-editing each specification. I want shared conventions, added examples, ...

#APIs.json #OpenAPI #Default

← 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/apis-json-overlay-info"

Full body (Pro)

curl "https://api.apievangelist.com/v1/rules/apis-json-overlay-info?include=content" \
  -H "x-api-key: $AE_KEY"

Related across the network

curl "https://api.apievangelist.com/v1/rules/apis-json-overlay-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

APIs.json Overlay Info

Policies

OpenAPI Overlays Used

Rule Details

Explore more

Discover APIs

Work with this as data

MCP tools for rules

Call it yourself

Get an API key