# 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 API
  version: 1.0.0
extends: openapi/harness-slos-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: 6
- target: $.paths['/cv/api/slo/{identifier}/errorBudgetResetHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SLO's error budget reset history
      effect: read
      questions:
      - When was an SLO's error budget last reset, and why?
      - Can I see every error budget reset for one SLO?
      instructions:
      - text: Show the error budget reset history for SLO {slo}.
        slots:
          slo: path.identifier
      - text: List past error budget resets of SLO {slo} in project {project}.
        slots:
          slo: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo/{identifier}/notification-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification rules for an SLO
      effect: read
      questions:
      - Which alerts fire when an SLO is at risk?
      - What notification rules are attached to a given SLO?
      instructions:
      - text: List notification rules for SLO {slo}.
        slots:
          slo: path.identifier
      - text: Show page {page} of alert rules on SLO {slo}.
        slots:
          page: query.pageNumber
          slo: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo/{identifier}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SLO's logs for a time range
      effect: read
      questions:
      - Can I see the execution or API call logs behind an SLO?
      - Is there a way to view only error logs for an SLO in a time window?
      instructions:
      - text: Get {type} logs for SLO {slo} from {start} to {end}.
        slots:
          type: query.logType
          slo: path.identifier
          start: query.startTime
          end: query.endTime
      - text: Show only error logs for SLO {slo} with type {type} between {start} and {end}.
        slots:
          slo: path.identifier
          type: query.logType
          start: query.startTime
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/slo/{identifier}/resetErrorBudget'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an SLO's error budget
      effect: write
      questions:
      - Can I top up an SLO's error budget after an incident was excused?
      - Does resetting the error budget let me add a percentage or minutes?
      instructions:
      - text: Reset the error budget of SLO {slo} because {reason}.
        slots:
          slo: path.identifier
          reason: requestBody.reason
      - text: Increase SLO {slo} error budget by {percent} percent.
        slots:
          slo: path.identifier
          percent: requestBody.errorBudgetIncrementPercentage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/v1/orgs/{org}/projects/{project}/metric-graph/{slo-identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the metric graph behind an SLO
      effect: read
      questions:
      - What underlying metrics drive a particular SLO?
      - Can I graph an SLO's source metrics for a time range?
      instructions:
      - text: Get the metric graph for SLO {slo} in project {project}, org {org}.
        slots:
          slo: path.slo-identifier
          project: path.project
          org: path.org
      - text: Show SLO {slo} metrics between {start} and {end}.
        slots:
          slo: path.slo-identifier
          start: query.start_time
          end: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/v1/orgs/{org}/projects/{project}/slo'].get
  update:
    x-apievangelist-phrasing:
      intent: List SLOs in a project
      effect: read
      questions:
      - Which service level objectives are defined in my project?
      - Can I list only SLOs whose error budget is at risk?
      instructions:
      - text: List SLOs in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: List SLOs for monitored service {service} in project {project}.
        slots:
          service: query.monitored_service_identifier
          project: path.project
      method: generated
      generated: '2026-09-26'