Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Account Roles API

7 actions 7 updates phrasing extends openapi/harness-account-roles-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 7

$.info
$.paths['/v1/roles'].get
$.paths['/v1/roles'].post
$.paths['/v1/roles/{role}'].get
$.paths['/v1/roles/{role}'].put
$.paths['/v1/roles/{role}'].delete
$.paths['/v1/roles/count'].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 Account Roles API
  version: 1.0.0
extends: openapi/harness-account-roles-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: 6
- target: $.paths['/v1/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List account-level roles
      effect: read
      questions:
      - What roles are defined at the account level in Harness?
      - Can I search the account's roles by name?
      instructions:
      - text: List all roles in my account.
      - text: Find account roles matching {search_term}.
        slots:
          search_term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom account role
      effect: write
      questions:
      - How do I create a custom role with only certain permissions for my whole account?
      - Can a new account role carry tags and a description?
      instructions:
      - text: Create an account role {name} with identifier {identifier}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
      - text: Add custom role {identifier} named {name} with permissions {permissions}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/roles/{role}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account role
      effect: read
      questions:
      - Which permissions does a particular account role grant?
      - Can I look up one role by its identifier?
      instructions:
      - text: Show account role {role}.
        slots:
          role: path.role
      - text: List the permissions in role {role}.
        slots:
          role: path.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/roles/{role}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account role
      effect: write
      questions:
      - Can I add permissions to an existing account role?
      - How do I rename a custom role?
      instructions:
      - text: Update role {role} to have permissions {permissions}.
        slots:
          role: path.role
          permissions: requestBody.permissions
      - text: Rename account role {role} to {name}.
        slots:
          role: path.role
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/roles/{role}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom account role
      effect: destructive
      questions:
      - Can I delete a custom role I no longer need?
      - What happens to users assigned a role that gets deleted?
      instructions:
      - text: Delete account role {role}.
        slots:
          role: path.role
      - text: Remove the custom role {role} from my account.
        slots:
          role: path.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/roles/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count the roles in an account
      effect: read
      questions:
      - How many roles exist in my Harness account?
      - What's the total number of account roles, without listing them?
      instructions:
      - text: Count the roles in my account.
      - text: Give me the total number of account-level roles.
      method: generated
      generated: '2026-09-26'