Cvent Event Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor Team API

9 actions 9 updates phrasing extends openapi/cvent-event-cloud-exhibitor-team-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Event Cloud's API. It is a proposal applied on top of the contract, not a document Cvent Event Cloud 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

# 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-event-cloud-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 see every admin for one exhibitor in an event?
      instructions:
      - text: List the admins for exhibitor {exhibitorId} in event {event}.
        slots:
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Show exhibitor {exhibitorId}'s admin team at event {event}.
        slots:
          exhibitorId: path.exhibitorId
          event: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/admins'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an exhibitor admin
      effect: write
      questions:
      - Can I give someone admin access to manage an exhibitor's booth?
      - What details do I need to create an exhibitor admin?
      instructions:
      - text: Create admin {firstName} {lastName} ({email}) for exhibitor {exhibitorId} in event {event}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Add {email} as an admin of exhibitor {exhibitorId} at event {event}, named {firstName} {lastName}.
        slots:
          email: requestBody.email
          exhibitorId: path.exhibitorId
          event: path.id
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      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 {event}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Show the name and email of exhibitor admin {adminId} for exhibitor {exhibitorId}, event {event}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          event: 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:
      - Can I change an exhibitor admin's email address?
      - How do I fix the name on an exhibitor admin?
      instructions:
      - text: Change the email of admin {adminId} for exhibitor {exhibitorId} in event {event} to {email}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          event: path.id
          email: requestBody.email
      - text: Update exhibitor admin {adminId} (exhibitor {exhibitorId}, event {event}) to {firstName} {lastName}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          event: 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 get the booth staff roster for one exhibitor?
      instructions:
      - text: List booth staff for exhibitor {exhibitorId} in event {event}.
        slots:
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Show who works the booth of exhibitor {exhibitorId} at event {event}.
        slots:
          exhibitorId: path.exhibitorId
          event: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/booth-staff'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an attendee as booth staff
      effect: write
      questions:
      - Can I make a registered attendee a booth staff member for an exhibitor?
      - Does booth staff have to be a registered attendee first?
      instructions:
      - text: Add attendee {attendee} as booth staff for exhibitor {exhibitorId} in event {event}.
        slots:
          attendee: requestBody.attendee
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Assign registered attendee {attendee} to staff exhibitor {exhibitorId}'s booth at event {event}.
        slots:
          attendee: requestBody.attendee
          exhibitorId: path.exhibitorId
          event: path.id
      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 for an exhibitor?
      instructions:
      - text: Get booth staff member {boothstaffId} for exhibitor {exhibitorId} in event {event}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Find the attendee ID for booth staffer {boothstaffId} of exhibitor {exhibitorId}, event {event}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          event: 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:
      - Can I take someone off an exhibitor's booth staff?
      - Does removing booth staff cancel their event registration?
      instructions:
      - text: Remove booth staff member {boothstaffId} from exhibitor {exhibitorId} in event {event}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          event: path.id
      - text: Disassociate booth staffer {boothstaffId} from exhibitor {exhibitorId} at event {event}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          event: path.id
      method: generated
      generated: '2026-09-26'