# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAPI spec for ClickHouse Cloud Role Management API
  version: 1.0.0
extends: openapi/clickhouse-role-management-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: 5
- target: $.paths['/v1/organizations/{organizationId}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's roles
      effect: read
      questions:
      - Which system and custom roles are available in my ClickHouse Cloud organization?
      - What roles can I assign to members and API keys?
      instructions:
      - text: List all roles in organization {org}.
        slots:
          org: path.organizationId
      - text: Show both system and custom roles defined for org {org}.
        slots:
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom organization role
      effect: write
      questions:
      - How do I create a custom role with its own permission policies?
      - Can I assign actors to a new role at the moment I create it?
      instructions:
      - text: Create a role named {name} in org {org} with policies {policies} and actors {actors}.
        slots:
          name: requestBody.name
          org: path.organizationId
          policies: requestBody.policies
          actors: requestBody.actors
      - text: Add a new custom role {name} to organization {org} granting {policies} to {actors}.
        slots:
          name: requestBody.name
          org: path.organizationId
          policies: requestBody.policies
          actors: requestBody.actors
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/roles/{roleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's policies and actors
      effect: read
      questions:
      - What permissions does a particular role grant?
      - Who is assigned to a given role?
      instructions:
      - text: Show role {roleId} in organization {org}.
        slots:
          roleId: path.roleId
          org: path.organizationId
      - text: List the policies and actors on role {roleId} in org {org}.
        slots:
          roleId: path.roleId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/roles/{roleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom organization role
      effect: destructive
      questions:
      - How do I delete a custom role and all its policies?
      - Can system roles be deleted?
      instructions:
      - text: Delete custom role {roleId} from organization {org}.
        slots:
          roleId: path.roleId
          org: path.organizationId
      - text: Remove role {roleId} and its policies in org {org}.
        slots:
          roleId: path.roleId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/roles/{roleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom organization role
      effect: write
      questions:
      - How do I add or remove actors from an existing custom role?
      - Can I change only a role's policies and leave its name alone?
      instructions:
      - text: Rename custom role {roleId} in org {org} to {name}.
        slots:
          roleId: path.roleId
          org: path.organizationId
          name: requestBody.name
      - text: Set the actors on existing role {roleId} in organization {org} to {actors}.
        slots:
          roleId: path.roleId
          org: path.organizationId
          actors: requestBody.actors
      - text: Replace the policies on role {roleId} in org {org} with {policies}.
        slots:
          roleId: path.roleId
          org: path.organizationId
          policies: requestBody.policies
      method: generated
      generated: '2026-09-26'