Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor Content API

10 actions 10 updates phrasing extends openapi/cvent-exhibitor-content-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 10

$.info
$.paths['/events/{id}/exhibitors/{exhibitorId}/files'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/files/{fileId}'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/files/{fileId}'].put
$.paths['/events/{id}/exhibitors/{exhibitorId}/files/{fileId}'].delete
$.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks'].post
$.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks/{weblinkId}'].get
$.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks/{weblinkId}'].put
$.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks/{weblinkId}'].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 Content API
  version: 1.0.0
extends: openapi/cvent-exhibitor-content-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: 9
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List an exhibitor's files
      effect: read
      questions:
      - What files, like brochures, has an exhibitor attached to their listing?
      - Can I see every document associated with an exhibitor at an event?
      instructions:
      - text: List files for exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show all documents attached to exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/files/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of an exhibitor's files
      effect: read
      questions:
      - What are the display name and order of a specific exhibitor file?
      - How do I fetch a single file record for an exhibitor?
      instructions:
      - text: Get file {fileId} for exhibitor {exhibitorId} at event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show exhibitor {exhibitorId} file {fileId} details in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/files/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach an uploaded file to an exhibitor
      effect: write
      questions:
      - How do I attach a file I already uploaded to an exhibitor's profile?
      - Can I set the display name and order of an exhibitor file, or hide it?
      instructions:
      - text: Attach uploaded file {fileId} to exhibitor {exhibitorId} at event {id} as {displayName}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
          displayName: requestBody.displayName
      - text: Associate file {fileId} with exhibitor {exhibitorId} in event {id} at position {order}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
          order: requestBody.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/files/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a file from an exhibitor
      effect: destructive
      questions:
      - How do I remove a file from an exhibitor's listing?
      - Can I take an outdated brochure off an exhibitor profile?
      instructions:
      - text: Detach file {fileId} from exhibitor {exhibitorId} at event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove exhibitor {exhibitorId}'s file {fileId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks'].get
  update:
    x-apievangelist-phrasing:
      intent: List an exhibitor's weblinks
      effect: read
      questions:
      - What website links does an exhibitor show on their profile?
      - Can I list all content weblinks for an exhibitor?
      instructions:
      - text: List weblinks for exhibitor {exhibitorId} at event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show the URLs attached to exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a weblink to an exhibitor
      effect: write
      questions:
      - How do I add a website link to an exhibitor's booth profile?
      - Can I add a new exhibitor link and control its display order?
      instructions:
      - text: Add weblink {name} pointing to {url} for exhibitor {exhibitorId} at event {id}.
        slots:
          name: requestBody.name
          url: requestBody.url
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Create a link {url} named {name} at position {order} on exhibitor {exhibitorId}, event {id}.
        slots:
          url: requestBody.url
          name: requestBody.name
          order: requestBody.order
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks/{weblinkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of an exhibitor's weblinks
      effect: read
      questions:
      - Where does a specific exhibitor weblink point?
      - How do I fetch one exhibitor link by ID?
      instructions:
      - text: Get weblink {weblinkId} for exhibitor {exhibitorId} at event {id}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show exhibitor {exhibitorId} link {weblinkId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          weblinkId: path.weblinkId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks/{weblinkId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an exhibitor weblink
      effect: write
      questions:
      - How do I change the URL of an existing exhibitor link?
      - Can I hide an exhibitor weblink without deleting it?
      instructions:
      - text: Change weblink {weblinkId} on exhibitor {exhibitorId} at event {id} to {url}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
          url: requestBody.url
      - text: Set hidden to {hidden} on exhibitor {exhibitorId} link {weblinkId} in event {id}.
        slots:
          hidden: requestBody.hidden
          exhibitorId: path.exhibitorId
          weblinkId: path.weblinkId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/exhibitors/{exhibitorId}/weblinks/{weblinkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an exhibitor weblink
      effect: destructive
      questions:
      - How do I permanently delete a link from an exhibitor's profile?
      - Can I delete a broken exhibitor weblink?
      instructions:
      - text: Delete weblink {weblinkId} from exhibitor {exhibitorId} at event {id}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove the link {weblinkId} of exhibitor {exhibitorId} in event {id}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'