Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Config API

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

$.info
$.paths['/gateway/ssca-manager/v1/org/{org}/ssca-config/{config-id}'].get
$.paths['/gatway/ssca-manager/v1/ssca-config/{config-id}'].get
$.paths['/v1/org/{org}/project/{project}/ssca-config'].get
$.paths['/v1/org/{org}/project/{project}/ssca-config'].post
$.paths['/v1/org/{org}/project/{project}/ssca-config/{name}/type/{type}'].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 Config API
  version: 1.0.0
extends: openapi/harness-config-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['/gateway/ssca-manager/v1/org/{org}/ssca-config/{config-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supply chain config at org level
      effect: read
      questions:
      - What supply chain security config is set for an organization?
      - Can I fetch an SCS config by id within one org?
      instructions:
      - text: Get SCS config {config} for organization {org}.
        slots:
          config: path.config-id
          org: path.org
      - text: Show org {org}'s supply chain config {config}.
        slots:
          org: path.org
          config: path.config-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/gatway/ssca-manager/v1/ssca-config/{config-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supply chain config at account level
      effect: read
      questions:
      - What supply chain security config applies account-wide?
      - Can I fetch an SCS config by id without an org or project?
      instructions:
      - text: Get account-level SCS config {config}.
        slots:
          config: path.config-id
      - text: Show the account's supply chain config {config}.
        slots:
          config: path.config-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/ssca-config'].get
  update:
    x-apievangelist-phrasing:
      intent: List supply chain configs in a project
      effect: read
      questions:
      - Which supply chain security configs exist in a project?
      - Can I page and sort SCS configs for a project?
      instructions:
      - text: List SCS configs in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Show the first {limit} supply chain configs in {org}/{project}.
        slots:
          limit: query.limit
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/ssca-config'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a supply chain config in a project
      effect: write
      questions:
      - How do I save a supply chain security config for a project?
      - Can I store an SCS config with a name and type?
      instructions:
      - text: Save SCS config {name} of type {type} in {org}/{project}.
        slots:
          name: requestBody.name
          type: requestBody.type
          org: path.org
          project: path.project
      - text: Store supply chain config {config} for project {project} in org {org}.
        slots:
          config: requestBody.config_id
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/org/{org}/project/{project}/ssca-config/{name}/type/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a supply chain config by name and type
      effect: read
      questions:
      - Can I find an SCS config by its name and type rather than its id?
      - Which project config has a particular name and type?
      instructions:
      - text: Get SCS config named {name} of type {type} in {org}/{project}.
        slots:
          name: path.name
          type: path.type
          org: path.org
          project: path.project
      - text: Find the {type} supply chain config called {name} in project {project}, org {org}.
        slots:
          type: path.type
          name: path.name
          project: path.project
          org: path.org
      method: generated
      generated: '2026-09-26'