Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Organization Roles API

6 actions 6 updates phrasing extends openapi/harness-organization-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 6

$.info
$.paths['/v1/orgs/{org}/roles'].get
$.paths['/v1/orgs/{org}/roles'].post
$.paths['/v1/orgs/{org}/roles/{role}'].get
$.paths['/v1/orgs/{org}/roles/{role}'].put
$.paths['/v1/orgs/{org}/roles/{role}'].delete

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 Organization Roles API
  version: 1.0.0
extends: openapi/harness-organization-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: 5
- target: $.paths['/v1/orgs/{org}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles in an organization
      effect: read
      questions:
      - Which roles are available in my organization?
      - Can I search organization roles by name?
      instructions:
      - text: List roles in org {org}.
        slots:
          org: path.org
      - text: Search roles in org {org} for {term}.
        slots:
          org: path.org
          term: query.search_term
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom organization role
      effect: write
      questions:
      - Can I create a custom role with specific permissions for an organization?
      - What do I need to define a new role at org level?
      instructions:
      - text: Create role {name} with id {id} in org {org}.
        slots:
          name: requestBody.name
          id: requestBody.identifier
          org: path.org
      - text: Create org role {id} named {name} with permissions {permissions}.
        slots:
          id: requestBody.identifier
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/roles/{role}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization role
      effect: read
      questions:
      - What permissions does a particular organization role grant?
      - Can I look up one role in my org by its identifier?
      instructions:
      - text: Get role {role} in org {org}.
        slots:
          role: path.role
          org: path.org
      - text: Show the permissions of org role {role}.
        slots:
          role: path.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/roles/{role}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization role
      effect: write
      questions:
      - Can I change the permissions on an existing org role?
      - Is it possible to rename a role in my organization?
      instructions:
      - text: Update role {role} in org {org} with permissions {permissions}.
        slots:
          role: path.role
          org: path.org
          permissions: requestBody.permissions
      - text: Rename org role {role} to {name}.
        slots:
          role: path.role
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/roles/{role}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom organization role
      effect: destructive
      questions:
      - Can I delete a custom role from my organization?
      - What happens to a custom org role when it's removed?
      instructions:
      - text: Delete role {role} from org {org}.
        slots:
          role: path.role
          org: path.org
      - text: Remove custom role {role}.
        slots:
          role: path.role
      method: generated
      generated: '2026-09-26'