Treasure Data · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/access_control/users'].get
$.paths['/access_control/users/{user_id}'].get
$.paths['/access_control/users/{user_id}/permissions'].patch
$.paths['/access_control/users/{user_id}/profile_options'].get
$.paths['/access_control/users/{user_id}/profile_options/{key}'].get
$.paths['/access_control/users/{user_id}/profile_options/{key}'].put
$.paths['/access_control/users/{user_id}/profile_options/{key}'].delete
$.paths['/access_control/policies/{policy_id}/users'].get
$.paths['/access_control/policies/{policy_id}/users'].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 Data Access Control - Users API
  version: 1.0.0
extends: openapi/treasure-data-access-control-users-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: 9
- target: $.paths['/access_control/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users and their permissions
      effect: read
      questions:
      - Who are the users in my account and what permissions does each have?
      - Can I audit every user's access control permissions at once?
      instructions:
      - text: List all users with their permissions.
      - text: Show me every account user and what they can access.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's access control details
      effect: read
      questions:
      - What permissions does a specific user currently have?
      - Can I look up a single user's access control record?
      instructions:
      - text: Show access control details for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Get the permissions record of user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/permissions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's permissions
      effect: write
      questions:
      - How do I give a user access to workflow projects or segment folders?
      - Can I change what a user may do with activation templates?
      instructions:
      - text: Update user {user_id}'s workflow project permissions to {WorkflowProject}.
        slots:
          user_id: path.user_id
          WorkflowProject: requestBody.WorkflowProject
      - text: Set user {user_id}'s segment folder permissions to {SegmentFolder}.
        slots:
          user_id: path.user_id
          SegmentFolder: requestBody.SegmentFolder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/profile_options'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's profile options
      effect: read
      questions:
      - Which profile options apply to a user and what are their resolved values?
      - Can I see all of one user's profile settings at once?
      instructions:
      - text: List all profile options for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show every resolved profile setting of user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/profile_options/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one profile option for a user
      effect: read
      questions:
      - What value does a single profile option resolve to for a given user?
      - Can I check just one profile setting for a user by its key?
      instructions:
      - text: Get profile option {key} for user {user_id}.
        slots:
          key: path.key
          user_id: path.user_id
      - text: Look up user {user_id}'s value for the {key} profile option.
        slots:
          user_id: path.user_id
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/profile_options/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a profile option for a user
      effect: write
      questions:
      - Can an admin override a profile option for one user?
      - Who is allowed to set a user's profile option value?
      instructions:
      - text: Set profile option {key} for user {user_id} to {value}.
        slots:
          key: path.key
          user_id: path.user_id
          value: requestBody.value
      - text: Override user {user_id}'s {key} setting with value {value}.
        slots:
          user_id: path.user_id
          key: path.key
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/users/{user_id}/profile_options/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a user's profile option to the default
      effect: destructive
      questions:
      - How do I revert a user's profile option back to the account default?
      - Can I remove a per-user profile override?
      instructions:
      - text: Remove profile option {key} from user {user_id}.
        slots:
          key: path.key
          user_id: path.user_id
      - text: Reset user {user_id}'s {key} setting to the account default.
        slots:
          user_id: path.user_id
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users on a policy
      effect: read
      questions:
      - Which users are attached to a given access policy?
      - Who is covered by a specific policy right now?
      instructions:
      - text: List the users attached to policy {policy_id}.
        slots:
          policy_id: path.policy_id
      - text: Show who is on policy {policy_id}.
        slots:
          policy_id: path.policy_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policies/{policy_id}/users'].patch
  update:
    x-apievangelist-phrasing:
      intent: Replace the users on a policy
      effect: write
      questions:
      - Can I set the complete list of users on a policy in one request?
      - How do I replace everyone attached to a policy with a new group of users?
      instructions:
      - text: Set the users on policy {policy_id} to {user_ids}.
        slots:
          policy_id: path.policy_id
          user_ids: requestBody.user_ids
      - text: Replace policy {policy_id}'s user list with users {user_ids}.
        slots:
          policy_id: path.policy_id
          user_ids: requestBody.user_ids
      method: generated
      generated: '2026-09-26'