Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Status Checks API

5 actions 5 updates phrasing extends openapi/harness-status-checks-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['/code/api/v1/checks/recent'].get
$.paths['/code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}'].get
$.paths['/code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}'].put
$.paths['/code/api/v1/repos/{repo_identifier}/checks/recent'].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 Status Checks API
  version: 1.0.0
extends: openapi/harness-status-checks-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['/code/api/v1/checks/recent'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent status checks across an account or project
      effect: read
      questions:
      - Which status checks have run recently across all repos in my project?
      - Can I include child spaces when listing recent checks for an org?
      instructions:
      - text: List recent status checks in project {project}.
        slots:
          project: query.projectIdentifier
      - text: Show status checks since {since} across account {account}, recursively ({recursive}).
        slots:
          since: query.since
          account: query.accountIdentifier
          recursive: query.recursive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}'].get
  update:
    x-apievangelist-phrasing:
      intent: List status check results for a commit
      effect: read
      questions:
      - Did all the status checks pass on a specific commit?
      - What check results were reported for a commit SHA in my repo?
      instructions:
      - text: List status check results for commit {sha} in repo {repo}.
        slots:
          sha: path.commit_sha
          repo: path.repo_identifier
      - text: Show checks matching {query} on commit {sha} of {repo}.
        slots:
          query: query.query
          sha: path.commit_sha
          repo: path.repo_identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/checks/commits/{commit_sha}'].put
  update:
    x-apievangelist-phrasing:
      intent: Report a status check result on a commit
      effect: write
      questions:
      - How do I post a CI check result back to a commit?
      - Can I attach a link and summary when reporting a status check?
      instructions:
      - text: Report check {check} as {status} on commit {sha} in repo {repo}.
        slots:
          check: requestBody.identifier
          status: requestBody.status
          sha: path.commit_sha
          repo: path.repo_identifier
      - text: Mark commit {sha} of {repo} with status {status}, summary {summary} and link {link}.
        slots:
          sha: path.commit_sha
          repo: path.repo_identifier
          status: requestBody.status
          summary: requestBody.summary
          link: requestBody.link
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/repos/{repo_identifier}/checks/recent'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent status checks in a repository
      effect: read
      questions:
      - What status checks have run lately in one repository?
      - Which check names has a repo reported since a given time?
      instructions:
      - text: List recent status checks in repo {repo}.
        slots:
          repo: path.repo_identifier
      - text: Show checks in {repo} reported since {since}.
        slots:
          repo: path.repo_identifier
          since: query.since
      method: generated
      generated: '2026-09-26'