Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for llm-api Text Resource API

6 actions 6 updates phrasing extends openapi/treasure-data-textresource-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 6

$.info
$.paths['/api/text_resources'].get
$.paths['/api/text_resources'].post
$.paths['/api/text_resources/{id}'].get
$.paths['/api/text_resources/{id}'].delete
$.paths['/api/text_resources/{id}'].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 llm-api Text Resource API
  version: 1.0.0
extends: openapi/treasure-data-textresource-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: 5
- target: $.paths['/api/text_resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List text resources
      effect: read
      questions:
      - Which text resources are available to my Treasure Data AI agents?
      - Can I search text resources by full text or by name?
      - How do I sort the list of text resources?
      instructions:
      - text: Find text resources containing {fulltext}.
        slots:
          fulltext: query.filter[fulltext]
      - text: List text resources named {name}.
        slots:
          name: query.filter[name]
      - text: List all my text resources sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a text resource
      effect: write
      questions:
      - How do I add a block of reference text for my agents to use?
      - What does a request to create a text resource need?
      instructions:
      - text: Create a text resource with {data}.
        slots:
          data: requestBody.data
      - text: Add a new text resource using {data}.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_resources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a text resource
      effect: read
      questions:
      - What does one particular text resource contain?
      - Can I fetch a text resource by its ID?
      instructions:
      - text: Show text resource {id}.
        slots:
          id: path.id
      - text: Fetch the content of text resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_resources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a text resource
      effect: destructive
      questions:
      - How do I remove a text resource?
      - Is deleting a text resource reversible?
      instructions:
      - text: Delete text resource {id}.
        slots:
          id: path.id
      - text: Remove the outdated text resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/text_resources/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a text resource
      effect: write
      questions:
      - Can I edit the content of an existing text resource?
      - What fields of a text resource can be changed?
      instructions:
      - text: Update text resource {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Edit the existing text resource {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'