Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness User Setting API

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

$.info
$.paths['/ng/api/user-settings/{identifier}'].get
$.paths['/ng/api/user-settings'].get
$.paths['/ng/api/user-settings'].put
$.paths['/ng/api/user-settings/get-user-preferences'].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 User Setting API
  version: 1.0.0
extends: openapi/harness-usersetting-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: 4
- target: $.paths['/ng/api/user-settings/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user setting's value
      effect: read
      questions:
      - What is my current value for a specific user setting?
      - Can I read a single user setting by its identifier?
      instructions:
      - text: Get the value of user setting {identifier}.
        slots:
          identifier: path.identifier
      - text: Show my setting {identifier}.
        slots:
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/user-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List user settings in a category
      effect: read
      questions:
      - Which user settings exist under a given category?
      - What are all my personal settings in a group?
      instructions:
      - text: List my user settings in category {group}.
        slots:
          group: query.group
      - text: Show all user settings for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/user-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my user settings
      effect: write
      questions:
      - How do I change one of my Harness user settings?
      - Can I update several personal settings in one request?
      instructions:
      - text: Update my user settings in account {account}.
        slots:
          account: query.accountIdentifier
      - text: Save changes to my personal settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/user-settings/get-user-preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List my user preferences
      effect: read
      questions:
      - What user preferences are saved for me?
      - Can I see all my preferences rather than settings by category?
      instructions:
      - text: List my user preferences in account {account}.
        slots:
          account: query.accountIdentifier
      - text: Show my saved preferences.
      method: generated
      generated: '2026-09-26'