TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL v2 Members API

7 actions 7 updates phrasing extends openapi/textql-members-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v2/members'].get
$.paths['/v2/members/invite'].post
$.paths['/v2/members/{id}'].delete
$.paths['/v2/members/{id}/roles'].get
$.paths['/v2/members/{id}/roles'].post
$.paths['/v2/members/{id}/roles/{roleId}'].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 TextQL v2 Members API
  version: 1.0.0
extends: openapi/textql-members-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: 6
- target: $.paths['/v2/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization members
      effect: read
      questions:
      - Who are the people in my TextQL organization?
      - Can I see each member's assigned role names in one list?
      instructions:
      - text: List the members of my organization.
      - text: Show every human member with their roles.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/members/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a member by email
      effect: write
      questions:
      - How do I invite a colleague to my organization?
      - Can I give someone a role at the moment I invite them?
      instructions:
      - text: Invite {email} to the organization.
        slots:
          email: requestBody.email
      - text: Invite {email} with the role {role}.
        slots:
          email: requestBody.email
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/members/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the organization
      effect: destructive
      questions:
      - How do I remove someone who left the company?
      - Can I permanently purge a member instead of soft deleting them?
      instructions:
      - text: Remove member {id} from the organization.
        slots:
          id: path.id
      - text: Delete member {id} with hard delete set to {hard_delete}.
        slots:
          id: path.id
          hard_delete: query.hard_delete
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/members/{id}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List a member's roles
      effect: read
      questions:
      - What roles does a particular member have?
      - How do I check one teammate's RBAC roles?
      instructions:
      - text: List the roles of member {id}.
        slots:
          id: path.id
      - text: Show which roles are assigned to member {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/members/{id}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a role to a member
      effect: write
      questions:
      - How do I give a member an additional role?
      - Can I change roles on a service account this way?
      instructions:
      - text: Assign role {role} to member {id}.
        slots:
          role: requestBody.roleId
          id: path.id
      - text: Give member {id} the {role} role.
        slots:
          id: path.id
          role: requestBody.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/members/{id}/roles/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a role from a member
      effect: destructive
      questions:
      - How do I take a role away from a member?
      - Can I revoke one RBAC role while leaving their others?
      instructions:
      - text: Remove role {role} from member {id}.
        slots:
          role: path.roleId
          id: path.id
      - text: Take the {role} role away from member {id}.
        slots:
          role: path.roleId
          id: path.id
      method: generated
      generated: '2026-10-01'