Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Exhibitor Content API

10 actions 10 updates phrasing extends openapi/cvent-registration-exhibitor-content-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 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-registration-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, are attached to an exhibitor at my event?
      - Can I see all content files for one exhibitor?
      instructions:
      - text: List files for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show exhibitor {exhibitorId}'s uploaded content files for 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 exhibitor file
      effect: read
      questions:
      - Can I fetch the details of just one exhibitor file?
      - What display name and order does a given exhibitor file have?
      instructions:
      - text: Get file {fileId} for exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show exhibitor {exhibitorId} file {fileId} details (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've uploaded to an exhibitor's profile?
      - Can I set the display name and ordering of an exhibitor file?
      instructions:
      - text: Attach file {fileId} to exhibitor {exhibitorId} in event {id} as {displayName}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
          displayName: requestBody.displayName
      - text: Associate file {fileId} with exhibitor {exhibitorId} (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:
      - Is there a way to unlink a file from an exhibitor's content?
      - Can I detach an outdated brochure from an exhibitor?
      instructions:
      - text: Detach file {fileId} from exhibitor {exhibitorId} in event {id}.
        slots:
          fileId: path.fileId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove exhibitor {exhibitorId}'s file {fileId} from 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 web links are shown on an exhibitor's profile?
      - Can I list every content weblink for one exhibitor?
      instructions:
      - text: List weblinks for exhibitor {exhibitorId} in event {id}.
        slots:
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show all links on exhibitor {exhibitorId}'s page for 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 profile?
      - Can I create a hidden weblink for an exhibitor?
      instructions:
      - text: Add weblink {name} pointing to {url} for exhibitor {exhibitorId} in event {id}.
        slots:
          name: requestBody.name
          url: requestBody.url
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Create a new link {url} at position {order} on exhibitor {exhibitorId} (event {id}).
        slots:
          url: requestBody.url
          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 exhibitor weblink
      effect: read
      questions:
      - Can I retrieve just one exhibitor weblink by its ID?
      - What URL and name does a specific exhibitor link have?
      instructions:
      - text: Get weblink {weblinkId} for exhibitor {exhibitorId} in event {id}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Show exhibitor {exhibitorId} link {weblinkId} (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} for exhibitor {exhibitorId} in event {id} to {url}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
          url: requestBody.url
      - text: 'Set existing link {weblinkId} on exhibitor {exhibitorId} (event {id}) hidden: {hidden}.'
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
          hidden: requestBody.hidden
      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 remove a broken exhibitor weblink?
      instructions:
      - text: Delete weblink {weblinkId} from exhibitor {exhibitorId} in event {id}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
      - text: Remove link {weblinkId} on exhibitor {exhibitorId} for event {id}.
        slots:
          weblinkId: path.weblinkId
          exhibitorId: path.exhibitorId
          id: path.id
      method: generated
      generated: '2026-09-26'