Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Badge Print Job API

4 actions 4 updates phrasing extends openapi/cvent-badge-print-job-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 4

$.info
$.paths['/events/{eventId}/badge-print-jobs'].get
$.paths['/events/{eventId}/badge-print-jobs'].post
$.paths['/events/{eventId}/badge-print-jobs/{jobId}'].get

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 Cvent REST Badge Print Job API
  version: 1.0.0
extends: openapi/cvent-badge-print-job-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: 3
- target: $.paths['/events/{eventId}/badge-print-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List badge print jobs for an event
      effect: read
      questions:
      - Which badges have been sent to print at my event?
      - Can I filter badge print jobs by status?
      instructions:
      - text: List badge print jobs for event {eventId}.
        slots:
          eventId: path.eventId
      - text: Show print jobs in event {eventId} matching {filter}.
        slots:
          eventId: path.eventId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}/badge-print-jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a badge to print
      effect: write
      questions:
      - How do I print an attendee's badge on a printer pool?
      - What do I need to create a badge print job?
      instructions:
      - text: Print badge {badgeId} on printer pool {pool} for event {eventId}.
        slots:
          badgeId: requestBody.badgeId
          pool: requestBody.pool
          eventId: path.eventId
      - text: Queue a badge print job for badge {badgeId} at event {eventId}.
        slots:
          badgeId: requestBody.badgeId
          eventId: path.eventId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{eventId}/badge-print-jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a badge print job
      effect: read
      questions:
      - Did a specific badge finish printing?
      - What's the status of one badge print job?
      instructions:
      - text: Get badge print job {jobId} for event {eventId}.
        slots:
          jobId: path.jobId
          eventId: path.eventId
      - text: Check the status of print job {jobId} at event {eventId}.
        slots:
          jobId: path.jobId
          eventId: path.eventId
      method: generated
      generated: '2026-09-26'