Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor Team API

9 actions 9 updates phrasing extends openapi/cvent-exhibitor-team-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 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-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's profile at my event?
      - Can I page through all admins for one exhibitor?
      instructions:
      - text: List the admins for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the first {limit} admins of exhibitor {exhibitorId} at event {id}.
        slots:
          limit: query.limit
          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 to manage an exhibitor at my event?
      - What details are required to create an exhibitor admin?
      instructions:
      - text: Add {firstName} {lastName} ({email}) as an admin of 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} at 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:
      - How do I look up the name and email of a specific exhibitor admin?
      - Can I get one exhibitor admin's details by their ID?
      instructions:
      - text: Get admin {adminId} of exhibitor {exhibitorId} in event {id}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show contact details for 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 the email of admin {adminId} for exhibitor {exhibitorId} in event {id} to {email}.
        slots:
          adminId: path.adminId
          exhibitorId: path.exhibitorId
          id: path.id
          email: requestBody.email
      - text: Update exhibitor admin {adminId}'s name to {firstName} {lastName} (exhibitor {exhibitorId}, event {id}).
        slots:
          adminId: path.adminId
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          exhibitorId: path.exhibitorId
          id: path.id
      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 working the booth for a particular exhibitor?
      - Can I list all booth staff members for an exhibitor at my event?
      instructions:
      - text: List booth staff for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show who is staffing exhibitor {exhibitorId}'s booth 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: Make an attendee booth staff for an exhibitor
      effect: write
      questions:
      - How do I assign a registered attendee to staff an exhibitor's booth?
      - Does someone need to be registered before becoming booth staff?
      instructions:
      - text: Make attendee {attendee} booth staff for exhibitor {exhibitorId} in event {id}.
        slots:
          attendee: requestBody.attendee
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Assign registered attendee {attendee} to exhibitor {exhibitorId}'s booth at event {id}.
        slots:
          attendee: requestBody.attendee
          exhibitorId: path.exhibitorId
          id: 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 by 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 remove one booth staff member without affecting their registration?
      instructions:
      - text: Remove booth staff member {boothstaffId} from exhibitor {exhibitorId} in event {id}.
        slots:
          boothstaffId: path.boothstaffId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Disassociate 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'