Netlify · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/netlify-snippet-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 6

$.info
$.paths['/sites/{site_id}/snippets'].get
$.paths['/sites/{site_id}/snippets'].post
$.paths['/sites/{site_id}/snippets/{snippet_id}'].get
$.paths['/sites/{site_id}/snippets/{snippet_id}'].put
$.paths['/sites/{site_id}/snippets/{snippet_id}'].delete

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 Snippet API
  version: 1.0.0
extends: openapi/netlify-snippet-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: 5
- target: $.paths['/sites/{site_id}/snippets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's injected snippets
      effect: read
      questions:
      - What script snippets are injected into my site's pages?
      - Can I see all snippet injections on a site?
      instructions:
      - text: List snippets for site {site}.
        slots:
          site: path.site_id
      - text: Show every injected snippet on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/snippets'].post
  update:
    x-apievangelist-phrasing:
      intent: Inject a snippet into a site
      effect: write
      questions:
      - How do I add an analytics script to every page of my site?
      - Can I inject code before the closing head or body tag?
      instructions:
      - text: Add a snippet titled {title} to site {site} with code {code}.
        slots:
          title: requestBody.title
          site: path.site_id
          code: requestBody.general
      - text: Inject {code} into site {site} at position {position}.
        slots:
          code: requestBody.general
          site: path.site_id
          position: requestBody.general_position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/snippets/{snippet_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an injected snippet
      effect: read
      questions:
      - Can I view the code of one injected snippet?
      - Where on the page is a particular snippet inserted?
      instructions:
      - text: Get snippet {snippet} on site {site}.
        slots:
          site: path.site_id
          snippet: path.snippet_id
      - text: Show the code and position of snippet {snippet} for site {site}.
        slots:
          site: path.site_id
          snippet: path.snippet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/snippets/{snippet_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an injected snippet
      effect: write
      questions:
      - Can I edit a snippet that's already injected?
      - How do I move a snippet to a different place in the page?
      instructions:
      - text: Replace the code of snippet {snippet} on site {site} with {code}.
        slots:
          snippet: path.snippet_id
          site: path.site_id
          code: requestBody.general
      - text: Move snippet {snippet} on site {site} to position {position}.
        slots:
          snippet: path.snippet_id
          site: path.site_id
          position: requestBody.general_position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/snippets/{snippet_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an injected snippet
      effect: destructive
      questions:
      - How do I stop injecting a script into my site?
      - Can I delete one snippet from a site?
      instructions:
      - text: Delete snippet {snippet} from site {site}.
        slots:
          site: path.site_id
          snippet: path.snippet_id
      - text: Stop injecting snippet {snippet} on site {site}.
        slots:
          site: path.site_id
          snippet: path.snippet_id
      method: generated
      generated: '2026-09-26'