Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Venue Profiles API

6 actions 6 updates phrasing extends openapi/cvent-registration-venue-profiles-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 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-registration-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 profile details
      effect: write
      questions:
      - How do I overwrite all of a venue's profile details at once?
      - Which fields are required when replacing venue details, like phone and address?
      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 rewrite venue {venueId}'s details using main phone {mainPhoneNumber}.
        slots:
          venueId: path.venueId
          mainPhoneNumber: requestBody.mainPhoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/details'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a venue's details
      effect: write
      questions:
      - Can I change just one field of a venue's details without resending everything?
      - What happens to venue detail fields I leave out of a merge patch?
      instructions:
      - text: Patch only the website of venue {venueId} to {websiteAddress}.
        slots:
          venueId: path.venueId
          websiteAddress: requestBody.websiteAddress
      - text: Change just the cancellation policy of venue {venueId} to {cancellationPolicy}.
        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 an overview of a venue's details
      effect: read
      questions:
      - What does a venue's profile currently say?
      - Can I see a summary of a venue's details?
      instructions:
      - text: Get the details overview for venue {venueId}.
        slots:
          venueId: path.venueId
      - text: Show me venue {venueId}'s current profile summary.
        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:
      - How do I overwrite all of a venue's facility info, like meeting rooms and capacity?
      - Does replacing facility info clear fields I don't send?
      instructions:
      - text: Replace facility info for venue {venueId} with {numberOfMeetingRooms} meeting rooms and capacity {maximumCapacity}.
        slots:
          venueId: path.venueId
          numberOfMeetingRooms: requestBody.numberOfMeetingRooms
          maximumCapacity: requestBody.maximumCapacity
      - text: Fully rewrite venue {venueId}'s facility record named {name}.
        slots:
          venueId: path.venueId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/venues/{venueId}/facility'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a venue's facility information
      effect: write
      questions:
      - Can I update only the year renovated for a venue's facility?
      - Is there a way to change one facility field, like tax rate, without a full replace?
      instructions:
      - text: Patch only the renovation year of venue {venueId}'s facility to {yearRenovated}.
        slots:
          venueId: path.venueId
          yearRenovated: requestBody.yearRenovated
      - text: Change just the facility tax rate of venue {venueId} to {taxRate}.
        slots:
          venueId: path.venueId
          taxRate: requestBody.taxRate
      method: generated
      generated: '2026-09-26'