Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Account Membership API

6 actions 6 updates phrasing extends openapi/netlify-account-membership-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['/accounts'].get
$.paths['/accounts'].post
$.paths['/accounts/{account_id}'].get
$.paths['/accounts/{account_id}'].put
$.paths['/accounts/{account_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 Account Membership API
  version: 1.0.0
extends: openapi/netlify-account-membership-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List my teams
      effect: read
      questions:
      - Which teams do I belong to?
      - Can I get a minimal list of my accounts?
      instructions:
      - text: List all teams I belong to.
      - text: 'List my accounts in minimal form: {minimal}.'
        slots:
          minimal: query.minimal
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team account
      effect: write
      questions:
      - How do I create a new team through the API?
      - Can I choose the plan type and billing period for a new team?
      instructions:
      - text: Create a team named {name} on plan type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type_id
      - text: Create team {name} with plan {type} billed {period}.
        slots:
          name: requestBody.name
          type: requestBody.type_id
          period: requestBody.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team account
      effect: read
      questions:
      - Can I see a team's plan and billing details?
      - What are the settings for one of my accounts?
      instructions:
      - text: Get team account {account}.
        slots:
          account: path.account_id
      - text: Show plan and billing details for account {account}.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{account_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a team account
      effect: write
      questions:
      - Can I rename my team or change its slug?
      - How do I update the billing email for a team?
      instructions:
      - text: Rename team {account} to {name}.
        slots:
          account: path.account_id
          name: requestBody.name
      - text: Set the billing email of account {account} to {email}.
        slots:
          account: path.account_id
          email: requestBody.billing_email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/accounts/{account_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a team account
      effect: destructive
      questions:
      - How do I cancel a team account?
      - Is cancelling a team permanent?
      instructions:
      - text: Cancel team account {account}.
        slots:
          account: path.account_id
      - text: Close account {account} permanently.
        slots:
          account: path.account_id
      method: generated
      generated: '2026-10-01'