Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Orders API

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

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/orders'].get

$.paths['/orders/{orderId}'].get

$.paths['/orders/{orderId}/items'].get

$.paths['/orders/{orderId}/items/{orderItemId}'].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 Orders API
  version: 1.0.0
extends: openapi/cvent-registration-orders-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['/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders across the account
      effect: read
      questions:
      - Can I pull every registration order across all events in my account?
      - Are recently updated orders included right away in the account order list?
      - Can deleted orders be included in the account-wide list?
      instructions:
      - text: List all orders in my account.
      - text: 'List account orders modified after {after}, including deleted: {deleted}.'
        slots:
          after: query.after
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order
      effect: read
      questions:
      - How do I look up a single order by its ID?
      - What's the total and status of a specific order?
      instructions:
      - text: Get order {orderId}.
        slots:
          orderId: path.orderId
      - text: Show the details of order {orderId}.
        slots:
          orderId: path.orderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{orderId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the line items in an order
      effect: read
      questions:
      - What items were purchased in a given order?
      - Can I include deleted line items when listing an order's items?
      instructions:
      - text: List items in order {orderId}.
        slots:
          orderId: path.orderId
      - text: 'List order {orderId}''s line items, including deleted: {deleted}.'
        slots:
          orderId: path.orderId
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{orderId}/items/{orderItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one order line item
      effect: read
      questions:
      - How do I fetch a single line item from an order?
      - What amount was charged for one specific order item?
      instructions:
      - text: Get item {orderItemId} of order {orderId}.
        slots:
          orderItemId: path.orderItemId
          orderId: path.orderId
      - text: Show order {orderId} line item {orderItemId}.
        slots:
          orderId: path.orderId
          orderItemId: path.orderItemId
      method: generated
      generated: '2026-09-26'