Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Treasure Data Access Control - Policy Groups API

8 actions 8 updates phrasing extends openapi/treasure-data-access-control-policy-groups-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 8

$.info
$.paths['/access_control/policy_groups'].get
$.paths['/access_control/policy_groups'].post
$.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}'].get
$.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}'].delete
$.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}'].patch
$.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}/policies'].get
$.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}/policies'].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 - Policy Groups API
  version: 1.0.0
extends: openapi/treasure-data-access-control-policy-groups-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: 7
- target: $.paths['/access_control/policy_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List policy groups
      effect: read
      questions:
      - Which access control policy groups exist in my account?
      - Can I see all the groups I use to bundle policies together?
      instructions:
      - text: List all policy groups.
      - text: Show every access control policy group in the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policy_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a policy group
      effect: write
      questions:
      - How do I create a group to organize related access policies?
      - What is required to start a new policy group?
      instructions:
      - text: Create a policy group named {name}.
        slots:
          name: requestBody.name
      - text: Start a new access control policy group called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a policy group
      effect: read
      questions:
      - What are the details of a particular policy group?
      - Can I look up a policy group by its ID or taggable name?
      instructions:
      - text: Show policy group {policy_group_id_or_taggable_name}.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      - text: Get the details of the {policy_group_id_or_taggable_name} policy group.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a policy group
      effect: destructive
      questions:
      - How do I remove a policy group I no longer need?
      - Can a policy group be deleted using its taggable name?
      instructions:
      - text: Delete policy group {policy_group_id_or_taggable_name}.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      - text: Remove the {policy_group_id_or_taggable_name} policy group.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a policy group
      effect: write
      questions:
      - Can I rename a policy group or change its description?
      - Is it possible to edit a policy group's name after it is created?
      instructions:
      - text: Rename policy group {policy_group_id_or_taggable_name} to {name}.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
          name: requestBody.name
      - text: Update policy group {policy_group_id_or_taggable_name} with name {name} and description {description}.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List the policies in a policy group
      effect: read
      questions:
      - Which policies belong to a given policy group?
      - Can I see what policies a group currently bundles?
      instructions:
      - text: List the policies in policy group {policy_group_id_or_taggable_name}.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      - text: Show which policies group {policy_group_id_or_taggable_name} contains.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/access_control/policy_groups/{policy_group_id_or_taggable_name}/policies'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set the policies in a policy group
      effect: write
      questions:
      - How do I change which policies are attached to a policy group?
      - Can I replace a group's policies with a new list in one call?
      instructions:
      - text: Set the policies of group {policy_group_id_or_taggable_name} to {policy_ids}.
        slots:
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
          policy_ids: requestBody.policy_ids
      - text: Attach policies {policy_ids} to policy group {policy_group_id_or_taggable_name}, replacing the current set.
        slots:
          policy_ids: requestBody.policy_ids
          policy_group_id_or_taggable_name: path.policy_group_id_or_taggable_name
      method: generated
      generated: '2026-09-26'