# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Downtime API
  version: 1.0.0
extends: openapi/harness-downtime-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/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scheduled downtime
      effect: read
      questions:
      - What window and services does a particular monitoring downtime cover?
      - Can I see the full definition of one downtime?
      instructions:
      - text: Show downtime {identifier} in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          identifier: path.identifier
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: Get the schedule of downtime {identifier} in project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: path.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a downtime's schedule and scope
      effect: write
      questions:
      - How do I change the schedule or affected services of an existing downtime?
      - Can I rename a downtime or change its category after it's saved?
      instructions:
      - text: Update downtime {identifier} in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier} with new spec {spec}.
        slots:
          identifier: path.identifier
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
          spec: requestBody.spec
      - text: Rename downtime {identifier} to {name} and set its category to {category}.
        slots:
          identifier: path.identifier
          name: requestBody.name
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/identifier/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a downtime
      effect: destructive
      questions:
      - Can I delete a maintenance downtime that's no longer needed?
      - What's the way to remove a downtime entirely rather than disabling it?
      instructions:
      - text: Delete downtime {identifier} in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          identifier: path.identifier
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: Remove the downtime {identifier} permanently.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: List services covered by one downtime
      effect: read
      questions:
      - Which monitored services are silenced by a specific downtime?
      - Does this downtime affect our checkout service?
      instructions:
      - text: List the monitored services covered by downtime {identifier} in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          identifier: path.identifier
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: Show which services downtime {identifier} applies to.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/monitored-services'].get
  update:
    x-apievangelist-phrasing:
      intent: List all services that have downtimes
      effect: read
      questions:
      - Which monitored services in this project have any downtime attached?
      - Can I page through every service that's tied to a downtime?
      instructions:
      - text: List every monitored service with a downtime in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: Show page {pageNumber} of services that have downtimes in project {projectIdentifier}.
        slots:
          pageNumber: query.pageNumber
          projectIdentifier: path.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/history'].get
  update:
    x-apievangelist-phrasing:
      intent: Show past downtime occurrences
      effect: read
      questions:
      - When did downtimes last run for a service, and how long did they last?
      - Can I filter downtime history by name or by monitored service?
      instructions:
      - text: Show downtime history for account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: List past downtimes that affected monitored service {monitoredServiceIdentifier}.
        slots:
          monitoredServiceIdentifier: query.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured downtimes
      effect: read
      questions:
      - What downtimes are currently configured in my project?
      - Can I search downtimes by name?
      instructions:
      - text: List the downtimes configured in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: Find configured downtimes named like {filter} for service {monitoredServiceIdentifier}.
        slots:
          filter: query.filter
          monitoredServiceIdentifier: query.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a new downtime
      effect: write
      questions:
      - How do I schedule a maintenance window so alerts and SLOs pause for some services?
      - Can a downtime be recurring rather than one-time?
      instructions:
      - text: Create downtime {name} ({identifier}) of category {category} in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          category: requestBody.category
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
      - text: Schedule downtime {name} with schedule {spec} for services {entitiesRule}.
        slots:
          name: requestBody.name
          spec: requestBody.spec
          entitiesRule: requestBody.entitiesRule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/account/{accountIdentifier}/org/{orgIdentifier}/project/{projectIdentifier}/downtime/flag/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a downtime
      effect: write
      questions:
      - Can I temporarily turn off a downtime without deleting it?
      - Is there a quick toggle to re-enable a paused downtime?
      instructions:
      - text: Set downtime {identifier} in account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier} to enabled={enable}.
        slots:
          identifier: path.identifier
          accountIdentifier: path.accountIdentifier
          orgIdentifier: path.orgIdentifier
          projectIdentifier: path.projectIdentifier
          enable: query.enable
      - text: Disable downtime {identifier} by setting its flag to {enable}.
        slots:
          identifier: path.identifier
          enable: query.enable
      method: generated
      generated: '2026-09-26'