Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Workflow Pool API

11 actions 11 updates phrasing extends openapi/treasure-data-pool-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Treasure Data's API. It is a proposal applied on top of the contract, not a document Treasure Data publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/api/pool_rules'].get
$.paths['/api/pool_rules'].post
$.paths['/api/pool_rules/{poolRuleId}'].get
$.paths['/api/pool_rules/{poolRuleId}'].delete
$.paths['/api/pool_rules/{poolRuleId}'].patch
$.paths['/api/pools'].get
$.paths['/api/pools'].post
$.paths['/api/pools/{poolId}'].get
$.paths['/api/pools/{poolId}'].delete
$.paths['/api/pools/{poolId}'].patch

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 Treasure Workflow Pool API
  version: 1.0.0
extends: openapi/treasure-data-pool-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/api/pool_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List pool rules
      effect: read
      questions:
      - Which rules decide what pool a workflow attempt runs in?
      - Can I see all my pool routing rules and their priorities?
      instructions:
      - text: List my pool rules.
      - text: Show every rule that routes attempts to pools.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pool_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a rule that routes attempts to a pool
      effect: write
      questions:
      - How do I send certain workflow attempts to a dedicated pool?
      - Can two pool rules share the same priority?
      instructions:
      - text: Create a pool rule with priority {priority} that sends attempts matching {conditions} to pool {poolId}.
        slots:
          priority: requestBody.priority
          conditions: requestBody.conditions
          poolId: requestBody.poolId
      - text: 'Add a routing rule: when {conditions}, assign attempts to pool {poolId} at priority {priority}.'
        slots:
          conditions: requestBody.conditions
          poolId: requestBody.poolId
          priority: requestBody.priority
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pool_rules/{poolRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pool rule
      effect: read
      questions:
      - What conditions and priority does a specific pool rule have?
      - Which pool does a given rule assign attempts to?
      instructions:
      - text: Show pool rule {poolRuleId}.
        slots:
          poolRuleId: path.poolRuleId
      - text: Get the conditions of pool rule {poolRuleId}.
        slots:
          poolRuleId: path.poolRuleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pool_rules/{poolRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pool rule
      effect: destructive
      questions:
      - How do I remove a pool routing rule?
      - Can I delete a rule so attempts fall back to the default pool?
      instructions:
      - text: Delete pool rule {poolRuleId}.
        slots:
          poolRuleId: path.poolRuleId
      - text: Remove routing rule {poolRuleId}.
        slots:
          poolRuleId: path.poolRuleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pool_rules/{poolRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pool rule
      effect: write
      questions:
      - Can I change the priority of an existing pool rule?
      - Is it possible to point a pool rule at a different pool?
      instructions:
      - text: Change the priority of pool rule {poolRuleId} to {priority}.
        slots:
          poolRuleId: path.poolRuleId
          priority: requestBody.priority
      - text: Make pool rule {poolRuleId} assign attempts to pool {poolId} instead.
        slots:
          poolRuleId: path.poolRuleId
          poolId: requestBody.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pools'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow pools
      effect: read
      questions:
      - What pools do I have and what are their concurrency limits?
      - Can I see the default pool alongside the ones I created?
      instructions:
      - text: List my pools.
      - text: Show all pools with their concurrency limits.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pools'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pool with a concurrency limit
      effect: write
      questions:
      - How do I reserve concurrency for a group of workflows with a new pool?
      - Does creating a pool take concurrency away from the default pool?
      instructions:
      - text: Create a pool named {name} with a concurrency limit of {concurrencyLimit}.
        slots:
          name: requestBody.name
          concurrencyLimit: requestBody.concurrencyLimit
      - text: Set up pool {name} allowing {concurrencyLimit} concurrent attempts.
        slots:
          name: requestBody.name
          concurrencyLimit: requestBody.concurrencyLimit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pools/{poolId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pool
      effect: read
      questions:
      - What is the concurrency limit of a particular pool?
      - Can I look up one pool's details by its ID?
      instructions:
      - text: Show pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Get the concurrency limit of pool {poolId}.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pools/{poolId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a pool
      effect: destructive
      questions:
      - Why can't I delete a pool that still has queued attempts?
      - What happens to a pool's concurrency when it is deleted?
      instructions:
      - text: Delete pool {poolId}.
        slots:
          poolId: path.poolId
      - text: Remove pool {poolId} and return its concurrency to the default pool.
        slots:
          poolId: path.poolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/pools/{poolId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a pool's name or concurrency limit
      effect: write
      questions:
      - Can I raise or lower the concurrency limit of an existing pool?
      - Is it possible to rename a pool I created?
      instructions:
      - text: Set the concurrency limit of pool {poolId} to {concurrencyLimit}.
        slots:
          poolId: path.poolId
          concurrencyLimit: requestBody.concurrencyLimit
      - text: Rename pool {poolId} to {name}.
        slots:
          poolId: path.poolId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'