Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Setting API

4 actions 4 updates phrasing extends openapi/harness-account-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/account-setting'].get

$.paths['/ng/api/account-setting'].put

$.paths['/ng/api/account-setting/list'].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 Account Setting API
  version: 1.0.0
extends: openapi/harness-account-setting-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['/ng/api/account-setting'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one type of account setting
      effect: read
      questions:
      - What is our account configured to for a particular setting type?
      - Can I read a single account setting type at project scope?
      instructions:
      - text: Get the {type} account setting for account {accountIdentifier}.
        slots:
          type: query.type
          accountIdentifier: query.accountIdentifier
      - text: Show account setting type {type} for project {projectIdentifier}.
        slots:
          type: query.type
          projectIdentifier: query.projectIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ng/api/account-setting'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account setting
      effect: write
      questions:
      - How do I change an account-level configuration setting?
      - What config do I send to update an account setting type?
      instructions:
      - text: Update the {type} account setting to config {config}.
        slots:
          type: requestBody.type
          config: requestBody.config
      - text: Save new {type} settings for account {accountIdentifier}.
        slots:
          type: requestBody.type
          accountIdentifier: query.accountIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/ng/api/account-setting/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List all account settings
      effect: read
      questions:
      - What account settings are configured overall?
      - Can I list all account settings without picking a type?
      instructions:
      - text: List every account setting for account {accountIdentifier}.
        slots:
          accountIdentifier: query.accountIdentifier
      - text: Show all settings configured in org {orgIdentifier}.
        slots:
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-10-01'