Cvent Event Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Venue Profiles API

6 actions 6 updates phrasing extends openapi/cvent-event-cloud-venue-profiles-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}/details'].put

$.paths['/venues/{venueId}/details'].patch

$.paths['/venues/{venueId}/details/overview'].get

$.paths['/venues/{venueId}/facility'].put

$.paths['/venues/{venueId}/facility'].patch

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 Profiles API
  version: 1.0.0
extends: openapi/cvent-event-cloud-venue-profiles-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}/details'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a venue's details
      effect: write
      questions:
      - Can I overwrite all the details on a venue profile, like name, address and phone numbers?
      - What fields are required when I fully replace a venue's details?
      instructions:
      - text: Replace the details of venue {venueId} with name {name}, type {type} and address {address}.
        slots:
          venueId: path.venueId
          name: requestBody.name
          type: requestBody.type
          address: requestBody.address
      - text: Fully update venue {venueId}'s details, setting main phone {mainPhoneNumber} and fax {mainFaxNumber}.
        slots:
          venueId: path.venueId
          mainPhoneNumber: requestBody.mainPhoneNumber
          mainFaxNumber: requestBody.mainFaxNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/details'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a few of a venue's details
      effect: write
      questions:
      - Can I change just the website or cancellation policy on a venue without resending everything?
      - Which fields stay untouched when I partially update venue details?
      instructions:
      - text: Change only the website of venue {venueId} to {websiteAddress}.
        slots:
          venueId: path.venueId
          websiteAddress: requestBody.websiteAddress
      - text: Patch venue {venueId}'s cancellation policy to {cancellationPolicy}, leaving other details as they are.
        slots:
          venueId: path.venueId
          cancellationPolicy: requestBody.cancellationPolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/details/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a venue's details overview
      effect: read
      questions:
      - Can I get a quick overview of a venue's profile details?
      - What does a venue's details summary include?
      instructions:
      - text: Get the details overview for venue {venueId}.
        slots:
          venueId: path.venueId
      - text: Show me a summary of venue {venueId}.
        slots:
          venueId: path.venueId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/facility'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a venue's facility information
      effect: write
      questions:
      - Can I overwrite a venue's facility info, like meeting rooms, sleeping rooms and capacity?
      - Do facility fields apply to every venue type?
      instructions:
      - text: Replace facility info for venue {venueId}, named {name}, with {numberOfMeetingRooms} meeting rooms.
        slots:
          venueId: path.venueId
          name: requestBody.name
          numberOfMeetingRooms: requestBody.numberOfMeetingRooms
      - text: Fully update venue {venueId}'s facility with maximum capacity {maximumCapacity}.
        slots:
          venueId: path.venueId
          maximumCapacity: requestBody.maximumCapacity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/facility'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change part of a venue's facility information
      effect: write
      questions:
      - Can I update only the year renovated on a venue facility and keep everything else?
      - Is there a merge-patch way to change a venue's room rates?
      instructions:
      - text: Patch venue {venueId}'s facility to show it was renovated in {yearRenovated}.
        slots:
          venueId: path.venueId
          yearRenovated: requestBody.yearRenovated
      - text: Change only the single rate of venue {venueId} to {singleRate} and double rate to {doubleRate}.
        slots:
          venueId: path.venueId
          singleRate: requestBody.singleRate
          doubleRate: requestBody.doubleRate
      method: generated
      generated: '2026-09-26'