Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Invite API

6 actions 6 updates phrasing extends openapi/acquia-invite-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Acquia's API. It is a proposal applied on top of the contract, not a document Acquia publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/invites/{token}'].get

$.paths['/invites/{token}'].delete

$.paths['/invites/{token}/actions/accept'].post

$.paths['/invites/{token}/actions/decline'].post

$.paths['/invites/{token}/actions/resend'].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 Acquia Cloud API Documentation Invite API
  version: 1.0.0
extends: openapi/acquia-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['/invites/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of an invitation
      effect: read
      questions:
      - Who sent me this invitation and what does it grant?
      - Can I look up an invite from its token?
      instructions:
      - text: Show the invitation with token {token}.
        slots:
          token: path.token
      - text: Get details of invite {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invites/{token}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an invitation
      effect: destructive
      questions:
      - How do I withdraw an invitation I sent by mistake?
      - Can I cancel a pending invite before it's accepted?
      instructions:
      - text: Cancel invitation {token}.
        slots:
          token: path.token
      - text: Withdraw the pending invite {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invites/{token}/actions/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept an invitation
      effect: write
      questions:
      - How do I accept an invitation to join a team or organization?
      - Can I accept an invite using just its token?
      instructions:
      - text: Accept invitation {token}.
        slots:
          token: path.token
      - text: Join using invite token {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invites/{token}/actions/decline'].post
  update:
    x-apievangelist-phrasing:
      intent: Decline an invitation
      effect: write
      questions:
      - Can I turn down an invitation I received?
      - How do I reject an invite I don't want?
      instructions:
      - text: Decline invitation {token}.
        slots:
          token: path.token
      - text: Reject the invite {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/invites/{token}/actions/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend an invitation
      effect: write
      questions:
      - The invitee lost the email; can I send the invite again?
      - How do I resend a pending invitation?
      instructions:
      - text: Resend invitation {token}.
        slots:
          token: path.token
      - text: Send invite {token} to the recipient again.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'