Cvent Event Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Venue Meeting Rooms API

6 actions 6 updates phrasing extends openapi/cvent-event-cloud-venue-meeting-rooms-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 6

$.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}/overview'].get

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 Venue Meeting Rooms API
  version: 1.0.0
extends: openapi/cvent-event-cloud-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: 5
- target: $.paths['/venues/{venueId}/meeting-rooms'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a meeting room at a venue
      effect: write
      questions:
      - How do I add a new meeting room to my venue profile?
      - Can I include capacities, rates and amenities when creating a room?
      instructions:
      - text: Create meeting room {name} at venue {venueId} with dimensions {dimensions}.
        slots:
          name: requestBody.name
          venueId: path.venueId
          dimensions: requestBody.dimensions
      - text: Add a new 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 room overviews
      effect: read
      questions:
      - What meeting rooms does my venue have?
      - Can I filter a venue's meeting room list?
      instructions:
      - text: List meeting room overviews for venue {venueId}.
        slots:
          venueId: path.venueId
      - text: Show venue {venueId}'s 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 full details
      effect: write
      questions:
      - Does a full update of a meeting room overwrite fields I leave out?
      - How do I replace all of a meeting room's data at once?
      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: Overwrite all data for room {meetingRoomId} at venue {venueId}, including amenities {amenities}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
          amenities: requestBody.amenities
      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:
      - Can I change just one field on a meeting room and leave the rest alone?
      - How do I unset a meeting room field by sending null?
      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: Hide room {meetingRoomId} at venue {venueId} from the profile by setting hidden to {hiddenOnProfile}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
          hiddenOnProfile: requestBody.hiddenOnProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/meeting-rooms/{meetingRoomId}/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one meeting room's overview
      effect: read
      questions:
      - What's the size and capacity of a specific meeting room?
      - Can I look up one room's overview at a venue?
      instructions:
      - text: Get the overview of meeting room {meetingRoomId} at venue {venueId}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
      - text: Show details for room {meetingRoomId} in venue {venueId}.
        slots:
          meetingRoomId: path.meetingRoomId
          venueId: path.venueId
      method: generated
      generated: '2026-09-26'