Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Service Instance API

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

$.paths['/sites/{site_id}/services/{addon}/instances'].post

$.paths['/sites/{site_id}/services/{addon}/instances/{instance_id}'].get

$.paths['/sites/{site_id}/services/{addon}/instances/{instance_id}'].put

$.paths['/sites/{site_id}/services/{addon}/instances/{instance_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 Service Instance API
  version: 1.0.0
extends: openapi/netlify-serviceinstance-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}/service-instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List add-on instances on a site
      effect: read
      questions:
      - Which add-on services are installed on my site?
      - Can I see all service instances for a site?
      instructions:
      - text: List service instances for site {site}.
        slots:
          site: path.site_id
      - text: Show every add-on installed on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/services/{addon}/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Install an add-on on a site
      effect: write
      questions:
      - How do I add an add-on service to my site?
      - Can I install the same add-on on multiple sites?
      instructions:
      - text: Install add-on {addon} on site {site}.
        slots:
          addon: path.addon
          site: path.site_id
      - text: Create a {addon} service instance for site {site}.
        slots:
          addon: path.addon
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/services/{addon}/instances/{instance_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an add-on instance
      effect: read
      questions:
      - Can I see the configuration of an installed add-on?
      - What's the status of an add-on instance on my site?
      instructions:
      - text: Get {addon} instance {instance} on site {site}.
        slots:
          site: path.site_id
          addon: path.addon
          instance: path.instance_id
      - text: Show details of add-on instance {instance} ({addon}) for site {site}.
        slots:
          site: path.site_id
          addon: path.addon
          instance: path.instance_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/services/{addon}/instances/{instance_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an add-on instance
      effect: write
      questions:
      - Can I change the settings of an installed add-on?
      - How do I reconfigure an add-on instance?
      instructions:
      - text: Update {addon} instance {instance} on site {site}.
        slots:
          site: path.site_id
          addon: path.addon
          instance: path.instance_id
      - text: Reconfigure add-on instance {instance} of {addon} for site {site}.
        slots:
          site: path.site_id
          addon: path.addon
          instance: path.instance_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/services/{addon}/instances/{instance_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an add-on from a site
      effect: destructive
      questions:
      - How do I uninstall an add-on from my site?
      - Can I delete a service instance I no longer use?
      instructions:
      - text: Remove {addon} instance {instance} from site {site}.
        slots:
          site: path.site_id
          addon: path.addon
          instance: path.instance_id
      - text: Uninstall add-on {addon} (instance {instance}) on site {site}.
        slots:
          site: path.site_id
          addon: path.addon
          instance: path.instance_id
      method: generated
      generated: '2026-09-26'