ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dex Invitations API

3 actions 3 updates phrasing extends openapi/controlup-invitations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/organizations/{orgId}/invitations'].post
$.paths['/organizations/{orgId}/invitations'].patch

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 Dex Invitations API
  version: 1.0.0
extends: openapi/controlup-invitations-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['/organizations/{orgId}/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite users to the organization
      effect: write
      questions:
      - Can I invite several people to ControlUp with specific roles in one request?
      - What roles can I give a user when inviting them?
      instructions:
      - text: Invite users to organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Send new invitations with roles to organization {orgId}.
        slots:
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{orgId}/invitations'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resend an invitation email
      effect: write
      questions:
      - Someone lost their invite email — can I resend it?
      - Can an invitation be sent again to an address already invited?
      instructions:
      - text: Resend the invitation to {email} for organization {orgId}.
        slots:
          email: requestBody.email
          orgId: path.orgId
      - text: Re-send org {orgId}'s pending invite email to {email}.
        slots:
          orgId: path.orgId
          email: requestBody.email
      method: generated
      generated: '2026-09-26'