Netlify · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/netlify-service-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 4

$.info
$.paths['/services/'].get
$.paths['/services/{addonName}'].get
$.paths['/services/{addonName}/manifest'].get

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 Service API
  version: 1.0.0
extends: openapi/netlify-service-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: 3
- target: $.paths['/services/'].get
  update:
    x-apievangelist-phrasing:
      intent: List available add-on services
      effect: read
      questions:
      - What add-on services can I install?
      - Can I search the add-on catalog by name?
      instructions:
      - text: List all available add-on services.
      - text: Search add-on services for {term}.
        slots:
          term: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/{addonName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an add-on service
      effect: read
      questions:
      - Can I read the details of one add-on service?
      - What does a particular add-on do?
      instructions:
      - text: Get add-on service {addon}.
        slots:
          addon: path.addonName
      - text: Show details of the {addon} add-on.
        slots:
          addon: path.addonName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/services/{addonName}/manifest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an add-on's manifest
      effect: read
      questions:
      - Where do I find the configuration manifest for an add-on?
      - Which settings does an add-on require when installing it?
      instructions:
      - text: Get the manifest for add-on {addon}.
        slots:
          addon: path.addonName
      - text: Show the configuration manifest of {addon}.
        slots:
          addon: path.addonName
      method: generated
      generated: '2026-09-26'