# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Project Roles API
  version: 1.0.0
extends: openapi/harness-project-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}/projects/{project}/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List the roles in a project
      effect: read
      questions:
      - What roles are available in a Harness project?
      - Can I search a project's roles by name?
      instructions:
      - text: List roles in project {project} of org {org}.
        slots:
          project: path.project
          org: path.org
      - text: Find roles matching {search} in {org}/{project}.
        slots:
          search: query.search_term
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom role in a project
      effect: write
      questions:
      - How do I create a custom role with specific permissions in a project?
      - Can I tag and describe a project role when I create it?
      instructions:
      - text: Create role {name} ({identifier}) in {org}/{project} with permissions {permissions}.
        slots:
          name: requestBody.name
          identifier: requestBody.identifier
          org: path.org
          project: path.project
          permissions: requestBody.permissions
      - text: Add a custom project role {identifier} named {name} to org {org}, project {project}.
        slots:
          identifier: requestBody.identifier
          name: requestBody.name
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/roles/{role}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project role
      effect: read
      questions:
      - Which permissions does a given project role include?
      - Can I look up one role in a project by its identifier?
      instructions:
      - text: Get role {role} in project {project} of org {org}.
        slots:
          role: path.role
          project: path.project
          org: path.org
      - text: Show the permissions of project role {role} in {org}/{project}.
        slots:
          role: path.role
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/roles/{role}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a project role
      effect: write
      questions:
      - Can I add permissions to an existing project role?
      - Is renaming a custom role in a project supported?
      instructions:
      - text: Update role {role} in {org}/{project} to permissions {permissions}.
        slots:
          role: path.role
          org: path.org
          project: path.project
          permissions: requestBody.permissions
      - text: Rename project role {role} ({identifier}) in org {org}, project {project} to {name}.
        slots:
          role: path.role
          identifier: requestBody.identifier
          org: path.org
          project: path.project
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/orgs/{org}/projects/{project}/roles/{role}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom project role
      effect: destructive
      questions:
      - Can I delete a custom role from a project?
      - What happens to users when a project role is removed?
      instructions:
      - text: Delete role {role} from project {project} in org {org}.
        slots:
          role: path.role
          project: path.project
          org: path.org
      - text: Remove the custom project role {role} in {org}/{project}.
        slots:
          role: path.role
          org: path.org
          project: path.project
      method: generated
      generated: '2026-09-26'