TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Sandbox Admin Service API

10 actions 10 updates phrasing extends openapi/textql-sandboxadminservice-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 10

$.info
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/GetSandbox'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxEgress'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxExecutions'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxFiles'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxSpend'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxes'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ReadSandboxFile'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/RestartSandbox'].post
$.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/StopSandbox'].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 Sandbox Admin Service API
  version: 1.0.0
extends: openapi/textql-sandboxadminservice-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: 9
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/GetSandbox'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up a sandbox as an admin
      effect: read
      questions:
      - As an admin, how do I inspect any sandbox in my organization?
      - Who owns a given sandbox and what state is it in?
      instructions:
      - text: Get admin details for sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Show the owner and state of sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxEgress'].post
  update:
    x-apievangelist-phrasing:
      intent: Audit a sandbox's outbound network calls
      effect: read
      questions:
      - Which external URLs has a sandbox called out to?
      - Can I review the egress ledger of a sandbox that has already stopped?
      instructions:
      - text: List outbound HTTP calls made by sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Show the last {limit} egress records for sandbox {sandboxId}.
        slots:
          limit: requestBody.limit
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxExecutions'].post
  update:
    x-apievangelist-phrasing:
      intent: Audit executions in any sandbox
      effect: read
      questions:
      - As an admin, can I see every command another member ran in their sandbox?
      - How do I page through a sandbox's execution audit trail?
      instructions:
      - text: Audit executions for sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Page {limit} audited executions of sandbox {sandboxId} from cursor {cursor}.
        slots:
          limit: requestBody.limit
          sandboxId: requestBody.sandboxId
          cursor: requestBody.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxFiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Browse a running sandbox's filesystem as admin
      effect: read
      questions:
      - Can an admin browse the live files in someone's running sandbox?
      - Why does the sandbox file browser say unavailable for a stopped sandbox?
      instructions:
      - text: Browse the live filesystem of sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Show admin view of folder {path} in sandbox {sandboxId}.
        slots:
          path: requestBody.path
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxSpend'].post
  update:
    x-apievangelist-phrasing:
      intent: See compute usage for a sandbox
      effect: read
      questions:
      - How many compute units has a sandbox consumed?
      - Is sandbox spend reported in dollars or in ACUs?
      instructions:
      - text: Show per-lease compute usage for sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Report the ACU spend of sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ListSandboxes'].post
  update:
    x-apievangelist-phrasing:
      intent: List all sandboxes across the organization
      effect: read
      questions:
      - As an admin, how do I see every sandbox in the org regardless of owner?
      - Can the org-wide sandbox list be filtered by status?
      instructions:
      - text: List all org sandboxes with status {status}.
        slots:
          status: requestBody.status
      - text: Show {limit} sandboxes org-wide after cursor {cursor}.
        slots:
          limit: requestBody.limit
          cursor: requestBody.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/ReadSandboxFile'].post
  update:
    x-apievangelist-phrasing:
      intent: Read a file in a running sandbox as admin
      effect: read
      questions:
      - Can an admin open a specific file inside a member's live sandbox?
      - Does reading a sandbox file work once the worker has stopped?
      instructions:
      - text: Read file {path} from sandbox {sandboxId}.
        slots:
          path: requestBody.path
          sandboxId: requestBody.sandboxId
      - text: Open {path} in sandbox {sandboxId} for review.
        slots:
          path: requestBody.path
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/RestartSandbox'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart a stopped sandbox, keeping its owner
      effect: write
      questions:
      - How does an admin bring a reaped sandbox back to life?
      - Does restarting a sandbox keep the original owner?
      instructions:
      - text: Restart stopped sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Re-acquire a worker for reaped sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_admin.SandboxAdminService/StopSandbox'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop any sandbox as an admin
      effect: destructive
      questions:
      - Can an admin shut down a member's runaway sandbox?
      - What permission do I need to stop sandboxes I don't own?
      instructions:
      - text: Stop sandbox {sandboxId} as admin.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Force-stop the runaway sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'