API Evangelist conversational phrasing for Cohesity Objects 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 Objects API
  version: 1.0.0
extends: openapi/cohesity-objects-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: 21
- target: $.paths['/data-protect/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: List object protection configurations
      effect: read
      questions:
      - Which objects are protected on my cluster and by which policies?
      - Can I list only auto-protected or leaf objects?
      - How do I see object configurations including last run info?
      instructions:
      - text: List object configurations protected by policy {policyIds}.
        slots:
          policyIds: query.policyIds
      - text: Show objects under parent {parentId} with their last run info.
        slots:
          parentId: query.parentId
      - text: List only protected objects in environment {environments}.
        slots:
          environments: query.environments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Link or unlink multiple objects
      effect: write
      questions:
      - Can I perform a bulk action across several objects at once?
      - How do I link or unlink objects in one request?
      instructions:
      - text: Perform action {action} on multiple objects.
        slots:
          action: requestBody.action
      - text: Run a bulk link action with parameters {linkParams}.
        slots:
          linkParams: requestBody.linkParams
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/last-run'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the last protection run of objects
      effect: read
      questions:
      - When was each object last backed up?
      - Can I check the most recent protection run for a set of objects?
      instructions:
      - text: Get the last protection run for objects {ids}.
        slots:
          ids: query.ids
      - text: Show the latest backup run of objects belonging to tenant {tenantIds}.
        slots:
          tenantIds: query.tenantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/runs/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel object-based protection runs
      effect: destructive
      questions:
      - How do I cancel backup runs for specific objects?
      - Can I stop object-level protection runs that aren't part of a group?
      instructions:
      - text: 'Cancel these object runs: {objectRuns}.'
        slots:
          objectRuns: requestBody.objectRuns
      - text: Stop the object-based protection runs {objectRuns}.
        slots:
          objectRuns: requestBody.objectRuns
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object's protection configuration
      effect: read
      questions:
      - What is the protection configuration of a single object?
      - Can I see the last run info for one specific object id?
      instructions:
      - text: Show the protection configuration for object {id}.
        slots:
          id: path.id
      - text: Get object {id} with its last run info included.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Perform an action on one object
      effect: write
      questions:
      - What actions can I take on a single object depending on its environment?
      - How do I trigger an environment-specific action on one object?
      instructions:
      - text: Perform an action on object {id} in environment {environment}.
        slots:
          id: path.id
          environment: requestBody.environment
      - text: Run the {environment} action for object {id}.
        slots:
          environment: requestBody.environment
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/pit-ranges'].get
  update:
    x-apievangelist-phrasing:
      intent: Get point-in-time restore ranges
      effect: read
      questions:
      - Which time ranges can a protected object be restored to at any point in time?
      - Can I check PIT recovery windows for a database between two dates?
      instructions:
      - text: Get point-in-time restore ranges for object {id}.
        slots:
          id: path.id
      - text: Show PIT ranges for object {id} from {fromTimeUsecs} to {toTimeUsecs}.
        slots:
          id: path.id
          fromTimeUsecs: query.fromTimeUsecs
          toTimeUsecs: query.toTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List protection runs for an object
      effect: read
      questions:
      - What backup runs have happened for a particular object?
      - Can I filter an object's runs by replication or archival status?
      - How do I exclude non-restorable runs for an object?
      instructions:
      - text: List the runs for object {id}.
        slots:
          id: path.id
      - text: Show the last {numRuns} runs for object {id}.
        slots:
          numRuns: query.numRuns
          id: path.id
      - text: List runs of object {id} started after {startTimeUsecs}.
        slots:
          id: path.id
          startTimeUsecs: query.startTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/runs/{runId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one protection run of an object
      effect: read
      questions:
      - What happened in a specific backup run for an object?
      - Where can I see one run's details for a given object?
      instructions:
      - text: Get run {runId} for object {id}.
        slots:
          runId: path.runId
          id: path.id
      - text: Show details of protection run {runId} of object {id}.
        slots:
          runId: path.runId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshots of an object
      effect: read
      questions:
      - Which snapshots exist for an object I protect?
      - Can I list an object's snapshots within a time window?
      instructions:
      - text: List snapshots of object {id}.
        slots:
          id: path.id
      - text: Show snapshots of object {id} taken between {fromTimeUsecs} and {toTimeUsecs}.
        slots:
          id: path.id
          fromTimeUsecs: query.fromTimeUsecs
          toTimeUsecs: query.toTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/snapshots/{snapshotId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an object snapshot's hold or expiry
      effect: write
      questions:
      - How do I put a legal hold on an object snapshot?
      - Can I extend the expiry time of a specific snapshot?
      instructions:
      - text: Set a legal hold on snapshot {snapshotId} of object {id}.
        slots:
          snapshotId: path.snapshotId
          id: path.id
      - text: Change the expiry of snapshot {snapshotId} for object {id} to {expiryTimeSecs}.
        slots:
          snapshotId: path.snapshotId
          id: path.id
          expiryTimeSecs: requestBody.expiryTimeSecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats for an object
      effect: read
      questions:
      - What are the storage and protection stats for an object?
      - Can I see usage numbers for one protected object?
      instructions:
      - text: Get stats for object {id}.
        slots:
          id: path.id
      - text: Show the statistics of object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{id}/tree'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's hierarchy tree
      effect: read
      questions:
      - What's the parent and child hierarchy around a given object?
      - Can I view the tree an object belongs to?
      instructions:
      - text: Show the object tree for {id}.
        slots:
          id: path.id
      - text: Get the hierarchy of object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{objectId}/indexed-objects/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshots containing an indexed file or item
      effect: read
      questions:
      - Which snapshots of an object contain a particular indexed file across all protection groups?
      - Can I find every backup version of an indexed item by its name?
      instructions:
      - text: List snapshots of object {objectId} that contain {indexedObjectName}.
        slots:
          objectId: path.objectId
          indexedObjectName: query.indexedObjectName
      - text: Find all versions of {indexedObjectName} in object {objectId} across protection groups.
        slots:
          indexedObjectName: query.indexedObjectName
          objectId: path.objectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/objects/{objectId}/protection-groups/{protectionGroupId}/indexed-objects/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List indexed item snapshots within one protection group
      effect: read
      questions:
      - Which snapshots in one specific protection group contain an indexed file?
      - Can I narrow indexed item versions to a single protection group?
      instructions:
      - text: List snapshots of {indexedObjectName} in object {objectId} for protection group {protectionGroupId}.
        slots:
          indexedObjectName: query.indexedObjectName
          objectId: path.objectId
          protectionGroupId: path.protectionGroupId
      - text: Find versions of {indexedObjectName} for object {objectId} within group {protectionGroupId} only.
        slots:
          indexedObjectName: query.indexedObjectName
          objectId: path.objectId
          protectionGroupId: path.protectionGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/snapshots/{snapshotId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a snapshot
      effect: read
      questions:
      - What details are recorded for a specific object snapshot?
      - Where do I look up a snapshot by its id?
      instructions:
      - text: Get details of snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      - text: Show snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/snapshots/{snapshotId}/metaInfo'].post
  update:
    x-apievangelist-phrasing:
      intent: Build workflow meta info from a snapshot
      effect: read
      questions:
      - Can I generate restore metadata from a snapshot for an Oracle workflow?
      - How do I construct meta info for a recovery from an object snapshot?
      instructions:
      - text: Construct meta info from snapshot {snapshotId} for environment {environment}.
        slots:
          snapshotId: path.snapshotId
          environment: requestBody.environment
      - text: Build Oracle workflow meta info from snapshot {snapshotId} with params {oracleParams}, environment {environment}.
        slots:
          snapshotId: path.snapshotId
          oracleParams: requestBody.oracleParams
          environment: requestBody.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/snapshots/{snapshotId}/volume'].get
  update:
    x-apievangelist-phrasing:
      intent: Get volume info of a snapshot
      effect: read
      questions:
      - What volumes are inside an object snapshot?
      - Can I see only supported volumes of a snapshot at a point in time?
      instructions:
      - text: Get volume info for snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      - text: Show supported volumes of snapshot {snapshotId} at {pointInTimeUsecs}.
        slots:
          snapshotId: path.snapshotId
          pointInTimeUsecs: query.pointInTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/data-protect/sources/{sourceId}/objects'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse protectable objects on a source
      effect: read
      questions:
      - Which objects on a registered source can I protect?
      - Can I browse VMs or databases under a source to choose what to back up?
      instructions:
      - text: List protectable objects on source {sourceId}.
        slots:
          sourceId: path.sourceId
      - text: Browse objects under parent {parentId} on source {sourceId}.
        slots:
          parentId: query.parentId
          sourceId: path.sourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/operations'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asynchronous objects operation
      effect: write
      questions:
      - How do I check object credentials or refresh replicated snapshots asynchronously?
      - Can I kick off a background operation to fetch resource pool info for objects?
      instructions:
      - text: Start objects operation {operationId} of type {operationType}.
        slots:
          operationId: requestBody.operationId
          operationType: requestBody.operationType
      - text: Initiate a {operationType} operation with id {operationId}.
        slots:
          operationType: requestBody.operationType
          operationId: requestBody.operationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/objects/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of an objects operation
      effect: read
      questions:
      - Has my asynchronous objects operation finished, and what did it return?
      - Where do I fetch the result of a background objects operation?
      instructions:
      - text: Get the results of objects operation {operationId}.
        slots:
          operationId: path.operationId
      - text: Check the status of async operation {operationId}.
        slots:
          operationId: path.operationId
      method: generated
      generated: '2026-10-01'