Netlify · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/netlify-member-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['/{account_slug}/members'].get

$.paths['/{account_slug}/members'].post

$.paths['/{account_slug}/members/{member_id}'].get

$.paths['/{account_slug}/members/{member_id}'].put

$.paths['/{account_slug}/members/{member_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 Member API
  version: 1.0.0
extends: openapi/netlify-member-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['/{account_slug}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a team's members
      effect: read
      questions:
      - Who are the members of my team?
      - Can I see each team member's role?
      instructions:
      - text: List members of team {team}.
        slots:
          team: path.account_slug
      - text: Show everyone in team {team} and their roles.
        slots:
          team: path.account_slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_slug}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a member to a team
      effect: write
      questions:
      - How do I invite someone to my Netlify team?
      - Can I choose a role when adding a team member?
      instructions:
      - text: Invite {email} to team {team}.
        slots:
          email: requestBody.email
          team: path.account_slug
      - text: Add {email} to team {team} as {role}.
        slots:
          email: requestBody.email
          team: path.account_slug
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_slug}/members/{member_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team member
      effect: read
      questions:
      - Can I look up one team member's role and access?
      - What sites can a given member access?
      instructions:
      - text: Get member {member} of team {team}.
        slots:
          team: path.account_slug
          member: path.member_id
      - text: Show the role and site access of member {member} in team {team}.
        slots:
          team: path.account_slug
          member: path.member_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_slug}/members/{member_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a team member's role or access
      effect: write
      questions:
      - How do I change a team member's role?
      - Can I limit a member to only certain sites?
      instructions:
      - text: Change member {member} in team {team} to role {role}.
        slots:
          member: path.member_id
          team: path.account_slug
          role: requestBody.role
      - text: Restrict member {member} of team {team} to sites {sites}.
        slots:
          member: path.member_id
          team: path.account_slug
          sites: requestBody.site_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_slug}/members/{member_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from a team
      effect: destructive
      questions:
      - How do I remove someone from my team?
      - Can I revoke a former employee's team access?
      instructions:
      - text: Remove member {member} from team {team}.
        slots:
          team: path.account_slug
          member: path.member_id
      - text: Revoke team {team} access for member {member}.
        slots:
          team: path.account_slug
          member: path.member_id
      method: generated
      generated: '2026-09-26'