# 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 Build Hook API
  version: 1.0.0
extends: openapi/netlify-buildhook-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}/build_hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's build hooks
      effect: read
      questions:
      - What build hook URLs exist for my site?
      - Can I see all build hooks and their branches?
      instructions:
      - text: List build hooks for site {site}.
        slots:
          site: path.site_id
      - text: Show every build hook URL on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/build_hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a build hook
      effect: write
      questions:
      - How do I get a URL that triggers a build when a CMS publishes?
      - Can a build hook build a specific branch?
      instructions:
      - text: Create a build hook titled {title} on site {site}.
        slots:
          title: requestBody.title
          site: path.site_id
      - text: Add a build hook on site {site} that builds branch {branch}.
        slots:
          site: path.site_id
          branch: requestBody.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/build_hooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a build hook
      effect: read
      questions:
      - Which branch does a particular build hook build?
      - Can I retrieve a build hook's URL?
      instructions:
      - text: Get build hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      - text: Show the URL and branch of build hook {hook} for site {site}.
        slots:
          site: path.site_id
          hook: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/build_hooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a build hook
      effect: write
      questions:
      - Can I rename a build hook or change its branch?
      - How do I point an existing build hook at another branch?
      instructions:
      - text: Rename build hook {hook} on site {site} to {title}.
        slots:
          hook: path.id
          site: path.site_id
          title: requestBody.title
      - text: Point build 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}/build_hooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a build hook
      effect: destructive
      questions:
      - How do I revoke a build hook URL?
      - Can I delete a build hook that's been leaked?
      instructions:
      - text: Delete build hook {hook} from site {site}.
        slots:
          site: path.site_id
          hook: path.id
      - text: Revoke build hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      method: generated
      generated: '2026-09-26'