API Evangelist conversational phrasing for Harness Monitored Services API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Monitored Services API
  version: 1.0.0
extends: openapi/harness-monitored-services-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: 37
- target: $.paths['/cv/api/monitored-service/create-default'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a default monitored service
      effect: write
      questions:
      - Can Harness spin up a default monitored service for a service and environment pair automatically?
      - What is the quickest way to start monitoring a service without writing a full health source config?
      instructions:
      - text: Create a default monitored service for service {service} in environment {environment}.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      - text: Set up the default monitored service for {service} in {environment} under project {project}.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitored service's configuration
      effect: read
      questions:
      - How do I see the full configuration of one monitored service, including its health sources and dependencies?
      - Where can I read back the definition of a monitored service I already saved?
      instructions:
      - text: Show me the configuration of monitored service {identifier}.
        slots:
          identifier: path.identifier
      - text: Fetch monitored service {identifier} from project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a monitored service's settings
      effect: write
      questions:
      - Can I rename a monitored service or change its tags and notification rules after it exists?
      - How do I change which service or environment an existing monitored service points at?
      instructions:
      - text: Rename monitored service {identifier} to {name}.
        slots:
          identifier: path.identifier
          name: requestBody.name
      - text: Update the description of monitored service {identifier} to {description}.
        slots:
          identifier: path.identifier
          description: requestBody.description
      - text: Disable monitoring on monitored service {identifier} by setting enabled to {enabled}.
        slots:
          identifier: path.identifier
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a monitored service
      effect: destructive
      questions:
      - How do I remove a monitored service I no longer need?
      - Does deleting a monitored service stop its service reliability tracking entirely?
      instructions:
      - text: Delete monitored service {identifier}.
        slots:
          identifier: path.identifier
      - text: Remove monitored service {identifier} from project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/detach-template'].put
  update:
    x-apievangelist-phrasing:
      intent: Detach a monitored service from its template
      effect: write
      questions:
      - Can I unlink a monitored service from the template it was created from so I can edit it freely?
      - How do I stop a monitored service from following template changes?
      instructions:
      - text: Detach monitored service {identifier} from its template.
        slots:
          identifier: path.identifier
      - text: Remove the template reference from monitored service {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/all/time-series-health-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored services with time-series health sources
      effect: read
      questions:
      - Which monitored services in my project have time-series health sources attached?
      - Can I get every monitored service along with its metric health sources in one call?
      instructions:
      - text: List all monitored services with time-series health sources in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show which monitored services in org {org} have metric health sources.
        slots:
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/anomaliesCount'].get
  update:
    x-apievangelist-phrasing:
      intent: Count anomalies for a monitored service
      effect: read
      questions:
      - How many anomalies did a monitored service record over a given time window?
      - Can I get an anomaly count summary for one monitored service between two timestamps?
      instructions:
      - text: Count the anomalies on monitored service {identifier} between {start} and {end}.
        slots:
          identifier: path.identifier
          start: query.startTime
          end: query.endTime
      - text: Summarize anomaly counts for monitored service {identifier} since {start}.
        slots:
          identifier: path.identifier
          start: query.startTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/count-of-services'].get
  update:
    x-apievangelist-phrasing:
      intent: Count monitored services in a project
      effect: read
      questions:
      - How many monitored services does my project have in total?
      - Can I count monitored services for just one environment?
      instructions:
      - text: Count the monitored services in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Tell me how many monitored services exist in environment {environment}.
        slots:
          environment: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments that have monitored services
      effect: read
      questions:
      - Which environments currently have monitored services configured?
      - What environments show up in service reliability monitoring for my project?
      instructions:
      - text: List the environments with monitored services in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show environments used by monitored services in org {org}.
        slots:
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/health-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health sources for a service and environment
      effect: read
      questions:
      - What health sources feed monitoring for a given service in a given environment?
      - Can I look up health sources by service and environment instead of by monitored service ID?
      instructions:
      - text: List health sources for service {service} in environment {environment}.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      - text: Show the metric and log sources monitoring {service} in {environment}.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{monitoredServiceIdentifier}/health-sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List health sources of a monitored service
      effect: read
      questions:
      - Which health sources are attached to a specific monitored service?
      - Can I see the data sources behind one monitored service by its identifier?
      instructions:
      - text: List the health sources attached to monitored service {monitoredService}.
        slots:
          monitoredService: path.monitoredServiceIdentifier
      - text: Show what feeds data into monitored service {monitoredService}.
        slots:
          monitoredService: path.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/list'].get
  update:
    x-apievangelist-phrasing:
      intent: Page through monitored services by environment
      effect: read
      questions:
      - Can I page through monitored services and narrow them to one or more environments?
      - What paginated view of monitored services is available with a text filter?
      instructions:
      - text: Page through monitored services in environment {environment}, {size} per page.
        slots:
          environment: query.environmentIdentifier
          size: query.pageSize
      - text: Get page {offset} of monitored services matching {filter}.
        slots:
          offset: query.offset
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/platform/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored services on the platform list view
      effect: read
      questions:
      - Can I hide monitored services that are not configured yet when listing them?
      - How do I list monitored services filtered by monitored service type on the platform view?
      instructions:
      - text: 'List platform monitored services of type {type}, hiding unconfigured ones: {hide}.'
        slots:
          type: query.monitoredServiceType
          hide: query.hideNotConfiguredServices
      - text: Show the platform list of monitored services in project {project}, page size {size}.
        slots:
          project: query.projectIdentifier
          size: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/secondary-events'].get
  update:
    x-apievangelist-phrasing:
      intent: Get secondary events on a monitored service
      effect: read
      questions:
      - What secondary events like downtime or annotations hit a monitored service in a time range?
      - Can I pull the secondary event timeline for one monitored service?
      instructions:
      - text: List secondary events on monitored service {identifier} between {start} and {end}.
        slots:
          identifier: path.identifier
          start: query.startTime
          end: query.endTime
      - text: Show the secondary event timeline for monitored service {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/secondary-events-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of secondary events
      effect: read
      questions:
      - How do I get the full details for specific secondary events by their IDs?
      - Can I expand a secondary event of a given type to see what happened?
      instructions:
      - text: Get details for secondary events {ids} of type {type}.
        slots:
          ids: query.identifiers
          type: query.secondaryEventType
      - text: Expand secondary event {ids} so I can see its details.
        slots:
          ids: query.identifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{monitoredServiceIdentifier}/change-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get change details for a monitored service
      effect: read
      questions:
      - What changes affected a monitored service, and which SLOs did they touch?
      - Can I see change details for a monitored service scoped to certain SLOs?
      instructions:
      - text: Show change details for monitored service {monitoredService}.
        slots:
          monitoredService: path.monitoredServiceIdentifier
      - text: Get the changes on monitored service {monitoredService} affecting SLOs {slos}.
        slots:
          monitoredService: path.monitoredServiceIdentifier
          slos: query.sloIdentifiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{monitoredServiceIdentifier}/service-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get service details by monitored service ID
      effect: read
      questions:
      - How do I fetch the service and environment details behind a monitored service identifier?
      - What service details does a given monitored service resolve to?
      instructions:
      - text: Get service details for monitored service {monitoredService}.
        slots:
          monitoredService: path.monitoredServiceIdentifier
      - text: Look up which service and environment monitored service {monitoredService} covers.
        slots:
          monitoredService: path.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/service-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Get monitored service details by service and environment
      effect: read
      questions:
      - Can I get monitored service details knowing only the service and environment identifiers?
      - What monitored service details exist for a service in a specific environment?
      instructions:
      - text: Get monitored service details for service {service} and environment {environment}.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      - text: Pull service details via service {service} in environment {environment}, not by monitored service ID.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/service-environment'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the monitored service for a service and environment
      effect: read
      questions:
      - Which monitored service is tracking my service in production?
      - Is there already a monitored service for this service and environment combination?
      instructions:
      - text: Find the monitored service for service {service} in environment {environment}.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      - text: Check whether {service} in {environment} already has a monitored service.
        slots:
          service: query.serviceIdentifier
          environment: query.environmentIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{monitoredServiceIdentifier}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get verification logs for a monitored service
      effect: read
      questions:
      - How do I see API call or execution logs for a monitored service over a time window?
      - Can I filter a monitored service's logs to errors only?
      instructions:
      - text: Show {logType} logs for monitored service {monitoredService} between {start} and {end}.
        slots:
          logType: query.logType
          monitoredService: path.monitoredServiceIdentifier
          start: query.startTime
          end: query.endTime
      - text: Get only error logs of type {logType} for monitored service {monitoredService}.
        slots:
          logType: query.logType
          monitoredService: path.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/reconciliation-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get reconciliation status for template-based services
      effect: read
      questions:
      - Which monitored services built from a template are out of sync with a template version?
      - Can I see reconciliation status for every monitored service using a given template?
      instructions:
      - text: Show reconciliation status for monitored services using template {template} version {version}.
        slots:
          template: query.templateIdentifier
          version: query.versionLabel
      - text: List the sync state of services built from template {template} at {version}.
        slots:
          template: query.templateIdentifier
          version: query.versionLabel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/resolved-template-inputs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get resolved template inputs for a monitored service
      effect: read
      questions:
      - What values did a template-based monitored service resolve its inputs to?
      - Can I see the final template inputs a monitored service is using?
      instructions:
      - text: Get resolved template inputs for monitored service {identifier} from template {template} version {version}.
        slots:
          identifier: path.identifier
          template: query.templateIdentifier
          version: query.versionLabel
      - text: Show which input values monitored service {identifier} resolved from its template.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/scores'].get
  update:
    x-apievangelist-phrasing:
      intent: Get health and SLO scores for a monitored service
      effect: read
      questions:
      - What are the current health and SLO scores for a monitored service?
      - How healthy is one of my monitored services right now?
      instructions:
      - text: Get the scores for monitored service {identifier}.
        slots:
          identifier: path.identifier
      - text: Show the current score card of monitored service {identifier} in project {project}.
        slots:
          identifier: path.identifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/notification-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List notification rules on a monitored service
      effect: read
      questions:
      - Which notification rules are wired to a monitored service?
      - Who gets alerted when a monitored service changes health?
      instructions:
      - text: List the notification rules for monitored service {identifier}.
        slots:
          identifier: path.identifier
      - text: Show page {page} of alert rules on monitored service {identifier}.
        slots:
          page: query.pageNumber
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/overall-health-score'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a monitored service's overall health score
      effect: read
      questions:
      - How has a monitored service's overall health score trended over the last day?
      - Can I pull the overall health score over a set duration ending at a timestamp?
      instructions:
      - text: Get the overall health score of monitored service {identifier} ending at {end}.
        slots:
          identifier: path.identifier
          end: query.endTime
      - text: Show the overall health trend for {identifier} over duration {duration} up to {end}.
        slots:
          identifier: path.identifier
          duration: query.duration
          end: query.endTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/services'].get
  update:
    x-apievangelist-phrasing:
      intent: List services that have monitored services
      effect: read
      questions:
      - Which services in my project are being monitored?
      - What services appear in service reliability monitoring for a project?
      instructions:
      - text: List the monitored services' underlying services in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show which services are covered by monitoring in org {org}.
        slots:
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{monitoredServiceIdentifier}/health-source/{healthSourceIdentifier}/slo-metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List SLO metrics from a health source
      effect: read
      questions:
      - Which metrics from a health source can I use to define an SLO?
      - What SLO-eligible metrics does a monitored service's health source expose?
      instructions:
      - text: List SLO metrics from health source {healthSource} on monitored service {monitoredService}.
        slots:
          healthSource: path.healthSourceIdentifier
          monitoredService: path.monitoredServiceIdentifier
      - text: Show metrics I can build an SLO on from {healthSource} in {monitoredService}.
        slots:
          healthSource: path.healthSourceIdentifier
          monitoredService: path.monitoredServiceIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/reconciliation-required'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if template-based services need reconciliation
      effect: read
      questions:
      - Do any monitored services need reconciling after I changed their template?
      - Is a yes/no reconciliation check available for services tied to a template version?
      instructions:
      - text: Check whether services using template {template} version {version} need reconciliation.
        slots:
          template: query.templateIdentifier
          version: query.versionLabel
      - text: Tell me if monitored service {monitoredService} must be reconciled with template {template} {version}.
        slots:
          monitoredService: query.monitoredServiceIdentifier
          template: query.templateIdentifier
          version: query.versionLabel
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored services with at-risk filter
      effect: read
      questions:
      - Which monitored services are currently at risk?
      - Can I list monitored services for a single service across environments?
      instructions:
      - text: 'List monitored services at risk only: {atRisk}, {size} per page.'
        slots:
          atRisk: query.servicesAtRiskFilter
          size: query.pageSize
      - text: Show all monitored services for service {service}, page offset {offset}.
        slots:
          service: query.serviceIdentifier
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitored service
      effect: write
      questions:
      - How do I create a monitored service with my own health sources and dependencies?
      - What do I need to supply to register a new monitored service for a service?
      instructions:
      - text: Create monitored service {name} with identifier {identifier} for service {serviceRef}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          serviceRef: requestBody.serviceRef
      - text: Save a new {type} monitored service {identifier} for {serviceRef} in environment {environmentRef}.
        slots:
          type: requestBody.type
          identifier: requestBody.identifier
          serviceRef: requestBody.serviceRef
          environmentRef: requestBody.environmentRef
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/move-config/{identifier}'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a monitored service YAML to Git
      effect: write
      questions:
      - Can I move a monitored service's YAML from inline storage into a remote Git repo?
      - How do I convert an inline monitored service to a remote one?
      instructions:
      - text: Move monitored service {identifier} from inline to remote using move type {moveType}.
        slots:
          identifier: path.identifier
          moveType: query.moveConfigType
      - text: Store the YAML for monitored service {identifier} remotely in Git.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/template-input'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitored service from template inputs
      effect: write
      questions:
      - Can I create a monitored service by filling in a template's inputs?
      - How do I save a new monitored service from a monitored service template?
      instructions:
      - text: Create a monitored service from template inputs in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Save a template-based monitored service in org {org} project {project}.
        slots:
          org: query.orgIdentifier
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/yaml'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a monitored service from YAML
      effect: write
      questions:
      - Can I create a monitored service by posting its YAML definition?
      - Is there a YAML-first way to register a new monitored service?
      instructions:
      - text: Create a monitored service from this YAML in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Import a new monitored service YAML definition into org {org}.
        slots:
          org: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/health-monitoring-flag'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn health monitoring on or off
      effect: write
      questions:
      - How do I pause health monitoring for a monitored service without deleting it?
      - Can I re-enable health monitoring on a service I paused?
      instructions:
      - text: Set health monitoring on monitored service {identifier} to {enable}.
        slots:
          identifier: path.identifier
          enable: query.enable
      - text: Pause health monitoring for monitored service {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/template-input'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a monitored service from template inputs
      effect: write
      questions:
      - Can I update an existing monitored service by re-supplying its template inputs?
      - How do I refresh a template-based monitored service with new input values?
      instructions:
      - text: Update monitored service {identifier} from new template inputs.
        slots:
          identifier: path.identifier
      - text: Reapply template inputs to existing monitored service {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/{identifier}/yaml'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a monitored service from YAML
      effect: write
      questions:
      - Can I overwrite an existing monitored service by sending updated YAML?
      - How do I edit a monitored service's YAML definition in place?
      instructions:
      - text: Update monitored service {identifier} using this YAML.
        slots:
          identifier: path.identifier
      - text: Replace the YAML definition of existing monitored service {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cv/api/monitored-service/yaml-template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a starter YAML for a monitored service
      effect: read
      questions:
      - Where can I get a starter YAML skeleton for a new monitored service?
      - Is there a sample monitored service YAML for a given type?
      instructions:
      - text: Give me the monitored service YAML template for type {type}.
        slots:
          type: query.type
      - text: Generate a blank monitored service YAML for project {project}.
        slots:
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'