# 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 Statistics API
  version: 1.0.0
extends: openapi/cohesity-statistics-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: 6
- target: $.paths['/public/statistics/entities'].get
  update:
    x-apievangelist-phrasing:
      intent: List entities for a statistics schema
      effect: read
      questions:
      - Which disks or nodes can I pull metrics for under a given schema?
      - Can I cap how many entities come back for a schema?
      instructions:
      - text: List entities for schema {schemaName}.
        slots:
          schemaName: query.schemaName
      - text: List up to {maxEntities} entities in schema {schemaName} with metrics {metricNames}.
        slots:
          maxEntities: query.maxEntities
          schemaName: query.schemaName
          metricNames: query.metricNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/statistics/entitiesSchema'].get
  update:
    x-apievangelist-phrasing:
      intent: List statistics entity schemas
      effect: read
      questions:
      - What metric schemas does the cluster track?
      - Which schemas include a metric like random IOs?
      instructions:
      - text: List all entity schemas.
      - text: List entity schemas containing metric {metricNames}.
        slots:
          metricNames: query.metricNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/statistics/entitiesSchema/{schemaName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one statistics entity schema
      effect: read
      questions:
      - What attributes and metrics are defined for a specific schema?
      - How is a named schema like disk stats structured?
      instructions:
      - text: Get entity schema {schemaName}.
        slots:
          schemaName: path.schemaName
      - text: Show the metrics defined in schema {schemaName}.
        slots:
          schemaName: path.schemaName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/statistics/timeSeriesSchema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the time series schema for an entity
      effect: read
      questions:
      - Which time series data points are available for a particular node or cluster entity?
      - What schema do I need before querying stats for an entity?
      instructions:
      - text: Get the time series schema for {entityType} entity {entityId} named {entityName}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
          entityName: query.entityName
      - text: Show the time series schema for {entityType} {entityName} ({entityId}).
        slots:
          entityType: query.entityType
          entityName: query.entityName
          entityId: query.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/statistics/timeSeriesStats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metric time series for an entity
      effect: read
      questions:
      - What was disk latency on a node over the last day?
      - Can I roll metric data points up to hourly averages?
      instructions:
      - text: Get {metricName} from schema {schemaName} for entity {entityId} since {startTimeMsecs}.
        slots:
          metricName: query.metricName
          schemaName: query.schemaName
          entityId: query.entityId
          startTimeMsecs: query.startTimeMsecs
      - text: Chart {metricName} in {schemaName} from {startTimeMsecs} rolled up every {rollupIntervalSecs} seconds.
        slots:
          metricName: query.metricName
          schemaName: query.schemaName
          startTimeMsecs: query.startTimeMsecs
          rollupIntervalSecs: query.rollupIntervalSecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/tasks/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of cluster tasks
      effect: read
      questions:
      - What background tasks is the cluster working on and how far along are they?
      - Can I include finished tasks or skip subtasks when checking task status?
      instructions:
      - text: Show the status of running cluster tasks.
      - text: Show progress for task paths {taskPaths}, including finished tasks.
        slots:
          taskPaths: query.taskPaths
      method: generated
      generated: '2026-10-01'