Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Purge API

2 actions 2 updates phrasing extends openapi/netlify-purge-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/purge'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Netlify's API documentation Purge API
  version: 1.0.0
extends: openapi/netlify-purge-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/purge'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge cached content from the CDN
      effect: write
      questions:
      - How do I clear my site's CDN cache without redeploying?
      - Can I purge only the responses tagged with a certain cache tag?
      instructions:
      - text: Purge the CDN cache for site {site}.
        slots:
          site: requestBody.site_id
      - text: Purge cache tags {tags} for site {site}.
        slots:
          tags: requestBody.cache_tags
          site: requestBody.site_id
      method: generated
      generated: '2026-09-26'