API Evangelist conversational phrasing for OpenAPI spec for ClickHouse Cloud Organization API

# 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 Organization API
  version: 1.0.0
extends: openapi/clickhouse-organization-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['/v1/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the organization tied to my API key
      effect: read
      questions:
      - Which ClickHouse Cloud organization does my API key belong to?
      - How do I find my organization ID to use in other calls?
      instructions:
      - text: List the organizations available to my API key.
      - text: Look up the organization ID associated with this key.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization details
      effect: read
      questions:
      - What are the name and settings of my organization?
      - Are core dumps enabled for our organization?
      instructions:
      - text: Show details for organization {org}.
        slots:
          org: path.organizationId
      - text: Get the name and private endpoints configured on org {org}.
        slots:
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or reconfigure the organization
      effect: write
      questions:
      - How do I rename our organization?
      - Can I turn core dumps on or off for the whole organization?
      instructions:
      - text: Rename organization {org} to {name}.
        slots:
          org: path.organizationId
          name: requestBody.name
      - text: Set core dumps enabled to {enableCoreDumps} for org {org}.
        slots:
          enableCoreDumps: requestBody.enableCoreDumps
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/quotas'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization resource quotas and usage
      effect: read
      questions:
      - What resource limits apply to my organization and how close am I to them?
      - Did our quotas change after our billing status changed?
      instructions:
      - text: List all quotas and current usage for organization {org}.
        slots:
          org: path.organizationId
      - text: Show every limit enforced on org {org}.
        slots:
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/quotas/{quotaCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization quota by code
      effect: read
      questions:
      - What is the limit and current usage for one specific quota?
      - How many more of a given resource can we create before hitting the quota?
      instructions:
      - text: Get quota {quotaCode} for organization {org}.
        slots:
          quotaCode: path.quotaCode
          org: path.organizationId
      - text: Check usage against the {quotaCode} quota in org {org}.
        slots:
          quotaCode: path.quotaCode
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's activity log
      effect: read
      questions:
      - Who changed what in our organization over the last week?
      - Can I pull an audit trail of org activities between two dates?
      instructions:
      - text: List all activities in organization {org}.
        slots:
          org: path.organizationId
      - text: Show activity in org {org} from {from_date} to {to_date}.
        slots:
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/activities/{activityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization activity entry
      effect: read
      questions:
      - What exactly happened in a particular audit log entry?
      - Who performed a specific activity and when?
      instructions:
      - text: Show activity {activityId} in organization {org}.
        slots:
          activityId: path.activityId
          org: path.organizationId
      - text: Get the actor and timestamp for audit entry {activityId} in org {org}.
        slots:
          activityId: path.activityId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/privateEndpointConfig'].get
  update:
    x-apievangelist-phrasing:
      intent: Get org private endpoint config for a region (deprecated)
      effect: read
      questions:
      - What private endpoint configuration applies to a cloud region at the organization level?
      - Where is the older org-wide PrivateLink setup info for a given cloud provider?
      instructions:
      - text: Get the deprecated org-level private endpoint config for org {org} on {cloud_provider} in region {region_id}.
        slots:
          org: path.organizationId
          cloud_provider: query.cloud_provider
          region_id: query.region_id
      - text: Show organization {org}'s private endpoint settings for cloud {cloud_provider}, region {region_id}.
        slots:
          org: path.organizationId
          cloud_provider: query.cloud_provider
          region_id: query.region_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/byocInfrastructure'].post
  update:
    x-apievangelist-phrasing:
      intent: Create BYOC infrastructure in my cloud account
      effect: write
      questions:
      - How do I set up Bring Your Own Cloud infrastructure in my own account?
      - Can I choose the VPC CIDR range and availability zones for a BYOC deployment?
      instructions:
      - text: Create BYOC infrastructure for org {org} in account {accountId}, region {regionId}.
        slots:
          org: path.organizationId
          accountId: requestBody.accountId
          regionId: requestBody.regionId
      - text: Provision BYOC infrastructure named {displayName} in organization {org} using VPC CIDR {vpcCidrRange}.
        slots:
          displayName: requestBody.displayName
          org: path.organizationId
          vpcCidrRange: requestBody.vpcCidrRange
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove BYOC infrastructure
      effect: destructive
      questions:
      - How do I remove a Bring Your Own Cloud infrastructure from our organization?
      - Can I decommission BYOC infrastructure we no longer use?
      instructions:
      - text: Remove BYOC infrastructure {byoc} from organization {org}.
        slots:
          byoc: path.byocInfrastructureId
          org: path.organizationId
      - text: Delete the BYOC deployment {byoc} in org {org}.
        slots:
          byoc: path.byocInfrastructureId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/byocInfrastructure/{byocInfrastructureId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename BYOC infrastructure
      effect: write
      questions:
      - Can I change the display name of existing BYOC infrastructure?
      - What can I modify on a BYOC infrastructure after it's created?
      instructions:
      - text: Rename BYOC infrastructure {byoc} in org {org} to {displayName}.
        slots:
          byoc: path.byocInfrastructureId
          org: path.organizationId
          displayName: requestBody.displayName
      - text: Update the display name of BYOC deployment {byoc} in organization {org} to {displayName}.
        slots:
          byoc: path.byocInfrastructureId
          org: path.organizationId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'