# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Operational Database service Opdb API
  version: 1.0.0
extends: openapi/cloudera-opdb-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 19
- target: $.paths['/api/v1/opdb/collectDiagnostics'].post
  update:
    x-apievangelist-phrasing:
      intent: Collect a diagnostic bundle from an operational database
      effect: write
      questions:
      - How do I gather diagnostic bundles from my operational database for support?
      - Can I attach a support case number to an OpDB diagnostics collection?
      instructions:
      - text: Collect diagnostics from database {databaseName} in {environmentName} up to {endTime}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          endTime: requestBody.endTime
      - text: Gather a diagnostic bundle for {databaseName} in {environmentName} from {startTime} to {endTime} for case {caseNumber}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          startTime: requestBody.startTime
          endTime: requestBody.endTime
          caseNumber: requestBody.caseNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/createDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an operational database
      effect: write
      questions:
      - How do I spin up a new operational database in a CDP environment?
      - Can I turn on autoscaling and Grafana when I create an operational database?
      instructions:
      - text: Create operational database {databaseName} in environment {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Create a new OpDB called {databaseName} in {environmentName} with {numEdgeNodes} edge nodes.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          numEdgeNodes: requestBody.numEdgeNodes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/createSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Snapshot a table in an operational database
      effect: write
      questions:
      - How can I take a snapshot of a single table in my operational database?
      - Where do OpDB table snapshots get written?
      instructions:
      - text: Snapshot table {tableName} in {databaseName} ({environmentName}) as {snapshotName} at {snapshotLocation}.
        slots:
          tableName: requestBody.tableName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          snapshotName: requestBody.snapshotName
          snapshotLocation: requestBody.snapshotLocation
      - text: Take a table snapshot named {snapshotName} of {tableName} in database {databaseName}, environment {environmentName}, stored at {snapshotLocation}.
        slots:
          snapshotName: requestBody.snapshotName
          tableName: requestBody.tableName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          snapshotLocation: requestBody.snapshotLocation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/deleteSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a table snapshot
      effect: destructive
      questions:
      - How do I get rid of an old table snapshot in my operational database?
      - Can a snapshot deletion be forced?
      instructions:
      - text: Delete snapshot {snapshotName} from database {databaseName} in {environmentName}.
        slots:
          snapshotName: requestBody.snapshotName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Force-remove snapshot {snapshotName} on {databaseName} in environment {environmentName}.
        slots:
          snapshotName: requestBody.snapshotName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/describeClientConnectivity'].post
  update:
    x-apievangelist-phrasing:
      intent: Get client connection details for a database
      effect: read
      questions:
      - How do my applications connect programmatically to my operational database?
      - What client connectivity details does an OpDB expose?
      instructions:
      - text: Show client connectivity details for {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Get the connection info my app needs for OpDB {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/describeDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Describe an operational database
      effect: read
      questions:
      - What's the current configuration and state of my operational database?
      - Can I see the details of a single OpDB by name?
      instructions:
      - text: Describe operational database {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Show me the details of OpDB {databaseName} in environment {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/describeUpgradeDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a database upgrade is available
      effect: read
      questions:
      - Is there an upgrade available for my operational database?
      - Which runtime could my OpDB be upgraded to?
      instructions:
      - text: Check upgrade availability for database {database} in {environment}.
        slots:
          database: requestBody.database
          environment: requestBody.environment
      - text: Tell me if OpDB {database} in {environment} can be upgraded.
        slots:
          database: requestBody.database
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/dropDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Drop an operational database
      effect: destructive
      questions:
      - How do I permanently drop an operational database?
      - Can I force the drop of an OpDB that won't delete cleanly?
      instructions:
      - text: Drop operational database {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Force-drop OpDB {databaseName} from environment {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/listDatabases'].post
  update:
    x-apievangelist-phrasing:
      intent: List operational databases
      effect: read
      questions:
      - Which operational databases are running in my environment?
      - Can I list every OpDB across all environments?
      instructions:
      - text: List the operational databases in {environmentName}.
        slots:
          environmentName: requestBody.environmentName
      - text: Show all my operational databases.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/listDiagnostics'].post
  update:
    x-apievangelist-phrasing:
      intent: List diagnostic collections for a database
      effect: read
      questions:
      - What diagnostic bundles have already been collected for my operational database?
      - Can I see past diagnostics collections for one OpDB?
      instructions:
      - text: List diagnostics collections for {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Show previous diagnostic bundles gathered from OpDB {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/listRestoreSnapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: List snapshot restores into a database
      effect: read
      questions:
      - When was a snapshot last restored into my operational database?
      - Can I filter snapshot restore history by a restore time window?
      instructions:
      - text: List snapshot restores into {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Show restore history of snapshot {snapshotName} into {databaseName} ({environmentName}) since {fromRestoreTime}.
        slots:
          snapshotName: requestBody.snapshotName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          fromRestoreTime: requestBody.fromRestoreTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/listSnapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: List table snapshots in a database
      effect: read
      questions:
      - What table snapshots exist for my operational database?
      - Can I list snapshots for one table created within a date range?
      instructions:
      - text: List snapshots in {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Show snapshots of table {tableName} in {databaseName} ({environmentName}) created after {fromCreationTime}.
        slots:
          tableName: requestBody.tableName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          fromCreationTime: requestBody.fromCreationTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/listSupportedEnvironments'].post
  update:
    x-apievangelist-phrasing:
      intent: List environments that can host an operational database
      effect: read
      questions:
      - Which of my environments can I create an operational database in?
      - Are any environments eligible for a new OpDB yet?
      instructions:
      - text: List environments available for operational database creation.
      - text: Show which environments support creating an OpDB.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/prepareUpgradeDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare an operational database for upgrade
      effect: write
      questions:
      - How do I run the pre-upgrade validations on my operational database?
      - Can parcels be staged ahead of an OpDB upgrade to a specific runtime?
      instructions:
      - text: Prepare database {database} in {environment} for upgrade.
        slots:
          database: requestBody.database
          environment: requestBody.environment
      - text: Validate and stage parcels to upgrade OpDB {database} in {environment} to runtime {runtime}.
        slots:
          database: requestBody.database
          environment: requestBody.environment
          runtime: requestBody.runtime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/restoreSnapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a snapshot into a database
      effect: write
      questions:
      - How do I restore a table snapshot into another operational database?
      - Can a snapshot be restored into a database in a different environment?
      instructions:
      - text: Restore snapshot {snapshotName} from {databaseName} ({environmentName}) into {targetDatabaseName} in {targetEnvironmentName}.
        slots:
          snapshotName: requestBody.snapshotName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          targetDatabaseName: requestBody.targetDatabaseName
          targetEnvironmentName: requestBody.targetEnvironmentName
      - text: Recover data from snapshot {snapshotName} of {databaseName} in {environmentName} into target database {targetDatabaseName}, environment {targetEnvironmentName}.
        slots:
          snapshotName: requestBody.snapshotName
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          targetDatabaseName: requestBody.targetDatabaseName
          targetEnvironmentName: requestBody.targetEnvironmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/startDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a stopped operational database
      effect: write
      questions:
      - How do I bring a stopped operational database back online?
      - Can I restart an OpDB I paused earlier?
      instructions:
      - text: Start operational database {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Resume the stopped OpDB {databaseName} in environment {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/stopDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running operational database
      effect: write
      questions:
      - Can I stop my operational database when it isn't being used?
      - What happens to a running OpDB when I shut it down?
      instructions:
      - text: Stop operational database {databaseName} in {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      - text: Shut down the running OpDB {databaseName} in environment {environmentName}.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/updateDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an operational database's scaling
      effect: write
      questions:
      - How do I change autoscaling settings on an existing operational database?
      - Can I change how many REST worker nodes my OpDB runs?
      instructions:
      - text: Update database {databaseName} in {environmentName} to run {numDesiredRestworkerNodes} REST worker nodes.
        slots:
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
          numDesiredRestworkerNodes: requestBody.numDesiredRestworkerNodes
      - text: Set {numDesiredStrongMetaServers} strong meta servers on OpDB {databaseName} in {environmentName}.
        slots:
          numDesiredStrongMetaServers: requestBody.numDesiredStrongMetaServers
          databaseName: requestBody.databaseName
          environmentName: requestBody.environmentName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/opdb/upgradeDatabase'].post
  update:
    x-apievangelist-phrasing:
      intent: Upgrade an operational database runtime
      effect: write
      questions:
      - How do I upgrade my operational database to a newer runtime?
      - Is an OS-only upgrade possible for an OpDB?
      instructions:
      - text: Upgrade database {database} in {environment} to runtime {runtime}.
        slots:
          database: requestBody.database
          environment: requestBody.environment
          runtime: requestBody.runtime
      - text: Run an OS-only upgrade on OpDB {database} in {environment}.
        slots:
          database: requestBody.database
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'