Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Principals With Access API

3 actions 3 updates phrasing extends openapi/harness-principals-with-access-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['/v1/listPrincipalsWithAccess'].get

$.paths['/v1/listPrincipalsWithAccess'].post

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 Principals With Access API
  version: 1.0.0
extends: openapi/harness-principals-with-access-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['/v1/listPrincipalsWithAccess'].get
  update:
    x-apievangelist-phrasing:
      intent: List principals with access to a module
      effect: read
      questions:
      - Which users and groups have access to a given Harness module?
      - Can I page through everyone with access to a module type?
      instructions:
      - text: List principals with access to module {moduleType}.
        slots:
          moduleType: query.moduleType
      - text: Show the first {limit} principals who can use module {moduleType}.
        slots:
          limit: query.limit
          moduleType: query.moduleType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listPrincipalsWithAccess'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter principals with access to a module
      effect: read
      questions:
      - Can I apply a filter when listing who has access to a module?
      - How do I narrow the principals with module access using filter criteria?
      instructions:
      - text: List principals with access to module {moduleType} matching filter {filter}.
        slots:
          moduleType: query.moduleType
          filter: requestBody.filter
      - text: Filter module {moduleType} principals by {filter}.
        slots:
          moduleType: query.moduleType
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'