Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor Team API

9 actions 9 updates phrasing extends openapi/cvent-registration-exhibitor-team-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 9

$.info
$.paths['/events/{id}/exhibitors/{exhibitorId}/admins'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/admins'].post
$.paths['/events/{id}/exhibitors/{exhibitorId}/admins/{adminId}'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/admins/{adminId}'].put
$.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff'].post
$.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff/{boothstaffId}'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff/{boothstaffId}'].delete

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 Exhibitor Team API
  version: 1.0.0
extends: openapi/cvent-registration-exhibitor-team-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: 8
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/admins'].get
  update:
    x-apievangelist-phrasing:
      intent: List an exhibitor's admins
      effect: read
      questions:
      - Who are the admins managing an exhibitor at my event?
      - Can I list every admin for one exhibitor?
      instructions:
      - text: List the admins for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show who administers exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/admins'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an admin to an exhibitor
      effect: write
      questions:
      - How do I give someone admin access for an exhibitor?
      - What details do I need to create an exhibitor admin?
      instructions:
      - text: Add {firstName} {lastName} ({email}) as an admin for exhibitor {exhibitorId} in event {id}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Create an exhibitor admin with email {email} for exhibitor {exhibitorId}, event {id}.
        slots:
          email: requestBody.email
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/admins/{adminId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an exhibitor admin
      effect: read
      questions:
      - What is the contact email of a specific exhibitor admin?
      - Can I look up one exhibitor admin's details?
      instructions:
      - text: Get admin {adminId} of exhibitor {exhibitorId} in event {id}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the name and email of exhibitor admin {adminId} (exhibitor {exhibitorId}, event {id}).
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/admins/{adminId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exhibitor admin
      effect: write
      questions:
      - How do I change an exhibitor admin's email address?
      - Can I correct the name on an existing exhibitor admin?
      instructions:
      - text: Change exhibitor admin {adminId}'s email to {email} for exhibitor {exhibitorId} in event {id}.
        slots:
          adminId: path.adminId
          email: requestBody.email
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Update admin {adminId} of exhibitor {exhibitorId}, event {id}, to name {firstName} {lastName}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          id: path.id
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff'].get
  update:
    x-apievangelist-phrasing:
      intent: List an exhibitor's booth staff
      effect: read
      questions:
      - Who is staffing an exhibitor's booth at my event?
      - Can I see all booth staff members for one exhibitor?
      instructions:
      - text: List booth staff for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show who works the booth for exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an attendee as booth staff
      effect: write
      questions:
      - How do I make a registered attendee part of an exhibitor's booth staff?
      - Does a booth staff member have to be a registered attendee?
      instructions:
      - text: Make attendee {attendee} booth staff for exhibitor {exhibitorId} in event {id}.
        slots:
          attendee: requestBody.attendee
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Add attendee {attendee} to the booth team of exhibitor {exhibitor} at event {event}.
        slots:
          attendee: requestBody.attendee
          exhibitor: requestBody.exhibitor
          event: requestBody.event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff/{boothstaffId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a booth staff member
      effect: read
      questions:
      - Which attendee is behind a given booth staff record?
      - Can I look up one booth staff member's attendee ID?
      instructions:
      - text: Get booth staff member {boothstaffId} for exhibitor {exhibitorId} in event {id}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Find the attendee ID for booth staffer {boothstaffId} (exhibitor {exhibitorId}, event {id}).
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff/{boothstaffId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a booth staff member
      effect: destructive
      questions:
      - How do I take someone off an exhibitor's booth staff?
      - Can I disassociate one booth staff member from an exhibitor?
      instructions:
      - text: Remove booth staff member {boothstaffId} from exhibitor {exhibitorId} in event {id}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Unassign booth staffer {boothstaffId} from exhibitor {exhibitorId} at event {id}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'