Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Checks API

8 actions 8 updates phrasing extends openapi/harness-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 8

$.info

$.paths['/v1/checks'].get

$.paths['/v1/checks'].post

$.paths['/v1/checks/{check-id}'].get

$.paths['/v1/checks/{check-id}'].put

$.paths['/v1/checks/{check-id}'].delete

$.paths['/v1/checks/{check-id}/stats'].get

$.paths['/v1/checks/{check-id}/graph'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Checks API
  version: 1.0.0
extends: openapi/harness-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: 7
- target: $.paths['/v1/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List scorecard checks
      effect: read
      questions:
      - Which scorecard checks are available in my developer portal?
      - Can I list only my custom checks and search them by name?
      instructions:
      - text: List all scorecard checks.
      - text: 'Search checks for {term}, custom only: {custom}.'
        slots:
          term: query.search_term
          custom: query.custom
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom scorecard check
      effect: write
      questions:
      - How do I add my own custom check to scorecards?
      - Can I define a new check rule for catalog entities?
      instructions:
      - text: Create a custom check with details {details}.
        slots:
          details: requestBody.check_details
      - text: Add a new custom scorecard check defined as {details}.
        slots:
          details: requestBody.check_details
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{check-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scorecard check
      effect: read
      questions:
      - What rule does a particular scorecard check evaluate?
      - Can I see the definition of a single check by its ID?
      instructions:
      - text: Show check {check}.
        slots:
          check: path.check-id
      - text: Get the definition of custom check {check}.
        slots:
          check: path.check-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{check-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a scorecard check
      effect: write
      questions:
      - Can I change the rule on an existing custom check?
      - How do I edit a check's description or expression?
      instructions:
      - text: Update check {check} with details {details}.
        slots:
          check: path.check-id
          details: requestBody.check_details
      - text: Edit the existing check {check}.
        slots:
          check: path.check-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{check-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scorecard check
      effect: destructive
      questions:
      - How do I remove a custom check I no longer want?
      - Can I force delete a check even if scorecards use it?
      instructions:
      - text: Delete check {check}.
        slots:
          check: path.check-id
      - text: 'Force delete check {check}: {force}.'
        slots:
          check: path.check-id
          force: query.force_delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{check-id}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pass/fail stats for a check
      effect: read
      questions:
      - How many catalog entities pass or fail a given check?
      - What are the statistics for one scorecard check?
      instructions:
      - text: Show stats for check {check}.
        slots:
          check: path.check-id
      - text: Get pass and fail counts for custom check {check}.
        slots:
          check: path.check-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checks/{check-id}/graph'].get
  update:
    x-apievangelist-phrasing:
      intent: Get trend graph data for a check
      effect: read
      questions:
      - How has a check's pass rate trended over time?
      - Can I get graph data to chart one check's results?
      instructions:
      - text: Get graph data for check {check}.
        slots:
          check: path.check-id
      - text: Chart the trend of check {check} over time.
        slots:
          check: path.check-id
      method: generated
      generated: '2026-09-26'