Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Compliance Standards API

4 actions 4 updates phrasing extends openapi/harness-compliance-standards-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 4

$.info
$.paths['/v1/orgs/{org}/projects/{project}/compliance-standards'].post
$.paths['/v1/orgs/{org}/projects/{project}/compliance-standards/list'].post
$.paths['/v1/orgs/{org}/projects/{project}/compliance-standards/compliances/{compliance}'].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 Compliance Standards API
  version: 1.0.0
extends: openapi/harness-compliance-standards-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-standards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create compliance standards for a project
      effect: write
      questions:
      - How do I set up compliance standards in a supply chain project?
      - Can compliance standards be created per project?
      instructions:
      - text: Create compliance standards for project {project} in org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Initialize the compliance standards of org {org} project {project}.
        slots:
          org: path.org
          project: path.project
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-standards/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a project's compliance standards
      effect: read
      questions:
      - Which compliance checks apply to my project, and at what severity?
      - Can I filter compliance standards by standard, entity type or severity?
      instructions:
      - text: List compliance standards in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show {severity} severity compliance standards for project {project} in {org}.
        slots:
          severity: requestBody.severity
          project: path.project
          org: path.org
      - text: Find compliance standards under {standards} in project {project}, org {org}.
        slots:
          standards: requestBody.standards
          project: path.project
          org: path.org
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{org}/projects/{project}/compliance-standards/compliances/{compliance}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one compliance standard by id
      effect: read
      questions:
      - What does a specific compliance rule check for?
      - Where can I view the details of a single compliance standard?
      instructions:
      - text: Show compliance standard {compliance} in project {project} of org {org}.
        slots:
          compliance: path.compliance
          project: path.project
          org: path.org
      - text: Get the details of compliance check {compliance} for {org}/{project}.
        slots:
          compliance: path.compliance
          org: path.org
          project: path.project
      method: generated
      generated: '2026-10-01'