TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Sandbox Query Service API

3 actions 3 updates phrasing extends openapi/textql-sandboxqueryservice-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 3

$.info

$.paths['/textql.rpc.public.sandbox_query.SandboxQueryService/ExecuteBash'].post

$.paths['/textql.rpc.public.sandbox_query.SandboxQueryService/ExecuteQuery'].post

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 TextQL Sandbox Query Service API
  version: 1.0.0
extends: openapi/textql-sandboxqueryservice-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: 2
- target: $.paths['/textql.rpc.public.sandbox_query.SandboxQueryService/ExecuteBash'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a bash script in my worker
      effect: write
      questions:
      - Can I run a shell script in my own sandbox worker?
      - How do I pass environment variables to a bash command?
      instructions:
      - text: Run the bash script {script}.
        slots:
          script: requestBody.script
      - text: Execute {script} in my worker with environment {env}.
        slots:
          script: requestBody.script
          env: requestBody.env
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_query.SandboxQueryService/ExecuteQuery'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a parameterized query in the sandbox
      effect: read
      questions:
      - How do I run a named source query from the sandbox with parameters?
      - Can I cap the rows returned by a sandbox query?
      instructions:
      - text: Run sandbox query source {source} on connector {connector}.
        slots:
          source: requestBody.sourceName
          connector: requestBody.connectorId
      - text: Execute source {source} with parameters {parameters}, returning at most {max_rows} rows.
        slots:
          source: requestBody.sourceName
          parameters: requestBody.parameters
          max_rows: requestBody.maxRows
      method: generated
      generated: '2026-10-01'