Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Principals API

3 actions 3 updates phrasing extends openapi/harness-principals-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 3

$.info
$.paths['/code/api/v1/principals'].get
$.paths['/code/api/v1/principals/scoped'].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 Principals API
  version: 1.0.0
extends: openapi/harness-principals-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: 2
- target: $.paths['/code/api/v1/principals'].get
  update:
    x-apievangelist-phrasing:
      intent: Search users and service principals
      effect: read
      questions:
      - Which users or service accounts in my Harness account match a name?
      - Can I filter principals by type when searching my account?
      instructions:
      - text: Search principals matching {query} in account {account}.
        slots:
          query: query.query
          account: query.accountIdentifier
      - text: List principals of type {type} in account {account}.
        slots:
          type: query.type
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/code/api/v1/principals/scoped'].get
  update:
    x-apievangelist-phrasing:
      intent: List principals scoped to a repo or project
      effect: read
      questions:
      - Who has access within a specific code repository?
      - Can I list principals scoped down to one project or repo instead of the whole account?
      instructions:
      - text: List principals scoped to repo {repo} in account {account}.
        slots:
          repo: query.repoIdentifier
          account: query.accountIdentifier
      - text: Search principals matching {query} scoped to project {project} in account {account}.
        slots:
          query: query.query
          project: query.projectIdentifier
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'