Cvent · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Venue Meeting Rooms API

9 actions 9 updates phrasing extends openapi/cvent-venue-meeting-rooms-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['/venues/{venueId}/meeting-rooms'].post
$.paths['/venues/{venueId}/meeting-rooms/overviews'].get
$.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}'].put
$.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}'].patch
$.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/images'].get
$.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/images'].put
$.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/images/{imageId}'].delete
$.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/overview'].get

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 Venue Meeting Rooms API
  version: 1.0.0
extends: openapi/cvent-venue-meeting-rooms-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['/venues/{venueId}/meeting-rooms'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a meeting room to a venue
      effect: write
      questions:
      - How do I add a new meeting room to a venue profile?
      - What do I need to supply to create a venue meeting room, like dimensions?
      instructions:
      - text: Create meeting room {name} at venue {venueId} with dimensions {dimensions}.
        slots:
          name: requestBody.name
          venueId: path.venueId
          dimensions: requestBody.dimensions
      - text: Add room {name} to venue {venueId} with capacities {capacities}.
        slots:
          name: requestBody.name
          venueId: path.venueId
          capacities: requestBody.capacities
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/overviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List a venue's meeting rooms
      effect: read
      questions:
      - What meeting rooms does a venue have?
      - Can I filter the meeting room overviews for a venue?
      instructions:
      - text: List meeting room overviews for venue {venueId}.
        slots:
          venueId: path.venueId
      - text: Show venue {venueId} meeting rooms matching {filter}.
        slots:
          venueId: path.venueId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a meeting room's details
      effect: write
      questions:
      - How do I overwrite all of a meeting room's data in one go?
      - Can I fully replace a venue meeting room record?
      instructions:
      - text: Replace meeting room {meetingRoomId} at venue {venueId} with name {name} and dimensions {dimensions}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
          name: requestBody.name
          dimensions: requestBody.dimensions
      - text: Fully overwrite venue {venueId} room {meetingRoomId}.
        slots:
          venueId: path.venueId
          meetingRoomId: path.meetingRoomId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a meeting room
      effect: write
      questions:
      - How do I change just one field on a meeting room, leaving the rest alone?
      - Can I hide a meeting room from the venue profile without resending everything?
      instructions:
      - text: Patch only the description of room {meetingRoomId} at venue {venueId} to {description}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
          description: requestBody.description
      - text: Set hiddenOnProfile to {hiddenOnProfile} on venue {venueId} room {meetingRoomId}.
        slots:
          hiddenOnProfile: requestBody.hiddenOnProfile
          venueId: path.venueId
          meetingRoomId: path.meetingRoomId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/images'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting room's image
      effect: read
      questions:
      - Does a meeting room have a photo attached?
      - Which image is shown for a venue meeting room?
      instructions:
      - text: List the image for room {meetingRoomId} at venue {venueId}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
      - text: Show the photo on venue {venueId} meeting room {meetingRoomId}.
        slots:
          venueId: path.venueId
          meetingRoomId: path.meetingRoomId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/images'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a meeting room's image
      effect: write
      questions:
      - How do I attach an uploaded photo to a meeting room?
      - Can I replace a meeting room's current image?
      instructions:
      - text: Attach uploaded file {file} as the image for room {meetingRoomId} at venue {venueId}.
        slots:
          file: requestBody.file
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
      - text: Replace venue {venueId} room {meetingRoomId} photo with {file}.
        slots:
          venueId: path.venueId
          meetingRoomId: path.meetingRoomId
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/images/{imageId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a meeting room's image
      effect: destructive
      questions:
      - How do I take the photo off a meeting room?
      - Can I remove a meeting room image without adding a new one?
      instructions:
      - text: Remove image {imageId} from room {meetingRoomId} at venue {venueId}.
        slots:
          imageId: path.imageId
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
      - text: Detach photo {imageId} from venue {venueId} meeting room {meetingRoomId}.
        slots:
          imageId: path.imageId
          venueId: path.venueId
          meetingRoomId: path.meetingRoomId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a meeting room's overview
      effect: read
      questions:
      - What are the capacity and dimensions of one specific meeting room?
      - How do I get the overview of a single venue room?
      instructions:
      - text: Get the overview of room {meetingRoomId} at venue {venueId}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
      - text: Show venue {venueId} meeting room {meetingRoomId} summary.
        slots:
          venueId: path.venueId
          meetingRoomId: path.meetingRoomId
      method: generated
      generated: '2026-09-26'