Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Dev Server Hook API

6 actions 6 updates phrasing extends openapi/netlify-devserverhook-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}/dev_server_hooks'].get

$.paths['/sites/{site_id}/dev_server_hooks'].post

$.paths['/sites/{site_id}/dev_server_hooks/{id}'].get

$.paths['/sites/{site_id}/dev_server_hooks/{id}'].put

$.paths['/sites/{site_id}/dev_server_hooks/{id}'].delete

OpenAPI Overlay

# 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 Dev Server Hook API
  version: 1.0.0
extends: openapi/netlify-devserverhook-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}/dev_server_hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's dev server hooks
      effect: read
      questions:
      - Which dev server hooks are set up for my site?
      - Can I see URLs that start dev servers for a site?
      instructions:
      - text: List dev server hooks for site {site}.
        slots:
          site: path.site_id
      - text: Show every dev server hook on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/dev_server_hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dev server hook
      effect: write
      questions:
      - How do I create a hook URL that starts a dev server?
      - Can a dev server hook target a specific branch?
      instructions:
      - text: Create a dev server hook titled {title} on site {site}.
        slots:
          title: requestBody.title
          site: path.site_id
      - text: Add a {type} dev server hook on site {site} for branch {branch}.
        slots:
          type: requestBody.type
          site: path.site_id
          branch: requestBody.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/dev_server_hooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dev server hook
      effect: read
      questions:
      - Can I look up one dev server hook's settings?
      - Which branch does a dev server hook start?
      instructions:
      - text: Get dev server hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      - text: Show the branch and type of dev server hook {hook} for site {site}.
        slots:
          site: path.site_id
          hook: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/dev_server_hooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dev server hook
      effect: write
      questions:
      - Can I rename a dev server hook?
      - How do I change the branch a dev server hook uses?
      instructions:
      - text: Rename dev server hook {hook} on site {site} to {title}.
        slots:
          hook: path.id
          site: path.site_id
          title: requestBody.title
      - text: Point dev server hook {hook} on site {site} at branch {branch}.
        slots:
          hook: path.id
          site: path.site_id
          branch: requestBody.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/dev_server_hooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dev server hook
      effect: destructive
      questions:
      - How do I delete a dev server hook?
      - Can I revoke a URL that launches dev servers?
      instructions:
      - text: Delete dev server hook {hook} from site {site}.
        slots:
          site: path.site_id
          hook: path.id
      - text: Revoke dev server hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      method: generated
      generated: '2026-09-26'