# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Overview Memberships API
  version: 1.0.0
extends: openapi/aftership-memberships-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['/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization memberships
      effect: read
      questions:
      - Who are the members of my AfterShip organization?
      - Can I find a member by email?
      instructions:
      - text: List all memberships.
      - text: Find the membership for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a member with a role
      effect: write
      questions:
      - How do I invite a teammate into my organization?
      - Can I give a new member a specific role?
      instructions:
      - text: Add account {account} as a member with role {role}.
        slots:
          account: requestBody.account
          role: requestBody.role
      - text: Create a membership for {account} with the {role} role.
        slots:
          account: requestBody.account
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a membership by ID
      effect: read
      questions:
      - What role does a particular member have?
      - Can I look up one membership by its ID?
      instructions:
      - text: Show membership {id}.
        slots:
          id: path.id
      - text: Get the role and account for membership {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the organization
      effect: destructive
      questions:
      - How do I remove someone from my organization?
      - Can I revoke a teammate's membership?
      instructions:
      - text: Delete membership {id}.
        slots:
          id: path.id
      - text: Remove member {id} from the organization.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/memberships/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a member's role
      effect: write
      questions:
      - How do I change what role a teammate has?
      - Can I promote a member to a different role?
      instructions:
      - text: Change membership {id} to role {role}.
        slots:
          id: path.id
          role: requestBody.role
      - text: Give member {id} the {role} role.
        slots:
          id: path.id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'