# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Instance API
  version: 1.0.0
extends: openapi/harness-instance-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: 5
- target: $.paths['/api/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List infrastructure instances
      effect: read
      questions:
      - Which instances are running on my infrastructure?
      - Can I list only the instances belonging to one infrastructure?
      instructions:
      - text: List instances in project {project} of org {org}.
        slots:
          project: query.projectIdentifier
          org: query.orgIdentifier
      - text: List instances for infrastructure {infrastructure}, newest first.
        slots:
          infrastructure: query.infrastructureID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/instances/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one infrastructure instance
      effect: read
      questions:
      - What state is a particular instance in?
      - Can I look up a single instance by its ID?
      instructions:
      - text: Get instance {id}.
        slots:
          id: path.id
      - text: Show the details of instance {id} on infrastructure {infrastructure}.
        slots:
          id: path.id
          infrastructure: query.infrastructureID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/instances/{instanceID}/force-state'].post
  update:
    x-apievangelist-phrasing:
      intent: Force an instance into a given state
      effect: write
      questions:
      - Can I manually force an instance into a specific state?
      - How do I override a stuck instance's state?
      instructions:
      - text: Force instance {instance} on infrastructure {infrastructure} into state {state}.
        slots:
          instance: path.instanceID
          infrastructure: requestBody.infrastructureID
          state: requestBody.state
      - text: Reset stuck instance {instance} on infrastructure {infrastructure} to {state}.
        slots:
          instance: path.instanceID
          infrastructure: requestBody.infrastructureID
          state: requestBody.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/instances/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events for an instance
      effect: read
      questions:
      - What events have been recorded for a specific instance?
      - Can I list instance events for one infrastructure revision?
      instructions:
      - text: List events for instance {instance}.
        slots:
          instance: query.instanceID
      - text: List instance events on infrastructure {infrastructure} revision {revision}.
        slots:
          infrastructure: query.infrastructureID
          revision: query.infrastructureRevision
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/instances/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one instance event
      effect: read
      questions:
      - What happened in a specific instance event?
      - Can I retrieve a single instance event by its ID?
      instructions:
      - text: Get instance event {id}.
        slots:
          id: path.id
      - text: Show instance event {id} in project {project}.
        slots:
          id: path.id
          project: query.projectIdentifier
      method: generated
      generated: '2026-09-26'