Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Setting API

4 actions 4 updates phrasing extends openapi/harness-setting-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['/ng/api/settings/{identifier}'].get

$.paths['/ng/api/settings'].get

$.paths['/ng/api/settings'].put

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 Setting API
  version: 1.0.0
extends: openapi/harness-setting-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: 3
- target: $.paths['/ng/api/settings/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a setting's value
      effect: read
      questions:
      - What value is a specific Harness setting set to?
      - Can I read one setting's value at project scope?
      instructions:
      - text: Get the value of setting {identifier}.
        slots:
          identifier: path.identifier
      - text: Show setting {identifier} for project {projectIdentifier}.
        slots:
          identifier: path.identifier
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List settings in a category
      effect: read
      questions:
      - Which settings exist under a given category?
      - Can I include inherited values from parent scopes when listing settings?
      instructions:
      - text: List the settings in category {category}.
        slots:
          category: query.category
      - text: Show {category} settings in group {group}, including parent scopes.
        slots:
          category: query.category
          group: query.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update setting values
      effect: write
      questions:
      - How do I change one or more settings at once?
      - Can I update settings for just one project?
      instructions:
      - text: Update these settings in account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Apply the following setting changes to project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-09-26'