Netlify · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/netlify-submission-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 5

$.info
$.paths['/sites/{site_id}/submissions'].get
$.paths['/forms/{form_id}/submissions'].get
$.paths['/submissions/{submission_id}'].get
$.paths['/submissions/{submission_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 Submission API
  version: 1.0.0
extends: openapi/netlify-submission-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: 4
- target: $.paths['/sites/{site_id}/submissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all form submissions for a site
      effect: read
      questions:
      - Where can I see every form submission across my whole site?
      - Can I page through all of a site's submissions regardless of form?
      instructions:
      - text: List all form submissions for site {site}.
        slots:
          site: path.site_id
      - text: Show every submission received across all forms on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/forms/{form_id}/submissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List submissions for one form
      effect: read
      questions:
      - How do I get the entries submitted to a specific form?
      - Can I page through submissions of a single form?
      instructions:
      - text: List submissions for form {form}.
        slots:
          form: path.form_id
      - text: Show entries received by form {form}, page {page}.
        slots:
          form: path.form_id
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/submissions/{submission_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form submission
      effect: read
      questions:
      - Can I look up a single form submission by its ID?
      - What data did one particular submission contain?
      instructions:
      - text: Get form submission {submission}.
        slots:
          submission: path.submission_id
      - text: Show the fields of submission {submission}.
        slots:
          submission: path.submission_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/submissions/{submission_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a form submission
      effect: destructive
      questions:
      - How do I delete a spam form submission?
      - Can I remove one entry from my form's submissions?
      instructions:
      - text: Delete form submission {submission}.
        slots:
          submission: path.submission_id
      - text: Remove spam submission {submission}.
        slots:
          submission: path.submission_id
      method: generated
      generated: '2026-09-26'