Treasure Data · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/access_control/policies/{policy_id}/column_permissions'].get

$.paths['/access_control/policies/{policy_id}/column_permissions'].patch

$.paths['/access_control/policies/{policy_id}/permissions'].get

$.paths['/access_control/policies/{policy_id}/permissions'].patch

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 Treasure Data Access Control - Permissions API
  version: 1.0.0
extends: openapi/treasure-data-access-control-permissions-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: 4
- target: $.paths['/access_control/policies/{policy_id}/column_permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a policy's column permissions
      effect: read
      questions:
      - Which columns can a given access control policy see?
      - How do I check column-level permissions on a policy?
      instructions:
      - text: Show column permissions for policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: List the column-level access rules attached to policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/column_permissions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a policy's column permissions
      effect: write
      questions:
      - Can I restrict which columns a policy can access?
      - How do I change column-level access for a policy?
      instructions:
      - text: Set column permissions of policy {policy_id} to {column_permissions}.
        slots:
          policy_id: path.policy_id
          column_permissions: requestBody.column_permissions
      - text: Change which columns policy {policy_id} may read using {column_permissions}.
        slots:
          policy_id: path.policy_id
          column_permissions: requestBody.column_permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a policy's feature permissions
      effect: read
      questions:
      - What can a policy do across workflows, segments and databases?
      - How do I see all the permissions granted by an access control policy?
      instructions:
      - text: Show permissions for policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: List the workflow, segment and database permissions granted by policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/permissions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a policy's feature permissions
      effect: write
      questions:
      - Can I grant a policy access to specific databases or workflow projects?
      - How do I change what a policy allows in segmentation or journeys?
      instructions:
      - text: Update policy {policy_id} database permissions to {Databases}.
        slots:
          policy_id: path.policy_id
          Databases: requestBody.Databases
      - text: Set workflow project permissions on policy {policy_id} to {WorkflowProject}.
        slots:
          policy_id: path.policy_id
          WorkflowProject: requestBody.WorkflowProject
      method: generated
      generated: '2026-09-26'