# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness SLOs dashboard API
  version: 1.0.0
extends: openapi/harness-slos-dashboard-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/cv/api/slo-dashboard/environment-identifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments that have SLOs
      effect: read
      questions:
      - Which environments have service level objectives attached?
      - What environments can I filter the SLO dashboard by?
      instructions:
      - text: List environment identifiers associated with SLOs in account {accountId}.
        slots:
          accountId: query.accountId
      - text: Show environments that have SLOs in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/monitored-services'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored services that have SLOs
      effect: read
      questions:
      - Which monitored services have SLOs defined on them?
      - What monitored services show up in the SLO dashboard filters?
      instructions:
      - text: List monitored services with SLOs in account {accountId}.
        slots:
          accountId: query.accountId
      - text: Show SLO-linked monitored services in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/secondary-events-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of SLO secondary events
      effect: read
      questions:
      - What happened in a specific annotation or downtime event on my SLO chart?
      - Can I get details for several secondary events of one type?
      instructions:
      - text: Get details for {secondaryEventType} secondary events {identifiers}.
        slots:
          secondaryEventType: query.secondaryEventType
          identifiers: query.identifiers
      - text: Show secondary event details {identifiers} in account {accountId}.
        slots:
          identifiers: query.identifiers
          accountId: query.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/secondary-events/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: List secondary events for an SLO in a time range
      effect: read
      questions:
      - What secondary events like downtime affected an SLO during a time window?
      - Can I see events overlaid on an SLO between two timestamps?
      instructions:
      - text: List secondary events for SLO {identifier} from {startTime} to {endTime}.
        slots:
          identifier: path.identifier
          startTime: query.startTime
          endTime: query.endTime
      - text: Show events on SLO {identifier} since {startTime}.
        slots:
          identifier: path.identifier
          startTime: query.startTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/risk-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count SLOs by error budget risk
      effect: read
      questions:
      - How many of our SLOs are at risk of exhausting their error budget?
      - Can I break down SLO counts by risk for one monitored service?
      instructions:
      - text: Count SLOs by error budget risk in account {accountId}.
        slots:
          accountId: query.accountId
      - text: Show SLO risk counts for monitored service {monitoredServiceIdentifier}.
        slots:
          monitoredServiceIdentifier: query.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/widget/{identifier}/consumption'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SLO's error budget consumption breakdown
      effect: read
      questions:
      - What consumed the error budget of an SLO over a period?
      - Can I see a breakdown of SLO consumption between two times?
      instructions:
      - text: Get the consumption breakdown for SLO {identifier} from {startTime} to {endTime}.
        slots:
          identifier: path.identifier
          startTime: query.startTime
          endTime: query.endTime
      - text: Break down error budget burn on SLO {identifier} starting {startTime}.
        slots:
          identifier: path.identifier
          startTime: query.startTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/widget/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get dashboard details for one SLO
      effect: read
      questions:
      - What is the current health and error budget of a specific SLO?
      - Can I view one SLO's dashboard widget for a chosen period?
      instructions:
      - text: Get the SLO dashboard details for {identifier}.
        slots:
          identifier: path.identifier
      - text: Show the SLO widget {identifier} in project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/widgets/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List SLO health using query filters
      effect: read
      questions:
      - What is the health of all SLOs in my project?
      - Can I list SLOs filtered by error budget risk using query parameters?
      instructions:
      - text: List SLO health for account {accountId} with risk {errorBudgetRisks}.
        slots:
          accountId: query.accountId
          errorBudgetRisks: query.errorBudgetRisks
      - text: Show the SLO list view for monitored service {monitoredServiceIdentifier} via GET filters.
        slots:
          monitoredServiceIdentifier: query.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo-dashboard/widgets/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List SLO health with a filter body
      effect: read
      questions:
      - Can I list SLOs under a composite SLO using a filter body?
      - Which SLO list lets me send filters like child resources in the request body?
      instructions:
      - text: List SLOs belonging to composite SLO {compositeSLOIdentifier}.
        slots:
          compositeSLOIdentifier: requestBody.compositeSLOIdentifier
      - text: Post a filtered SLO list search for {searchFilter} in account {accountId}.
        slots:
          searchFilter: requestBody.searchFilter
          accountId: query.accountId
      method: generated
      generated: '2026-09-26'