Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Travel Suppliers API

9 actions 9 updates phrasing extends openapi/cvent-registration-travel-suppliers-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 9

$.info
$.paths['/travel-suppliers/brands'].get
$.paths['/travel-suppliers/brands/{brandId}'].get
$.paths['/travel-suppliers/chains'].get
$.paths['/travel-suppliers/chains/{chainId}'].get
$.paths['/travel-suppliers/properties'].get
$.paths['/travel-suppliers/properties/{propertyId}'].get
$.paths['/travel-suppliers/property-rooms'].get
$.paths['/travel-suppliers/property-rooms/{roomId}'].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 Travel Suppliers API
  version: 1.0.0
extends: openapi/cvent-registration-travel-suppliers-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['/travel-suppliers/brands'].get
  update:
    x-apievangelist-phrasing:
      intent: List hotel supplier brands
      effect: read
      questions:
      - Which hotel brands are available in the travel supplier directory?
      - Can I filter the supplier brand list?
      instructions:
      - text: List travel supplier brands.
      - text: List supplier brands matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/brands/{brandId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supplier brand
      effect: read
      questions:
      - What details are stored for one hotel brand code?
      - Can I look up a supplier brand by its code?
      instructions:
      - text: Get supplier brand {brandId}.
        slots:
          brandId: path.brandId
      - text: Look up the hotel brand with code {brandId}.
        slots:
          brandId: path.brandId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/chains'].get
  update:
    x-apievangelist-phrasing:
      intent: List hotel supplier chains
      effect: read
      questions:
      - Which hotel chains are in the travel supplier directory?
      - Can I search supplier chains with a filter?
      instructions:
      - text: List travel supplier chains.
      - text: List supplier chains matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/chains/{chainId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supplier chain
      effect: read
      questions:
      - What information is held for one hotel chain?
      - Can I fetch a supplier chain by its ID?
      instructions:
      - text: Get supplier chain {chainId}.
        slots:
          chainId: path.chainId
      - text: Look up hotel chain {chainId}.
        slots:
          chainId: path.chainId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List supplier properties
      effect: read
      questions:
      - Which hotels and venues are listed as supplier properties?
      - Can I filter supplier properties, for example by chain?
      instructions:
      - text: List supplier properties.
      - text: List supplier properties matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/properties/{propertyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supplier property
      effect: read
      questions:
      - What are the details of one specific hotel property?
      - Can I fetch a supplier property by its ID?
      instructions:
      - text: Get supplier property {propertyId}.
        slots:
          propertyId: path.propertyId
      - text: Show the hotel property record {propertyId}.
        slots:
          propertyId: path.propertyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/property-rooms'].get
  update:
    x-apievangelist-phrasing:
      intent: List supplier property rooms
      effect: read
      questions:
      - What room types do supplier properties offer?
      - Can I filter supplier property rooms to one hotel?
      instructions:
      - text: List supplier property rooms.
      - text: List property rooms matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/travel-suppliers/property-rooms/{roomId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a supplier property room
      effect: read
      questions:
      - What data is stored for one specific hotel room?
      - Can I read a supplier property room by its room ID?
      instructions:
      - text: Get supplier property room {roomId}.
        slots:
          roomId: path.roomId
      - text: Show the details of hotel room {roomId}.
        slots:
          roomId: path.roomId
      method: generated
      generated: '2026-09-26'