Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Release Groups API

9 actions 9 updates phrasing extends openapi/harness-release-groups-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 9

$.info
$.paths['/rmg/api/releaseGroup'].post
$.paths['/rmg/api/releaseGroup/{releaseGroupId}'].get
$.paths['/rmg/api/releaseGroup/{releaseGroupId}'].put
$.paths['/rmg/api/releaseGroup/{releaseGroupId}'].delete
$.paths['/rmg/api/releaseGroup/{releaseGroupId}'].patch
$.paths['/rmg/api/releaseGroup/summary'].get
$.paths['/rmg/api/releaseGroup/{releaseGroupId}/components'].get
$.paths['/rmg/api/releaseGroup/{releaseGroupId}/conflicts'].get

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 Release Groups API
  version: 1.0.0
extends: openapi/harness-release-groups-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: 8
- target: $.paths['/rmg/api/releaseGroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a release group from YAML
      effect: write
      questions:
      - How do I create a new release group?
      - Can a release group be tied to an orchestration process?
      instructions:
      - text: Create a release group from YAML {yaml}.
        slots:
          yaml: requestBody.yaml
      - text: Create a release group from {yaml} using process {processIdentifier}.
        slots:
          yaml: requestBody.yaml
          processIdentifier: requestBody.processIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a release group
      effect: read
      questions:
      - What's in a specific release group?
      - Can I retrieve a release group by its ID?
      instructions:
      - text: Show release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      - text: Get the details of release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a release group's definition
      effect: write
      questions:
      - How do I update a release group with new YAML?
      - Can I change the orchestration process of an existing release group?
      instructions:
      - text: Update release group {releaseGroupId} with YAML {yaml}.
        slots:
          releaseGroupId: path.releaseGroupId
          yaml: requestBody.yaml
      - text: Replace release group {releaseGroupId} definition and set process {processIdentifier}, YAML {yaml}.
        slots:
          releaseGroupId: path.releaseGroupId
          processIdentifier: requestBody.processIdentifier
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a release group
      effect: destructive
      questions:
      - How do I delete a release group?
      - Is deleting a release group reversible?
      instructions:
      - text: Delete release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      - text: Remove release group {releaseGroupId} permanently.
        slots:
          releaseGroupId: path.releaseGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Toggle scheduled auto-execution for a release group
      effect: write
      questions:
      - Can releases run automatically when their scheduled time arrives?
      - How do I turn on auto execute on schedule without recreating releases?
      instructions:
      - text: Set auto execute on schedule to {autoExecuteOnSchedule} for release group {releaseGroupId}.
        slots:
          autoExecuteOnSchedule: requestBody.autoExecuteOnSchedule
          releaseGroupId: path.releaseGroupId
      - text: Enable scheduled auto-execution on release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: List release groups
      effect: read
      questions:
      - What release groups exist in my project?
      - Can I filter release groups by status or by orchestration vs tracking type?
      instructions:
      - text: List release groups in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      - text: List release groups named like {searchTerm} with status {status}.
        slots:
          searchTerm: query.searchTerm
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the components of a release group
      effect: read
      questions:
      - Which components are included in a release group?
      - What component details does a release group carry?
      instructions:
      - text: List the components in release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      - text: Show component details for release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rmg/api/releaseGroup/{releaseGroupId}/conflicts'].get
  update:
    x-apievangelist-phrasing:
      intent: List conflicts in a release group
      effect: read
      questions:
      - Are there any release conflicts in this release group?
      - Can I filter release conflicts by their status?
      instructions:
      - text: List release conflicts for release group {releaseGroupId}.
        slots:
          releaseGroupId: path.releaseGroupId
      - text: Show {conflictStatus} conflicts in release group {releaseGroupId}.
        slots:
          conflictStatus: query.conflictStatus
          releaseGroupId: path.releaseGroupId
      method: generated
      generated: '2026-09-26'