Netlify · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/netlify-function-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}/functions'].get
$.paths['/deploys/{deploy_id}/functions/{name}'].put

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 Function API
  version: 1.0.0
extends: openapi/netlify-function-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}/functions'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search a site's functions
      effect: read
      questions:
      - What serverless functions does my site have?
      - Can I filter a site's functions by name?
      instructions:
      - text: List functions for site {site}.
        slots:
          site: path.site_id
      - text: Search functions on site {site} matching {filter}.
        slots:
          site: path.site_id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deploys/{deploy_id}/functions/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a function to a deploy
      effect: write
      questions:
      - How do I upload a serverless function bundle to a deploy?
      - Can I set a function's runtime and timeout when uploading?
      instructions:
      - text: Upload function {name} to deploy {deploy}.
        slots:
          name: path.name
          deploy: path.deploy_id
      - text: Upload function {name} to deploy {deploy} with runtime {runtime} and timeout {timeout}.
        slots:
          name: path.name
          deploy: path.deploy_id
          runtime: query.runtime
          timeout: query.timeout
      method: generated
      generated: '2026-09-26'