Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Transactions API

5 actions 5 updates phrasing extends openapi/cvent-transactions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/transactions'].get

$.paths['/transactions/{transactionId}'].get

$.paths['/transactions/{transactionId}/items'].get

$.paths['/transactions/{transactionId}/items/{transactionItemId}'].get

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 Cvent REST Transactions API
  version: 1.0.0
extends: openapi/cvent-transactions-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: 4
- target: $.paths['/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List registration transactions in the account
      effect: read
      questions:
      - What payment transactions happened in my account this week?
      - Are transactions returned in a stable order I can page through?
      instructions:
      - text: List account transactions modified after {after}.
        slots:
          after: query.after
      - text: Show transactions between {after} and {before}.
        slots:
          after: query.after
          before: query.before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one transaction
      effect: read
      questions:
      - What are the details of a specific payment transaction?
      - Why might a newly created transaction not show up right away?
      instructions:
      - text: Get transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Show the details of payment transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the line items of a transaction
      effect: read
      questions:
      - Which items were charged in a particular transaction?
      - Can I filter the line items of one transaction?
      instructions:
      - text: List the items in transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Show line items of transaction {transactionId} matching {filter}.
        slots:
          transactionId: path.transactionId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/items/{transactionItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one transaction line item
      effect: read
      questions:
      - What was charged on a single line of a transaction?
      - Can I look up one transaction item by its ID?
      instructions:
      - text: Get item {transactionItemId} of transaction {transactionId}.
        slots:
          transactionItemId: path.transactionItemId
          transactionId: path.transactionId
      - text: Show line item {transactionItemId} from transaction {transactionId}.
        slots:
          transactionItemId: path.transactionItemId
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'