# 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 Postgres API
  version: 1.0.0
extends: openapi/clickhouse-postgres-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: 17
- target: $.paths['/v1/organizations/{organizationId}/postgres'].get
  update:
    x-apievangelist-phrasing:
      intent: List managed Postgres services
      effect: read
      questions:
      - Which managed Postgres databases do we run in ClickHouse Cloud?
      - Can I see all the Postgres services in my organization?
      instructions:
      - text: List all Postgres services in org {org}.
        slots:
          org: path.organizationId
      - text: Show every managed PostgreSQL database in organization {org}.
        slots:
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a managed Postgres service
      effect: write
      questions:
      - How do I spin up a new managed Postgres database?
      - Can I choose the Postgres version and high-availability setup when creating a database?
      instructions:
      - text: Create a Postgres service named {name} on {provider} in {region} with size {size} in org {org}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          region: requestBody.region
          size: requestBody.size
          org: path.organizationId
      - text: Provision Postgres {postgresVersion} database {name} in {region} on {provider}, size {size}, HA type {haType}, for organization {org}.
        slots:
          postgresVersion: requestBody.postgresVersion
          name: requestBody.name
          region: requestBody.region
          provider: requestBody.provider
          size: requestBody.size
          haType: requestBody.haType
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Postgres service's details
      effect: read
      questions:
      - What's the current status of one of my Postgres databases?
      - What size and HA type is a particular Postgres service running?
      instructions:
      - text: Show Postgres service {postgres} in org {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      - text: Get the details of PostgreSQL database {postgres} in organization {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Postgres service
      effect: destructive
      questions:
      - How do I permanently delete a managed Postgres database?
      - Can I tear down a Postgres service I no longer need?
      instructions:
      - text: Delete Postgres service {postgres} in org {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      - text: Permanently remove PostgreSQL database {postgres} from organization {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or resize a Postgres service
      effect: write
      questions:
      - How do I resize an existing Postgres database?
      - Does renaming a Postgres service change its host name and certificates?
      instructions:
      - text: Resize Postgres service {postgres} in org {org} to {size}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          size: requestBody.size
      - text: Rename PostgreSQL database {postgres} in organization {org} to {name} and set HA type {haType}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          name: requestBody.name
          haType: requestBody.haType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/caCertificates'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a Postgres service's CA certificates
      effect: read
      questions:
      - Where do I get the CA certificate to connect to my Postgres database over TLS?
      - Can I download the certs needed to verify my Postgres server?
      instructions:
      - text: Download the CA certificates for Postgres service {postgres} in org {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      - text: Get the TLS CA certs for PostgreSQL database {postgres} in organization {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/restoredService'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a Postgres service to a new service
      effect: write
      questions:
      - How do I restore my Postgres database to a specific point in time?
      - Can I recover a Postgres database from continuous backup into a new service?
      instructions:
      - text: Restore Postgres service {postgres} in org {org} into a new service {name} at restore target {restoreTarget}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          name: requestBody.name
          restoreTarget: requestBody.restoreTarget
      - text: Do a point-in-time recovery of PostgreSQL database {postgres} in organization {org} to {restoreTarget}, naming it {name}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          restoreTarget: requestBody.restoreTarget
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/password'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reset a Postgres superuser password
      effect: write
      questions:
      - How do I reset the superuser password on my managed Postgres database?
      - Can I rotate the Postgres admin password through the API?
      instructions:
      - text: Set a new superuser password {password} on Postgres service {postgres} in org {org}.
        slots:
          password: requestBody.password
          postgres: path.postgresId
          org: path.organizationId
      - text: Rotate the superuser password for PostgreSQL database {postgres} in organization {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/state'].patch
  update:
    x-apievangelist-phrasing:
      intent: Restart, promote or switch over a Postgres service
      effect: write
      questions:
      - How do I restart a managed Postgres database?
      - Can I promote a Postgres read replica to become the primary?
      - How do I switch a primary over to its standby?
      instructions:
      - text: Restart Postgres service {postgres} in org {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      - text: Run command {command} on PostgreSQL service {postgres} in organization {org}.
        slots:
          command: requestBody.command
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/readReplica'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a read replica of a Postgres service
      effect: write
      questions:
      - How do I add a read replica to offload reads from my Postgres database?
      - Can a Postgres read replica have its own configuration and tags?
      instructions:
      - text: Create a read replica named {name} of Postgres service {postgres} in org {org}.
        slots:
          name: requestBody.name
          postgres: path.postgresId
          org: path.organizationId
      - text: Add read replica {name} tagged {tags} to PostgreSQL database {postgres} in organization {org}.
        slots:
          name: requestBody.name
          tags: requestBody.tags
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Postgres and PgBouncer configuration
      effect: read
      questions:
      - What Postgres parameters and PgBouncer settings is my database using?
      - How is connection pooling configured on my Postgres service?
      instructions:
      - text: Show the Postgres and PgBouncer configuration for service {postgres} in org {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      - text: Get the current pg config of PostgreSQL database {postgres} in organization {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/config'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace all Postgres and PgBouncer configuration
      effect: write
      questions:
      - How do I overwrite the entire Postgres and PgBouncer configuration at once?
      - Can I reset my database config by replacing it wholesale?
      instructions:
      - text: Replace the full config of Postgres service {postgres} in org {org} with pg config {pgConfig} and PgBouncer config {pgBouncerConfig}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          pgConfig: requestBody.pgConfig
          pgBouncerConfig: requestBody.pgBouncerConfig
      - text: Overwrite all settings on PostgreSQL database {postgres} in organization {org} with {pgConfig} and {pgBouncerConfig}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          pgConfig: requestBody.pgConfig
          pgBouncerConfig: requestBody.pgBouncerConfig
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change some Postgres or PgBouncer settings
      effect: write
      questions:
      - How do I tweak a few Postgres parameters without replacing the whole config?
      - Can I adjust just the PgBouncer pool settings on my database?
      instructions:
      - text: Update Postgres service {postgres} in org {org}, merging pg config {pgConfig} and PgBouncer config {pgBouncerConfig}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          pgConfig: requestBody.pgConfig
          pgBouncerConfig: requestBody.pgBouncerConfig
      - text: Tweak settings {pgConfig} and pooling {pgBouncerConfig} on PostgreSQL database {postgres} in organization {org}, leaving the rest.
        slots:
          pgConfig: requestBody.pgConfig
          pgBouncerConfig: requestBody.pgBouncerConfig
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get time-series metrics for a Postgres service
      effect: read
      questions:
      - How has my Postgres database's resource usage trended over the last day?
      - Can I choose the bucket size for Postgres time-series metrics?
      instructions:
      - text: Get metrics for Postgres service {postgres} in org {org} from {from_date} to {to_date}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
      - text: Chart PostgreSQL database {postgres} in organization {org} between {from_date} and {to_date} in {bucket_size_seconds}-second buckets.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
          bucket_size_seconds: query.bucket_size_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List the slowest query patterns on Postgres
      effect: read
      questions:
      - Which queries are slowing down my Postgres database?
      - Can I narrow slow query patterns to one database, user or application?
      - How do I sort slow queries by a metric and page through them?
      instructions:
      - text: List slow query patterns on Postgres service {postgres} in org {org} from {from_date} to {to_date}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
      - text: Show the slowest queries in database {db_name} run by {db_user} on {postgres} in organization {org} between {from_date} and {to_date}.
        slots:
          db_name: query.db_name
          db_user: query.db_user
          postgres: path.postgresId
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/slowQueryPatterns/{queryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one slow query pattern and recent runs
      effect: read
      questions:
      - What were the most recent executions of a particular slow query?
      - How long does one specific slow query pattern take on average?
      instructions:
      - text: Get slow query pattern {queryId} on Postgres service {postgres} in org {org} for database {db_name}, user {db_user}, operation {db_operation}.
        slots:
          queryId: path.queryId
          postgres: path.postgresId
          org: path.organizationId
          db_name: query.db_name
          db_user: query.db_user
          db_operation: query.db_operation
      - text: Show recent executions of query {queryId} by {db_user} ({db_operation} on {db_name}) for {postgres} in organization {org}.
        slots:
          queryId: path.queryId
          db_user: query.db_user
          db_operation: query.db_operation
          db_name: query.db_name
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Postgres server logs
      effect: read
      questions:
      - How do I pull Postgres server logs for a time window?
      - Can I filter Postgres logs to errors or to lines containing some text?
      - What's the maximum time range I can request logs for?
      instructions:
      - text: Get server logs for Postgres service {postgres} in org {org} from {from_date} to {to_date}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
      - text: Find {severity} log lines containing {body_contains} on {postgres} in organization {org} between {from_date} and {to_date}.
        slots:
          severity: query.severity
          body_contains: query.body_contains
          postgres: path.postgresId
          org: path.organizationId
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-09-26'