# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Redocly Scout Status API
  version: 1.0.0
extends: openapi/redocly-status-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: 1
- target: $.paths['/orgs/{orgId}/projects/{projectId}/scout/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a Scout instance's status and disk usage
      effect: write
      questions:
      - What does a Scout instance send when it reports its status back to Redocly?
      - Can Scout report its hostname, version, disk usage and running jobs?
      instructions:
      - text: Report status for Scout host {hostname} version {version} in project {projectId}, org {orgId}.
        slots:
          hostname: requestBody.hostname
          version: requestBody.version
          projectId: path.projectId
          orgId: path.orgId
      - text: Send a Scout heartbeat for process {pid} on {hostname} with disk {disk} and jobs {jobs} to project {projectId} in org {orgId}, version {version}.
        slots:
          pid: requestBody.pid
          hostname: requestBody.hostname
          disk: requestBody.disk
          jobs: requestBody.jobs
          projectId: path.projectId
          orgId: path.orgId
          version: requestBody.version
      method: generated
      generated: '2026-09-26'