Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Rollback API

5 actions 5 updates phrasing extends openapi/harness-rollback-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/ng/api/rollback/check'].post
$.paths['/ng/api/rollback/trigger'].post
$.paths['/ng/api/rollback/trigger/v2'].post
$.paths['/ng/api/rollback/trigger/v3'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Rollback API
  version: 1.0.0
extends: openapi/harness-rollback-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: 4
- target: $.paths['/ng/api/rollback/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a service instance can be rolled back
      effect: read
      questions:
      - Before I roll back, can Harness tell me if this service instance is eligible?
      - How do I verify rollback eligibility for a deployed instance?
      instructions:
      - text: Check if instance {instanceKey} on infrastructure mapping {infrastructureMappingId} can be rolled back.
        slots:
          instanceKey: requestBody.instanceKey
          infrastructureMappingId: requestBody.infrastructureMappingId
      - text: Verify rollback eligibility for instance {instanceKey}.
        slots:
          instanceKey: requestBody.instanceKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/rollback/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back a service instance
      effect: write
      questions:
      - How do I trigger a rollback for a specific deployed instance?
      - Can I roll back using an instance key and infrastructure mapping?
      instructions:
      - text: Roll back instance {instanceKey} on infrastructure mapping {infrastructureMappingId}.
        slots:
          instanceKey: requestBody.instanceKey
          infrastructureMappingId: requestBody.infrastructureMappingId
      - text: Trigger the instance-level rollback for {instanceKey}.
        slots:
          instanceKey: requestBody.instanceKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/rollback/trigger/v2'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back a service in an environment
      effect: write
      questions:
      - Can I roll back a service in a given environment without knowing the instance key?
      - How do I roll back a service to a specific artifact or chart version?
      instructions:
      - text: Roll back service {serviceIdentifier} in environment {envIdentifier}.
        slots:
          serviceIdentifier: requestBody.serviceIdentifier
          envIdentifier: requestBody.envIdentifier
      - text: Roll back service {serviceIdentifier} in {envIdentifier} on infrastructure {infraIdentifier} to chart {chartVersion}.
        slots:
          serviceIdentifier: requestBody.serviceIdentifier
          envIdentifier: requestBody.envIdentifier
          infraIdentifier: requestBody.infraIdentifier
          chartVersion: requestBody.chartVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/rollback/trigger/v3'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back several service targets at once
      effect: write
      questions:
      - Can I trigger rollbacks for multiple services and environments in one request?
      - If one target fails in a bulk rollback, do the others still go through?
      instructions:
      - text: 'Roll back all of these targets at once: {targets}.'
        slots:
          targets: requestBody.targets
      - text: Trigger a bulk rollback for targets {targets} and report failures per target.
        slots:
          targets: requestBody.targets
      method: generated
      generated: '2026-09-26'