# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST App Instance API
  version: 1.0.0
extends: openapi/cohesity-appinstance-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: 4
- target: $.paths['/public/appInstanceSettings/{appInstanceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update app instance settings
      effect: write
      questions:
      - How do I change the settings of a running app instance?
      - Can I update the description of an app instance?
      instructions:
      - text: Update settings of app instance {appInstanceId} to {settings}.
        slots:
          appInstanceId: path.appInstanceId
          settings: requestBody.settings
      - text: Change the description of app instance {appInstanceId} to {description}.
        slots:
          appInstanceId: path.appInstanceId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/appInstances'].get
  update:
    x-apievangelist-phrasing:
      intent: List app instances
      effect: read
      questions:
      - Which app instances are running or stopped on the cluster?
      - Can I see every launched app instance and its state?
      instructions:
      - text: List the app instances on the cluster.
      - text: Show all app instances including stopped ones.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/appInstances'].post
  update:
    x-apievangelist-phrasing:
      intent: Launch an installed app
      effect: write
      questions:
      - How do I launch an app I installed on the cluster?
      - Can I start a specific version of an app?
      instructions:
      - text: Launch app {appUid}.
        slots:
          appUid: requestBody.appUid
      - text: Start version {appVersion} of app {appUid}.
        slots:
          appVersion: requestBody.appVersion
          appUid: requestBody.appUid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/appInstances/{appInstanceId}/states'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an app instance's state
      effect: write
      questions:
      - How do I stop or restart an app instance?
      - Can I change the run state of an app instance?
      instructions:
      - text: Set app instance {appInstanceId} to state {state}.
        slots:
          appInstanceId: path.appInstanceId
          state: requestBody.state
      - text: Stop app instance {appInstanceId} by setting state to {state}.
        slots:
          appInstanceId: path.appInstanceId
          state: requestBody.state
      method: generated
      generated: '2026-10-01'