Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Invite API

6 actions 6 updates phrasing extends openapi/harness-invite-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['/ng/api/invites/{inviteId}'].put

$.paths['/ng/api/invites/{inviteId}'].delete

$.paths['/ng/api/invites/invite'].get

$.paths['/ng/api/invites'].get

$.paths['/ng/api/invites/aggregate'].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 Invite API
  version: 1.0.0
extends: openapi/harness-invite-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['/ng/api/invites/{inviteId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Resend a user invite email
      effect: write
      questions:
      - A teammate never got their Harness invite; can I resend it?
      - How do I re-send the invitation email for a pending invite?
      instructions:
      - text: Resend invite {inviteId} to {email}.
        slots:
          inviteId: path.inviteId
          email: requestBody.email
      - text: Send the invitation email for invite {inviteId} again.
        slots:
          inviteId: path.inviteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/invites/{inviteId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a pending invite
      effect: destructive
      questions:
      - How do I cancel an invitation I sent by mistake?
      - Can I delete an outstanding invite by its id?
      instructions:
      - text: Delete invite {inviteId}.
        slots:
          inviteId: path.inviteId
      - text: Revoke the pending invitation {inviteId} in account {accountIdentifier}.
        slots:
          inviteId: path.inviteId
          accountIdentifier: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/invites/invite'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an invite by id or token
      effect: read
      questions:
      - Can I look up an invite from the JWT token in the invite link?
      - How do I check the details of a single invite?
      instructions:
      - text: Get invite {inviteId}.
        slots:
          inviteId: query.inviteId
      - text: Look up the invite behind token {jwttoken}.
        slots:
          jwttoken: query.jwttoken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/invites'].get
  update:
    x-apievangelist-phrasing:
      intent: List invites for a project or organization
      effect: read
      questions:
      - Which invitations have been sent for my project?
      - Can I page through all invites in an organization?
      instructions:
      - text: List invites for project {projectIdentifier} in org {orgIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
          orgIdentifier: query.orgIdentifier
      - text: Show all invites sent in org {orgIdentifier}.
        slots:
          orgIdentifier: query.orgIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/invites/aggregate'].post
  update:
    x-apievangelist-phrasing:
      intent: List users with pending invites in a scope
      effect: read
      questions:
      - Who has been invited but hasn't accepted yet?
      - Can I filter pending users by role or resource group?
      instructions:
      - text: List pending users in project {projectIdentifier}.
        slots:
          projectIdentifier: query.projectIdentifier
      - text: Find pending users matching {searchTerm} with roles {roleIdentifiers}.
        slots:
          searchTerm: query.searchTerm
          roleIdentifiers: requestBody.roleIdentifiers
      method: generated
      generated: '2026-09-26'