TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Settings Service API

8 actions 8 updates phrasing extends openapi/textql-settingsservice-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 8

$.info
$.paths['/textql.rpc.public.settings.SettingsService/CheckMemberStatus'].post
$.paths['/textql.rpc.public.settings.SettingsService/DeleteOrganizationMember'].post
$.paths['/textql.rpc.public.settings.SettingsService/GetOrganizationSettings'].post
$.paths['/textql.rpc.public.settings.SettingsService/InviteOrganizationMember'].post
$.paths['/textql.rpc.public.settings.SettingsService/ListOrganizationMembers'].post
$.paths['/textql.rpc.public.settings.SettingsService/UpdateOrganizationModelSettings'].post
$.paths['/textql.rpc.public.settings.SettingsService/UpdateOrganizationSettings'].post

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 Settings Service API
  version: 1.0.0
extends: openapi/textql-settingsservice-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: 7
- target: $.paths['/textql.rpc.public.settings.SettingsService/CheckMemberStatus'].post
  update:
    x-apievangelist-phrasing:
      intent: Check my membership status
      effect: read
      questions:
      - Is my TextQL membership active?
      - Can I force a fresh check of my member status instead of the cached one?
      instructions:
      - text: Check my member status.
      - text: Check my member status with force refresh set to {forceRefresh}.
        slots:
          forceRefresh: requestBody.forceRefresh
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.settings.SettingsService/DeleteOrganizationMember'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from the organization
      effect: destructive
      questions:
      - How do I remove someone from my organization?
      - Can I hard-delete a member rather than just deactivating them?
      instructions:
      - text: Remove member {memberId} from organization {orgId}.
        slots:
          memberId: requestBody.memberId
          orgId: requestBody.orgId
      - text: Hard-delete member {memberId}.
        slots:
          memberId: requestBody.memberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.settings.SettingsService/GetOrganizationSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: View organization settings
      effect: read
      questions:
      - What features and default models are configured for my organization?
      - Where can I see whether dashboards or secrets are enabled org-wide?
      instructions:
      - text: Show my organization's settings.
      - text: Fetch org settings with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.settings.SettingsService/InviteOrganizationMember'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to the organization
      effect: write
      questions:
      - How do I invite a coworker to my TextQL organization?
      - Can I choose a role for someone when I invite them?
      instructions:
      - text: Invite {email} to the organization.
        slots:
          email: requestBody.email
      - text: Invite {email} to org {orgId} with role {role}.
        slots:
          email: requestBody.email
          orgId: requestBody.orgId
          role: requestBody.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.settings.SettingsService/ListOrganizationMembers'].post
  update:
    x-apievangelist-phrasing:
      intent: List organization members
      effect: read
      questions:
      - Who are the members of my organization?
      - Which people currently have access to our org?
      instructions:
      - text: List members of organization {orgId}.
        slots:
          orgId: requestBody.orgId
      - text: Show everyone in my org.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.settings.SettingsService/UpdateOrganizationModelSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Set which AI models the organization can use
      effect: write
      questions:
      - How do I change the default model for my whole organization?
      - Can I restrict entire model families from being used?
      instructions:
      - text: Set the org default model to {defaultModel}.
        slots:
          defaultModel: requestBody.defaultModel
      - text: Enable only models {enabledModels} and restrict families {restrictedFamilies}.
        slots:
          enabledModels: requestBody.enabledModels
          restrictedFamilies: requestBody.restrictedFamilies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.settings.SettingsService/UpdateOrganizationSettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Update organization feature settings
      effect: write
      questions:
      - How do I turn dashboards or data apps on for my organization?
      - Can I disable sharing across the org?
      - Where do I set default connectors for new chats?
      instructions:
      - text: Set dashboards enabled to {dashboardsEnabled} for org {orgId}.
        slots:
          dashboardsEnabled: requestBody.dashboardsEnabled
          orgId: requestBody.orgId
      - text: Make {defaultConnectorIds} the default connectors for my org.
        slots:
          defaultConnectorIds: requestBody.defaultConnectorIds
      - text: Set sharing disabled to {sharingDisabled} org-wide.
        slots:
          sharingDisabled: requestBody.sharingDisabled
      method: generated
      generated: '2026-10-01'