Netlify · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/netlify-form-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}/forms'].get
$.paths['/sites/{site_id}/forms/{form_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 Form API
  version: 1.0.0
extends: openapi/netlify-form-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}/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's forms
      effect: read
      questions:
      - Which forms has my site detected?
      - Can I see every form and its submission count?
      instructions:
      - text: List forms for site {site}.
        slots:
          site: path.site_id
      - text: Show all detected forms on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/forms/{form_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a form from a site
      effect: destructive
      questions:
      - How do I delete a form I no longer use?
      - Can I remove a form and stop collecting its submissions?
      instructions:
      - text: Delete form {form} from site {site}.
        slots:
          form: path.form_id
          site: path.site_id
      - text: Remove form {form} on site {site}.
        slots:
          form: path.form_id
          site: path.site_id
      method: generated
      generated: '2026-09-26'