TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Teams Service API

9 actions 9 updates phrasing extends openapi/textql-teamsservice-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 9

$.info
$.paths['/textql.rpc.public.teams.TeamsService/CreateTeamsUuid'].post
$.paths['/textql.rpc.public.teams.TeamsService/DeleteInstallation'].post
$.paths['/textql.rpc.public.teams.TeamsService/GetCurrentUser'].post
$.paths['/textql.rpc.public.teams.TeamsService/HandleTeamsOAuthCallback'].post
$.paths['/textql.rpc.public.teams.TeamsService/ListChannels'].post
$.paths['/textql.rpc.public.teams.TeamsService/ListInstallations'].post
$.paths['/textql.rpc.public.teams.TeamsService/ListUsers'].post
$.paths['/textql.rpc.public.teams.TeamsService/SyncWorkspace'].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 Teams Service API
  version: 1.0.0
extends: openapi/textql-teamsservice-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: 8
- target: $.paths['/textql.rpc.public.teams.TeamsService/CreateTeamsUuid'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a linking ID for a Teams install
      effect: write
      questions:
      - How do I start connecting TextQL to Microsoft Teams?
      - What is the Teams UUID used for when installing the bot?
      instructions:
      - text: Create a Teams linking UUID for my org.
      - text: Generate a new Teams install UUID, timing out after {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/DeleteInstallation'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a Teams installation
      effect: destructive
      questions:
      - How do I disconnect a Teams tenant from TextQL?
      - Can I uninstall the Teams integration for just one tenant?
      instructions:
      - text: Delete the Teams installation for tenant {tenantId}.
        slots:
          tenantId: requestBody.tenantId
      - text: Uninstall Teams from tenant {tenantId}.
        slots:
          tenantId: requestBody.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/GetCurrentUser'].post
  update:
    x-apievangelist-phrasing:
      intent: Get my linked Teams user
      effect: read
      questions:
      - Which Teams account is linked to my TextQL login?
      - Has my Teams identity been connected yet?
      instructions:
      - text: Show my linked Teams user.
      - text: Fetch the current Teams user within {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/HandleTeamsOAuthCallback'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete the Teams OAuth sign-in
      effect: write
      questions:
      - After Teams redirects back, how do I finish the OAuth connection?
      - What code and state does the Teams callback need?
      instructions:
      - text: Complete Teams OAuth with code {code} and state {state}.
        slots:
          code: requestBody.code
          state: requestBody.state
      - text: Handle the Teams callback using authorization code {code}.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/ListChannels'].post
  update:
    x-apievangelist-phrasing:
      intent: List Teams channels available to TextQL
      effect: read
      questions:
      - Which Teams channels can TextQL post into?
      - How do I pick a Teams channel for agent notifications?
      instructions:
      - text: List the Teams channels I can use.
      - text: Show Teams channels with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/ListInstallations'].post
  update:
    x-apievangelist-phrasing:
      intent: List Teams installations
      effect: read
      questions:
      - Which Teams tenants have the TextQL app installed?
      - Is the Teams integration installed anywhere in my org?
      instructions:
      - text: List all Teams installations.
      - text: Show installed Teams tenants, waiting up to {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/ListUsers'].post
  update:
    x-apievangelist-phrasing:
      intent: List users from the connected Teams workspace
      effect: read
      questions:
      - Which Teams users has TextQL synced?
      - Can I see the Teams members available for mapping to TextQL accounts?
      instructions:
      - text: List users from Teams.
      - text: Show synced Teams users with a {timeout_ms} ms deadline.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.teams.TeamsService/SyncWorkspace'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync users and channels from a Teams tenant
      effect: write
      questions:
      - How do I refresh the users and channels TextQL knows from Teams?
      - Can I re-sync just one Teams tenant?
      instructions:
      - text: Sync the Teams workspace for tenant {tenantId}.
        slots:
          tenantId: requestBody.tenantId
      - text: Refresh Teams users and channels from tenant {tenantId}.
        slots:
          tenantId: requestBody.tenantId
      method: generated
      generated: '2026-10-01'