Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Data Access Control - Policies API

12 actions 12 updates phrasing extends openapi/treasure-data-access-control-policies-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 12

$.info
$.paths['/access_control/policies'].get
$.paths['/access_control/policies'].post
$.paths['/access_control/policies/{policy_id}'].get
$.paths['/access_control/policies/{policy_id}'].delete
$.paths['/access_control/policies/{policy_id}'].patch
$.paths['/access_control/users/{user_id}/policies'].get
$.paths['/access_control/users/{user_id}/policies'].patch
$.paths['/access_control/users/{user_id}/policies/{policy_id}'].post
$.paths['/access_control/users/{user_id}/policies/{policy_id}'].delete
$.paths['/access_control/policies/{policy_id}/users/{user_id}'].post
$.paths['/access_control/policies/{policy_id}/users/{user_id}'].delete

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 Data Access Control - Policies API
  version: 1.0.0
extends: openapi/treasure-data-access-control-policies-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: 11
- target: $.paths['/access_control/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List access control policies
      effect: read
      questions:
      - Which access control policies exist in my account?
      - Can I find the policies that use a particular column permission tag?
      instructions:
      - text: List all access control policies.
      - text: List the policies that use column permission tag {column_permission_tag}.
        slots:
          column_permission_tag: query.column_permission_tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access control policy
      effect: write
      questions:
      - How do I define a new access control policy in Treasure Data?
      - What goes into a new permission policy when I create one?
      instructions:
      - text: Create an access control policy from {policy}.
        slots:
          policy: requestBody.policy
      - text: Set up a new permission policy with definition {policy}.
        slots:
          policy: requestBody.policy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access control policy
      effect: read
      questions:
      - What does a specific access control policy contain?
      - Can I look up one policy's details by its ID?
      instructions:
      - text: Show access control policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Get the details of policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access control policy
      effect: destructive
      questions:
      - How do I remove an access control policy entirely?
      - Can a policy nobody needs anymore be deleted?
      instructions:
      - text: Delete access control policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Remove policy {policy_id} from the account.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an access control policy
      effect: write
      questions:
      - Can I edit the name or description of an existing policy?
      - Is it possible to change an access control policy after it is created?
      instructions:
      - text: Update access control policy {policy_id} with {policy}.
        slots:
          policy_id: path.policy_id
          policy: requestBody.policy
      - text: Edit the definition of policy {policy_id} to {policy}.
        slots:
          policy_id: path.policy_id
          policy: requestBody.policy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List the policies assigned to a user
      effect: read
      questions:
      - Which access control policies does a given user have?
      - What policies are currently attached to one team member?
      instructions:
      - text: List the policies assigned to user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show which access policies user {user_id} holds.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/policies'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace a user's set of policies
      effect: write
      questions:
      - Can I set a user's full list of policies in one call?
      - How do I replace every policy a user has with a new set?
      instructions:
      - text: Set user {user_id}'s policies to exactly {policy_ids}.
        slots:
          user_id: path.user_id
          policy_ids: requestBody.policy_ids
      - text: Replace all policies on user {user_id} with policies {policy_ids}.
        slots:
          user_id: path.user_id
          policy_ids: requestBody.policy_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/policies/{policy_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a policy to a user (user path)
      effect: write
      questions:
      - Can I add a single policy to a user through the user's policies path?
      - Is there a user-centric endpoint for granting one extra policy?
      instructions:
      - text: Under user {user_id}'s policies, add policy {policy_id}.
        slots:
          user_id: path.user_id
          policy_id: path.policy_id
      - text: Grant user {user_id} one more policy, {policy_id}, via the user policies route.
        slots:
          user_id: path.user_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/policies/{policy_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a policy from a user (user path)
      effect: destructive
      questions:
      - Can I take one policy away from a user through the user's policies path?
      - Is there a user-centric way to revoke a single policy?
      instructions:
      - text: Under user {user_id}'s policies, remove policy {policy_id}.
        slots:
          user_id: path.user_id
          policy_id: path.policy_id
      - text: Revoke policy {policy_id} from user {user_id} via the user policies route.
        slots:
          policy_id: path.policy_id
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/users/{user_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a user to a policy (policy path)
      effect: write
      questions:
      - Can I add a user to a policy starting from the policy's users path?
      - Is there a policy-centric endpoint for putting one more user on a policy?
      instructions:
      - text: Under policy {policy_id}'s users, add user {user_id}.
        slots:
          policy_id: path.policy_id
          user_id: path.user_id
      - text: Put user {user_id} on policy {policy_id} via the policy users route.
        slots:
          user_id: path.user_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/users/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a user from a policy (policy path)
      effect: destructive
      questions:
      - Can I drop a user from a policy starting from the policy's users path?
      - Is there a policy-centric way to take one user off a policy?
      instructions:
      - text: Under policy {policy_id}'s users, remove user {user_id}.
        slots:
          policy_id: path.policy_id
          user_id: path.user_id
      - text: Take user {user_id} off policy {policy_id} via the policy users route.
        slots:
          user_id: path.user_id
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'