API Evangelist conversational phrasing for Cohesity REST Analytics API

# 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 Analytics API
  version: 1.0.0
extends: openapi/cohesity-analytics-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: 28
- target: $.paths['/public/analytics/analyzeJar'].post
  update:
    x-apievangelist-phrasing:
      intent: Analyze an uploaded analytics jar
      effect: read
      questions:
      - What's inside the jar I just uploaded to the Analytics workbench?
      - Can the cluster inspect a custom jar before I use it for a map-reduce app?
      instructions:
      - text: Analyze the uploaded jar {jarName}.
        slots:
          jarName: requestBody.jarName
      - text: Run jar analysis on {jarName} at {jarPath} and save the discovered entities.
        slots:
          jarName: requestBody.jarName
          jarPath: requestBody.jarPath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List analytics applications
      effect: read
      questions:
      - Which analytics applications exist on my Cohesity cluster?
      - Can I see every map-reduce application defined in the Analytics workbench?
      instructions:
      - text: List all analytics applications on the cluster.
      - text: Show me the Analytics workbench applications, including system-defined ones.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an analytics application
      effect: write
      questions:
      - How do I define a new map-reduce application in the Analytics workbench?
      - Can I build an analytics app from an existing mapper and reducer?
      instructions:
      - text: Create an analytics application named {name} using mapper {mapperId} and reducer {reducerId}.
        slots:
          name: requestBody.name
          mapperId: requestBody.mapperId
          reducerId: requestBody.reducerId
      - text: Add a new analytics app called {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/apps/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one analytics application
      effect: read
      questions:
      - What mapper and reducer does a specific analytics application use?
      - Where can I see the full definition of a single analytics app by its id?
      instructions:
      - text: Show the analytics application {id}.
        slots:
          id: path.id
      - text: Get the details of analytics app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/apps/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an analytics application
      effect: write
      questions:
      - Can I change the mapper or reducer of an analytics app I already created?
      - How do I rename an existing analytics application?
      instructions:
      - text: Rename analytics application {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Switch analytics app {id} to use reducer {reducerId}.
        slots:
          id: path.id
          reducerId: requestBody.reducerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/apps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an analytics application
      effect: destructive
      questions:
      - How do I remove an analytics application I no longer need?
      - Can I delete a map-reduce app definition from the Analytics workbench?
      instructions:
      - text: Delete analytics application {id}.
        slots:
          id: path.id
      - text: Remove the analytics app {id} from the cluster.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/cancelAppInstanceRun/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running map-reduce instance
      effect: destructive
      questions:
      - How do I stop a map-reduce instance run that is still in progress?
      - Can I abort an analytics job run that's taking too long?
      instructions:
      - text: Cancel map-reduce instance run {id}.
        slots:
          id: path.id
      - text: Stop the in-progress analytics instance run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mappers'].get
  update:
    x-apievangelist-phrasing:
      intent: List map-reduce mappers
      effect: read
      questions:
      - Which mappers are available on my cluster for analytics apps?
      - Can I see all the mapper code modules in the Analytics workbench?
      instructions:
      - text: List every mapper on the cluster.
      - text: Show me the available Analytics workbench mappers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mappers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mapper
      effect: write
      questions:
      - How do I add my own mapper code to the Analytics workbench?
      - Can I register a mapper from a jar I uploaded?
      instructions:
      - text: Create a mapper named {name} written in {language}.
        slots:
          name: requestBody.name
          language: requestBody.language
      - text: Add mapper {name} from jar {jarName}.
        slots:
          name: requestBody.name
          jarName: requestBody.jarName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mappers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one mapper
      effect: read
      questions:
      - What code and language does a particular mapper use?
      - Where do I look up a single mapper by its id?
      instructions:
      - text: Show mapper {id}.
        slots:
          id: path.id
      - text: Get the source and jar details for mapper {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mappers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a mapper
      effect: write
      questions:
      - Can I replace the code of a mapper I already created?
      - How do I point an existing mapper at a different jar?
      instructions:
      - text: Update the code of mapper {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Point mapper {id} at jar {jarName}.
        slots:
          id: path.id
          jarName: requestBody.jarName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mappers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mapper
      effect: destructive
      questions:
      - How do I remove a mapper from the Analytics workbench?
      - Can I delete a custom mapper I don't use anymore?
      instructions:
      - text: Delete mapper {id}.
        slots:
          id: path.id
      - text: Remove the custom mapper {id} from the cluster.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mrAppRun/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a map-reduce app run record
      effect: destructive
      questions:
      - How do I clean up an old map-reduce application run?
      - Can I delete the record of a finished analytics instance run?
      instructions:
      - text: Delete map-reduce app run {id}.
        slots:
          id: path.id
      - text: Remove the finished analytics instance run {id} from history.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mrAppRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: List map-reduce application runs
      effect: read
      questions:
      - Which map-reduce runs have executed for a given analytics app?
      - Can I filter analytics runs by status or start time?
      - What were the last few instance runs of my analytics application?
      instructions:
      - text: List the map-reduce runs for application {appId}.
        slots:
          appId: requestBody.appId
      - text: Show the last {lastNumInstances} runs of analytics app {appId} with details.
        slots:
          lastNumInstances: requestBody.lastNumInstances
          appId: requestBody.appId
      - text: Find analytics runs with status {runStatus}.
        slots:
          runStatus: requestBody.runStatus
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mrBaseJar'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the map-reduce base jar
      effect: read
      questions:
      - Where do I get the base jar needed to build custom map-reduce code?
      - Can I download the cluster's map-reduce base library?
      instructions:
      - text: Download the map-reduce base jar from the cluster.
      - text: Fetch the analytics base jar so I can compile against it.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mrFileFormats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get output file formats for a map-reduce result
      effect: read
      questions:
      - What file formats can I download a map-reduce result in?
      - Which output formats are available for an analytics run's result file?
      instructions:
      - text: List the download formats for result file {resultFilePath} in view {viewName} on storage domain {storageDomainId}.
        slots:
          resultFilePath: query.resultFilePath
          viewName: query.viewName
          storageDomainId: query.storageDomainId
      - text: Check available output formats for {resultFilePath} in view {viewName}, storage domain {storageDomainId}.
        slots:
          resultFilePath: query.resultFilePath
          viewName: query.viewName
          storageDomainId: query.storageDomainId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/mrOutputfiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Download map-reduce run output files
      effect: read
      questions:
      - How do I download the output files an analytics run produced?
      - Can I fetch just a byte range of a map-reduce output file?
      instructions:
      - text: Download the map-reduce output file {filePath} from view {viewName}.
        slots:
          filePath: query.filePath
          viewName: query.viewName
      - text: Fetch {lengthBytes} bytes of output file {filePath} starting at offset {startOffset}.
        slots:
          lengthBytes: query.lengthBytes
          filePath: query.filePath
          startOffset: query.startOffset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/reducers'].get
  update:
    x-apievangelist-phrasing:
      intent: List map-reduce reducers
      effect: read
      questions:
      - Which reducers are available for analytics apps on my cluster?
      - Can I see all reducer modules in the Analytics workbench?
      instructions:
      - text: List every reducer on the cluster.
      - text: Show me the available Analytics workbench reducers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/reducers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reducer
      effect: write
      questions:
      - How do I add my own reducer code to the Analytics workbench?
      - Can I register a reducer from an uploaded jar?
      instructions:
      - text: Create a reducer named {name} written in {language}.
        slots:
          name: requestBody.name
          language: requestBody.language
      - text: Add reducer {name} from jar {jarName}.
        slots:
          name: requestBody.name
          jarName: requestBody.jarName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/reducers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one reducer
      effect: read
      questions:
      - What code does a particular reducer run?
      - Where can I look up a single reducer by id?
      instructions:
      - text: Show reducer {id}.
        slots:
          id: path.id
      - text: Get the source and jar details for reducer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/reducers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a reducer
      effect: write
      questions:
      - Can I replace the code of a reducer I already created?
      - How do I point an existing reducer at a new jar?
      instructions:
      - text: Update the code of reducer {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Point reducer {id} at jar {jarName}.
        slots:
          id: path.id
          jarName: requestBody.jarName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/reducers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reducer
      effect: destructive
      questions:
      - How do I remove a reducer from the Analytics workbench?
      - Can I delete a custom reducer I no longer use?
      instructions:
      - text: Delete reducer {id}.
        slots:
          id: path.id
      - text: Remove the custom reducer {id} from the cluster.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/runAppInstance'].put
  update:
    x-apievangelist-phrasing:
      intent: Run a map-reduce application
      effect: write
      questions:
      - How do I kick off a run of an analytics application?
      - Can I start a map-reduce job with custom input parameters?
      instructions:
      - text: Run analytics application {appId}.
        slots:
          appId: requestBody.appId
      - text: Start a map-reduce instance of app {appId} with input parameters {inputParams}.
        slots:
          appId: requestBody.appId
          inputParams: requestBody.inputParams
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/supportedPatterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List search patterns for an analytics app
      effect: read
      questions:
      - Which search patterns can I use in an analytics application?
      - Are there system-defined and user-defined patterns for a given app?
      instructions:
      - text: List the supported search patterns for application {applicationId}.
        slots:
          applicationId: query.applicationId
      - text: Show patterns for app {applicationId} and data type {applicationDataType}.
        slots:
          applicationId: query.applicationId
          applicationDataType: query.applicationDataType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/supportedPatterns'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a custom search pattern
      effect: write
      questions:
      - Can I save my own search pattern for an analytics app?
      - How do I add a user-defined pattern to the Analytics workbench?
      instructions:
      - text: Save pattern {userPattern} for application {applicationId} on data type {applicationDataType}.
        slots:
          userPattern: requestBody.userPattern
          applicationId: requestBody.applicationId
          applicationDataType: requestBody.applicationDataType
      - text: Add the user pattern {userPattern} to app {applicationId} for {applicationDataType} data.
        slots:
          userPattern: requestBody.userPattern
          applicationId: requestBody.applicationId
          applicationDataType: requestBody.applicationDataType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/uploadJar'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a jar to the analytics view
      effect: write
      questions:
      - How do I upload a custom jar to the Cohesity Analytics workbench?
      - Can I push a jar file to the cluster's internal view for analytics?
      instructions:
      - text: Upload my jar to the analytics internal view.
      - text: Push a new jar file to the cluster for map-reduce use.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/uploadJar'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an uploaded jar from temporary storage
      effect: destructive
      questions:
      - How do I discard a jar I uploaded but don't want to keep?
      - Can I clear an uploaded jar from the temporary location?
      instructions:
      - text: Delete the uploaded jar {jarName}.
        slots:
          jarName: requestBody.jarName
      - text: Remove jar {jarName} at {jarPath} from temporary storage.
        slots:
          jarName: requestBody.jarName
          jarPath: requestBody.jarPath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/analytics/uploadJarPath'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the mounted path for jar uploads
      effect: read
      questions:
      - Where on the cluster are analytics jars uploaded to?
      - What mount path should I use for uploading a map-reduce jar?
      instructions:
      - text: Show the mounted path for uploading jars.
      - text: Tell me the jar upload mount location on the cluster.
      method: generated
      generated: '2026-10-01'