Netlify · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/netlify-metadata-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 3

$.info
$.paths['/sites/{site_id}/metadata'].get
$.paths['/sites/{site_id}/metadata'].put

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 Metadata API
  version: 1.0.0
extends: openapi/netlify-metadata-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: 2
- target: $.paths['/sites/{site_id}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site's metadata
      effect: read
      questions:
      - What custom metadata is stored on my site?
      - Can I read the key-value metadata attached to a site?
      instructions:
      - text: Get metadata for site {site}.
        slots:
          site: path.site_id
      - text: Show the custom metadata stored on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a site's metadata
      effect: write
      questions:
      - Can I attach my own metadata to a site?
      - How do I change the metadata saved on a site?
      instructions:
      - text: Update metadata for site {site}.
        slots:
          site: path.site_id
      - text: Replace the custom metadata on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'